Skip to content

Introduce Core Component Generator #252

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 2 commits into from
Oct 28, 2019
Merged

Introduce Core Component Generator #252

merged 2 commits into from
Oct 28, 2019

Conversation

marcoroth
Copy link
Collaborator

Introduce Core Component Generator

This PR introduces the matestack:core:component generator. This generator makes it a lot easier to scaffold new core components and therefore speeds up the development of them.

Example

The generator can be invoked with rails generate matestack:core:component NAME

This will generate the following files:

app/concepts/matestack/ui/core/NAME/NAME.haml
app/concepts/matestack/ui/core/NAME/NAME.rb
spec/usage/components/NAME_spec.rb
docs/components/NAME.md

Changes

  • adds the matestack:core:component generator
  • adds tests for it
  • updates the tooling docs

Notes

This PR follows the same naming scheme for the generator names as #251.

This generator generates a matestack core component in app/concepts/matestack, a test file and a doc file.
@marcoroth marcoroth added this to the 0.7.3 milestone Oct 18, 2019
Copy link
Contributor

@pascalwengerter pascalwengerter left a comment

Choose a reason for hiding this comment

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

Great work, @marcoroth! I am not quite sure yet whether I'm fine with shipping a core component generator with the gem (mostly because users could be confused and there is probably a limited set of core components, after all), but let's see what @jonasjabari thinks about it ;)

@marcoroth
Copy link
Collaborator Author

I agree. This generator only makes sense inside the matestack-ui-core codebase. Maybe we can limit this generator to only work/appear in here.

Copy link
Member

@jonasjabari jonasjabari left a comment

Choose a reason for hiding this comment

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

@marcoroth greate work! just one thing (as @pascalwengerter already considered) please move the documentation to the contribution docs in oder not to confuse normal matestack users :)

@jonasjabari jonasjabari merged commit 48fe1ec into matestack:develop Oct 28, 2019
@marcoroth marcoroth deleted the core_component_generator branch October 28, 2019 12:52
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.

3 participants