Skip to content

Update documentation about avaliable generators in v4 #2324

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 3 commits into from
Apr 28, 2020
Merged

Update documentation about avaliable generators in v4 #2324

merged 3 commits into from
Apr 28, 2020

Conversation

choosen
Copy link
Contributor

@choosen choosen commented Apr 27, 2020

Add missing entries to the list in generator documentation.

Channel generator was introduced with version rspec 4, so patch for previous pages needs to be a little bit changed

Related with #2265

  • double checked

@klyonrad
Copy link
Contributor

Do we care about updating the list in readme.md as well?

Copy link
Member

@pirj pirj left a comment

Choose a reason for hiding this comment

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

Looks good, thanks.
I'm not sure if policy/plugin generator are Rails-related or not and if we generate specs for them, but generator generator is, and we do generate specs along the way.

Do you mind double-checking plugin/policy just to be sure?

@@ -25,8 +25,5 @@ The same generator pattern is available for all specs:
* feature
* job
* channel
* generator
Copy link
Member

Choose a reason for hiding this comment

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

I think that a generator generator is Rails-related, I remember a recent fix for its specs https://github.com/rspec/rspec-rails/pull/2217/files#diff-3fb1bfb25a4bda08b0ad2295bb53297aR3

Copy link
Contributor Author

@choosen choosen Apr 27, 2020

Choose a reason for hiding this comment

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

as I can see here: https://github.com/rspec/rspec-rails/tree/ca988b0697524717e41ce71663869708273b1966/lib/generators/rspec
Generators are aimed only for rails : )

So generate generator can be also included here.

I got a plugin generator by mistake from test unit 🤦

I'm syncing all 15 (14 without install generator) generators with this list

Copy link
Contributor Author

Choose a reason for hiding this comment

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

policy generator came from pundit gem

free to merge @pirj

@choosen
Copy link
Contributor Author

choosen commented Apr 27, 2020

@klyonrad
From readme:

# List all RSpec generators
$ rails generate --help | grep rspec

I think it is not so important for readme to list them all

Remove non-existing observer generator. Add also missing request and generator
Copy link
Member

@pirj pirj left a comment

Choose a reason for hiding this comment

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

Thank you!

@JonRowe JonRowe merged commit 5c3d3d5 into rspec:master Apr 28, 2020
@JonRowe
Copy link
Member

JonRowe commented Apr 28, 2020

Thanks!

@benoittgt
Copy link
Member

Shouldn't we backport it to 4-0-maintenance?

JonRowe pushed a commit that referenced this pull request Apr 29, 2020
Add missing entries to the list in generator.
@JonRowe
Copy link
Member

JonRowe commented Apr 29, 2020

Ah yep, thanks for the reminder 😂 (done)

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

Successfully merging this pull request may close these issues.

5 participants