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 more rubocop rules. #37

Closed
MiguelSavignano opened this issue May 12, 2018 · 4 comments
Closed

Add more rubocop rules. #37

MiguelSavignano opened this issue May 12, 2018 · 4 comments

Comments

@MiguelSavignano
Copy link
Contributor

MiguelSavignano commented May 12, 2018

Some rules are missing or other it's outdated or the example it's not the same with the rubocop doc info

example:
the example of Lint/AmbiguousOperator if diferent for
http://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Lint/AmbiguousOperator

@MiguelSavignano
Copy link
Contributor Author

I try to generate updated info in this pull request #38.

@rtfpessoa
Copy link
Contributor

@MiguelSavignano Thanks for the heads up.

This project already has some code to generate the docs. If you run https://github.com/codacy/codacy-rubocop#update-version-with-docs it should update the docs for the version selected in patterns.json.

The code that does it is in here: https://github.com/codacy/codacy-rubocop/blob/master/src/main/scala/codacy/rubocop/Generator.scala

Not sure where and how you are getting your docs but we would like to keep this automated.

Ideally we would like to update the current doc generation but since your docs seem more complete, I would be up to accepting a Ruby script to generate the docs with some updates in the README on how to do it.

@MiguelSavignano
Copy link
Contributor Author

The rubocop gem generates the documentation using the gem source code and yard gem.
I use this code for generate rubocop-doc.yml.

This file contain all rubocop rules with examples with all the necessary information to generate codacy docs files. but the hard part is that the rubocop source code is necessary.

The ruby script generator use rucocop-doc.yml for generate makrdown, description.json and patters.json

@rtfpessoa
Copy link
Contributor

This was fixed in the automatic doc generation a long time ago. Forgot to close this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants