Skip to content

docs: add more tagliatelle examples #4519

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 16, 2024

Conversation

pershin-daniil
Copy link

Copy link

boring-cyborg bot commented Mar 16, 2024

Hey, thank you for opening your first Pull Request !

@CLAassistant
Copy link

CLAassistant commented Mar 16, 2024

CLA assistant check
All committers have signed the CLA.

@ldez
Copy link
Member

ldez commented Mar 16, 2024

Hello,

The goal is not to be exhaustive because you can define all the tag names you want.

The golangci-lint doc doesn't have to be synced with the readme of tagliatelle, it's just an example.

@ldez ldez changed the title update tagliatelle case:rule docs: add more struct tag type examples Mar 16, 2024
@pershin-daniil
Copy link
Author

I've just came up with an issue that there is no info about toml in golangci docs but it is in readme.md. It is confusing.

Is there any place with all tags or with all possible settings?

@ldez
Copy link
Member

ldez commented Mar 16, 2024

Is there any place with all tags or with all possible settings?

It's impossible to do because everybody can create a custom tag name and new "official" tag names can appear.

From the doc:

Any struct tag type can be used.

The only setting with a limited set of values is the case and it's already in the doc:

Support string case: camel, pascal, kebab, snake, upperSnake, goCamel, goPascal, goKebab, goSnake, upper, lower, header

@ldez
Copy link
Member

ldez commented Mar 16, 2024

We can add the toml example but the exhaustivity is impossible, the tagliatelle doc and golangci-lint doc don't need to be synced.

@pershin-daniil pershin-daniil force-pushed the sync-tagliatelle-settings branch from fdece66 to 717d7a5 Compare March 16, 2024 16:24
@ldez ldez added the enhancement New feature or improvement label Mar 16, 2024
@ldez ldez added this to the next milestone Mar 16, 2024
Copy link
Member

@ldez ldez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ldez ldez changed the title docs: add more struct tag type examples docs: add more tagliatelle examples Mar 16, 2024
@ldez ldez merged commit 8f3027c into golangci:master Mar 16, 2024
@pershin-daniil pershin-daniil deleted the sync-tagliatelle-settings branch March 16, 2024 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs enhancement New feature or improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants