Skip to content

Add rule generator #64

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
Feb 15, 2021
Merged

Add rule generator #64

merged 1 commit into from
Feb 15, 2021

Conversation

wata727
Copy link
Member

@wata727 wata727 commented Feb 13, 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. aws_instance_invalid_type): aws_instance_example_type
Created: rules/aws_instance_example_type.go
Created: rules/aws_instance_example_type_test.go
Created: docs/rules/aws_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

@chaspy chaspy self-requested a review February 14, 2021 06:31
Copy link
Contributor

@chaspy chaspy left a comment

Choose a reason for hiding this comment

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

Awesome!

I've run the generator and read the TODO comments. Contributor friendly 👍

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.

2 participants