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

Add rule generator #83

Merged
merged 1 commit into from
Mar 21, 2021
Merged

Add rule generator #83

merged 1 commit into from
Mar 21, 2021

Conversation

wata727
Copy link
Member

@wata727 wata727 commented Mar 21, 2021

Add a rule generator to help new contributors add rules. This is a modified version of the script that previously existed in the core repository. you can use a generator like the following:

$ go run ./rules/generator
Rule name? (e.g. google_compute_instance_invalid_machine_type): google_compute_instance_example_type
Created: rules/google_compute_instance_example_type.go
Created: rules/google_compute_instance_example_type_test.go
Created: docs/rules/google_compute_instance_example_type.md
Modified: rules/provider.go

TODO:
1. Remove all "TODO" comments from generated files.
2. Write implementation of the rule.
3. Add a link to the generated documentation into docs/rules/README.md

See also terraform-linters/tflint-ruleset-aws#64

@wata727 wata727 merged commit 3afbf08 into master Mar 21, 2021
@wata727 wata727 deleted the rule_generator branch March 21, 2021 13:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant