docs: fix pattern of forbidigo in example config yaml

[ytakaya]

The pattern of forbidigo in .golangci.example.yaml was not the correct pattern so I fixed.
It has been modified with reference to the original usage.

ginkgo\\.F.* in the pattern before modification does not behave as expected.

[boring-cyborg]

Hey, thank you for opening your first Pull Request !

[CLAassistant]

All committers have signed the CLA.

[butuzov]

Can we leave in place simpler patterns (which are the working ones?)

[butuzov]

Maybe it just worth mentioning that pattern should be a valid regular expression?

[ytakaya]

I think that we need to encourage user to use valid regular expression because regexp package is used in forbidigo.
https://github.com/ashanbrown/forbidigo/blob/f30240a5170c8f6a62cf603ea541c0ff2008a6be/forbidigo/forbidigo.go#L70
But simplicity is also important, so using symbols like ^ and $ may be excessive.

I think the biggest problem is that there are patterns in the documentation that don't work.
ginkgo\\.F.* does not match an identifier like ginkgo.FContext() or ginkgo.FDescribe(), so it needs to be fixed to ginkgo\.F.* or "ginkgo\\.F.*".
By using double quotation marks, \ is escaped and becomes the valid regular expression.

Based on the above, here's what I think is a good example.

- fmt\.Errorf
- fmt\.Print.*
- ginkgo\.F.*

[butuzov]

Absolutely agree! How about:

• we list the same package/function with various interpretations
• mention that forbidigo require valid regexp
• will use single quotes for YAML string (so we don't have double quoting \\)

- fmt.Print
- 'fmt\.Print.*'
- '^fmt.Print.*$'

[ldez]

@butuzov I understand the idea, but it can be confusing for users to use 3 variations of the same expression.

I would prefer:

  forbidigo:
    # Forbid the following identifiers
    forbid:
      - ^print.*$
      - 'fmt\.Print.*'

[butuzov]

Can we leave at least one simplified pattern?

[ldez]

There no real simplified pattern: a dot in a regex doesn't mean dot but every character.

ex: fmt.Print matches fmtaPrint(), afmtaPrint(), afmtaPrintExample(), and samfmt.Print()

[butuzov]

... and fmt.Print, and afmtaPrint()... and after it matches last one - user will return to example config and read that value require to be valid regexp (which is missing in your example and initial author's PR ). Note about regexp is important, and can help users in the future.

[butuzov]

Compare it to the exhaustivestruct struct patterns which I was initially sure are regexp (and they are not).

[ldez]

I agree with adding a comment about the regex syntax requirement. 👍

[ytakaya]

I've modified it based on your opinions.
Does this make any difference to your recognition?

[butuzov]

my suggestion deleted, As pointed @ldez it wasn't based on right commit. Here is what I was suggesting (to move test to main linter block above forbid setting).

+ # Forbid the following identifiers (identifiers are written using regexp):
- # Forbid the following identifiers    
  forbid:

[golangci-automator]

Hey, @ytakaya — we just merged your PR to golangci-lint! 🔥🚀

golangci-lint is built by awesome people like you. Let us say “thanks”: we just invited you to join the GolangCI organization on GitHub.
This will add you to our team of maintainers. Accept the invite by visiting this link.

By joining the team, you’ll be able to label issues, review pull requests, and merge approved pull requests.
More information about contributing is here.

Thanks again!

[ashanbrown]

👍