README.md

@@ -7,19 +7,21 @@
 `forbidigo` is recommended to be run as part of [golangci-lint](https://github.com/golangci/golangci-lint) where it can be controlled using file-based configuration and `//nolint` directives, but it can also be run as a standalone tool.
 
 ## Installation
-
-    go get -u github.com/ashanbrown/forbidigo
+```
+go get -u github.com/ashanbrown/forbidigo
+```
 
 ## Usage
-
-    forbidigo [flags...] patterns... -- packages...
+```
+forbidigo [flags...] patterns... -- packages...
+```
 
 If no patterns are specified, the default pattern of `^(fmt\.Print.*|print|println)$` is used to eliminate debug statements.  By default,
 functions (and whole files), that are identifies as Godoc examples (https://blog.golang.org/examples) are excluded from 
 checking.
 
 By default, patterns get matched against the actual expression as it appears in
-the source code. The effect is that ``^fmt\.Print.*$` will not match when that
+the source code. The effect is that `^fmt\.Print.*$` will not match when that
 package gets imported with `import fmt2 "fmt"` and then the function gets
 called with `fmt2.Print`.
 
@@ -36,57 +38,62 @@ Replacing the literal source code works for items in a package as in the
 `<package name>.<type name>.<field or method name>` replaces the source code
 text. `<package name>` is what the package declares in its `package` statement,
 which may be different from last part of the import path:
-
-      import "example.com/some/pkg" // pkg uses `package somepkg`
-      s := somepkg.SomeStruct{}
-      s.SomeMethod() // -> somepkg.SomeStruct.SomeMethod
+```go
+import "example.com/some/pkg" // pkg uses `package somepkg`
+s := somepkg.SomeStruct{}
+s.SomeMethod() // -> somepkg.SomeStruct.SomeMethod
+```
 
 Pointers are treated like the type they point to:
-
-      var cf *spew.ConfigState = ...
-      cf.Dump() // -> spew.ConfigState.Dump
+```go
+var cf *spew.ConfigState = ...
+cf.Dump() // -> spew.ConfigState.Dump
+```
 
 When a type is an alias for a type in some other package, the name of that
 other package will be used.
 
 An imported identifier gets replaced as if it had been imported without `import .`
 *and* also gets matched literally, so in this example both `^ginkgo.FIt$`
 and `^FIt$` would catch the usage of `FIt`:
-
-     import . "github.com/onsi/ginkgo/v2"
-     FIt(...) // -> ginkgo.FIt, FIt
+```go
+import . "github.com/onsi/ginkgo/v2"
+FIt(...) // -> ginkgo.FIt, FIt
+```
 
 Beware that looking up the package name has limitations. When a struct embeds
 some other type, references to the inherited fields or methods get resolved
 with the outer struct as type:
+```go
+package foo
 
-     package foo
-
-     type InnerStruct {
-         SomeField int
-     }
+type InnerStruct {
+    SomeField int
+}
 
-     func (i innerStruct) SomeMethod() {}
+func (i innerStruct) SomeMethod() {}
 
-     type OuterStruct {
-         InnerStruct
-     }
+type OuterStruct {
+    InnerStruct
+}
 
-     s := OuterStruct{}
-     s.SomeMethod() // -> foo.OuterStruct.SomeMethod
-     i := s.SomeField // -> foo.OuterStruct.SomeField
+s := OuterStruct{}
+s.SomeMethod() // -> foo.OuterStruct.SomeMethod
+i := s.SomeField // -> foo.OuterStruct.SomeField
+```
 
 When a method gets called via some interface, that invocation also only
 gets resolved to the interface, not the underlying implementation:
+```go
+// innerStruct as above
 
-    // innerStruct as above
+type myInterface interface {
+    SomeMethod()
+}
 
-    type myInterface interface {
-        SomeMethod()
-    }
-
-    var i myInterface = InnerStruct{}
-    i.SomeMethod() // -> foo.myInterface.SomeMethod
+var i myInterface = InnerStruct{}
+i.SomeMethod() // -> foo.myInterface.SomeMethod
+```
 
 Using the package name is simple, but the name is not necessarily unique. For
 more advanced cases, it is possible to specify more complex patterns. Such
@@ -106,26 +113,27 @@ To distinguish such patterns from traditional regular expression patterns, the
 encoding must start with a `{` or contain line breaks. When using just JSON
 encoding, backslashes must get quoted inside strings. When using YAML, this
 isn't necessary. The following pattern strings are equivalent:
+```
+{p: "^fmt\\.Println$", msg: "do not write to stdout"}
 
-    {p: "^fmt\\.Println$", msg: "do not write to stdout"}
-
-    {p: ^fmt\.Println$,
-     msg: do not write to stdout,
-    }
+{p: ^fmt\.Println$,
+    msg: do not write to stdout,
+}
 
-    {p: ^fmt\.Println$, msg: do not write to stdout}
+{p: ^fmt\.Println$, msg: do not write to stdout}
 
-    p: ^fmt\.Println$
-    msg: do not write to stdout
+p: ^fmt\.Println$
+msg: do not write to stdout
+```
 
 A larger set of interesting patterns might include:
 
--* `^fmt\.Print.*$` -- forbid use of Print statements because they are likely just for debugging
--* `^ginkgo\.F[A-Z].*$` -- forbid ginkgo focused commands (used for debug issues)
--* `^spew\.Dump$` -- forbid dumping detailed data to stdout
--* `^spew.ConfigState\.Dump$` -- also forbid it via a `ConfigState`
--* `^spew\.Dump(# please do not spew to stdout)?$` -- forbid spewing, with a custom message
--* `{p: ^spew\.Dump$, msg: please do not spew to stdout}` -- the same with separate msg field
+* `^fmt\.Print.*$` -- forbid use of Print statements because they are likely just for debugging
+* `^ginkgo\.F[A-Z].*$` -- forbid ginkgo focused commands (used for debug issues)
+* `^spew\.Dump$` -- forbid dumping detailed data to stdout
+* `^spew.ConfigState\.Dump$` -- also forbid it via a `ConfigState`
+* `^spew\.Dump(# please do not spew to stdout)?$` -- forbid spewing, with a custom message
+* `{p: ^spew\.Dump$, msg: please do not spew to stdout}` -- the same with separate msg field
 
 ### Flags
 - **-set_exit_status** (default false) - Set exit status to 1 if any issues are found.

go.mod

@@ -1,13 +1,18 @@
 module github.com/ashanbrown/forbidigo
 
-go 1.13
+go 1.18
 
 require (
-	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/google/go-cmp v0.5.6
 	github.com/stretchr/testify v1.5.1
-	golang.org/x/sys v0.5.0 // indirect
-	golang.org/x/tools v0.3.0
-	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
+	golang.org/x/tools v0.13.0
 	gopkg.in/yaml.v2 v2.4.0
 )
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	golang.org/x/mod v0.12.0 // indirect
+	golang.org/x/sys v0.12.0 // indirect
+	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
+)

go.sum

@@ -8,41 +8,13 @@ github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZN
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.5.1 h1:nOGnQDM7FYENwehXlg/kFVnos3rEvtKTjRvOWSzb6H4=
 github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
-github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
-golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
-golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
-golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
-golang.org/x/mod v0.7.0 h1:LapD9S96VoQRhi/GrNTqeBJFrUjs5UHCAtTlgwA5oZA=
-golang.org/x/mod v0.7.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
-golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
-golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
-golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
-golang.org/x/net v0.2.0/go.mod h1:KqCZLdyyvdV855qA2rE3GC2aiw5xGR5TEjj8smXukLY=
-golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
-golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
-golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o=
-golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
-golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
-golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.5.0 h1:MUK/U/4lj1t1oPg0HfuXDN/Z1wv31ZJ/YcPiGccS4DU=
-golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
-golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
-golang.org/x/term v0.2.0/go.mod h1:TVmDHMZPmdnySmBfhjOoOdhjzdE1h4u1VwSiw2l1Nuc=
-golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
-golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
-golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
-golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
-golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
-golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
-golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
-golang.org/x/tools v0.3.0 h1:SrNbZl6ECOS1qFzgTdQfWXZM9XBkiA6tkFrH9YSTPHM=
-golang.org/x/tools v0.3.0/go.mod h1:/rWhSS2+zyEVwoJf8YAX6L2f0ntZ7Kn/mGgAWcipA5k=
-golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+golang.org/x/mod v0.12.0 h1:rmsUpXtvNzj340zd98LZ4KntptpfRHwpFOHG188oHXc=
+golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
+golang.org/x/sync v0.3.0 h1:ftCYgMx6zT/asHUrPw8BLLscYtGznsLAnjq5RH9P66E=
+golang.org/x/sys v0.12.0 h1:CM0HF96J0hcLAwsHPJZjfdNzs0gftsLfgKt57wWHJ0o=
+golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/tools v0.13.0 h1:Iey4qkscZuv0VvIt8E0neZjtPVQFSc870HQ448QgEmQ=
+golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE=
 golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=