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

New Cop generators #976

Open
dafyddcrosby opened this issue Jul 30, 2024 · 0 comments
Open

New Cop generators #976

dafyddcrosby opened this issue Jul 30, 2024 · 0 comments
Labels
Status: Untriaged An issue that has yet to be triaged. Type: Design Proposal Community survey of a proposal.

Comments

@dafyddcrosby
Copy link
Collaborator

After the Cookstyle hack fest, the amount of boilerplate necessary to create a new Cop became apparent, and this seems like a problem worth solving.

Motivation

As a new Cookstyle dev,
I want to be able to write a "hello world" Cop easily
So that I'm able to get started on basic tasks without needing to read RuboCop docs for N hours

As an experienced Cookstyle dev,
I want to avoid writing boilerplate
So that I can write new Cops quickly

Specification

While I think the case of writing private Cops is worth investigating, to start this should be a Rake task that writes out:

  • a Cop class skeleton
  • a spec file skeleton
  • adds the Cop to the cookstyle.yml file
  • a documentation stub
@dafyddcrosby dafyddcrosby added Status: Untriaged An issue that has yet to be triaged. Type: Design Proposal Community survey of a proposal. labels Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Untriaged An issue that has yet to be triaged. Type: Design Proposal Community survey of a proposal.
Projects
None yet
Development

No branches or pull requests

1 participant