Skip to content
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

spell-var-name: human readable variable names #2168

Open
cidrblock opened this issue May 23, 2022 · 1 comment
Open

spell-var-name: human readable variable names #2168

cidrblock opened this issue May 23, 2022 · 1 comment
Labels
new rule A request for a new rule
Milestone

Comments

@cidrblock
Copy link
Contributor

cidrblock commented May 23, 2022

Starting to pull in possible rule ideas from the community of practice: redhat-cop/automation-good-practices#64

Ensure variable names are human-readable.

I'm not sure how exactly to do this one without maintaining a dictionary or pulling in a 3rd party dictionary and running a spell check on fact and variable names.

The spell check could also be done on task names as well.

Short of adding anything to ansible-lint, we could also suggest and document the use of cspell in a recommit hook or github action.

Thoughts?

@cidrblock cidrblock added the new rule A request for a new rule label May 23, 2022
@ssbarnea ssbarnea changed the title Rule request: human readable variable names spell-var-name: human readable variable names Jul 19, 2022
@cidrblock
Copy link
Contributor Author

incl compound words: ansible/ansible-navigator#1221

@ssbarnea ssbarnea added this to the 6.9.x milestone Oct 1, 2022
@shatakshiiii shatakshiiii self-assigned this Nov 7, 2022
@shatakshiiii shatakshiiii removed their assignment Dec 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new rule A request for a new rule
Projects
Status: No status
Development

No branches or pull requests

3 participants