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

Extend metadata for RSpec cops? #699

Closed
bquorning opened this issue Oct 5, 2018 · 4 comments
Closed

Extend metadata for RSpec cops? #699

bquorning opened this issue Oct 5, 2018 · 4 comments
Assignees

Comments

@bquorning
Copy link
Collaborator

@Darhazer Does RuboCop-RSpec need to add the same kind of metadata that was added to RuboCop in rubocop/rubocop#6293 in order to work properly after RuboCop’s next release?

@Darhazer
Copy link
Member

Darhazer commented Oct 7, 2018

Generally - yes, this way we would be able to use the new options in Rubocop. I'll take care of this

koic added a commit to koic/rubocop-rails that referenced this issue Dec 19, 2018
## Summary

This PR adds some documentation tasks to rake command.

### Before

```console
% bundle exec rake -T
rake build            # Build rubocop-rails-0.5.0.gem into the pkg
directory
rake clean            # Remove any temporary products
rake clobber          # Remove any generated files
rake coverage         # Run RSpec with code coverage
rake install          # Build and install rubocop-rails-0.5.0.gem into
system gems
rake install:local    # Build and install rubocop-rails-0.5.0.gem into
system gems without network access
rake release[remote]  # Create tag v0.5.0 and build and push
rubocop-rails-0.5.0.gem to rubygems.org
rake spec             # Run RSpec code examples
```

### After

```console
% bundle exec rake -T
rake build                            # Build rubocop-rails-0.5.0.gem
into the pkg directory
rake clean                            # Remove any temporary products
rake clobber                          # Remove any generated files
rake coverage                         # Run RSpec with code coverage
rake documentation_syntax_check       # Syntax check for the
documentation comments
rake generate_cops_documentation      # Generate docs of all cops
departments
rake install                          # Build and install
rubocop-rails-0.5.0.gem into system gems
rake install:local                    # Build and install
rubocop-rails-0.5.0.gem into system gems without network access
rake release[remote]                  # Create tag v0.5.0 and build and
push rubocop-rails-0.5.0.gem to rubygems.org
rake spec                             # Run RSpec code examples
rake yard_for_generate_documentation  # Generate YARD Documentation
```

It is based on the following RuboCop RSpec implementation.
https://github.com/rubocop-hq/rubocop-rspec/blob/v1.30.1/tasks/cops_documentation.rake

## Other Information

In the future `Safe` and `SafeAutoCorrect` metadata will be added in another PR.

Related to rubocop/rubocop#6293 and
rubocop/rubocop-rspec#699.
@pirj
Copy link
Member

pirj commented Mar 24, 2020

@Darhazer do you mind sharing your branch? I can take this over if you like.

@pirj
Copy link
Member

pirj commented Mar 24, 2020

Oh, I see it #721

@Darhazer
Copy link
Member

Thank you @pirj for tackling 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

3 participants