fix(generator): Exclude *_docs.rb from eject by default (but keep --with-docs)#349
Open
djalmaaraujo wants to merge 1 commit intomainfrom
Open
fix(generator): Exclude *_docs.rb from eject by default (but keep --with-docs)#349djalmaaraujo wants to merge 1 commit intomainfrom
djalmaaraujo wants to merge 1 commit intomainfrom
Conversation
…ocs flag Closes RUI-3 Documentation files (*_docs.rb) are only useful for the RubyUI website and should not be ejected into consumer codebases by default. This adds a --with-docs boolean flag (default: false) to the component generator so that docs files are excluded unless explicitly requested. - `rails g ruby_ui:component Link` → ejects only view + stimulus (no docs) - `rails g ruby_ui:component Link --with-docs` → ejects everything including link_docs.rb
djalmaaraujo
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes RUI-3
Documentation files (
*_docs.rb) are only useful for the RubyUI website and should not be ejected into consumer codebases by default.--with-docsboolean flag to the component generator (default:false)*_docs.rbfiles are excluded from eject--with-docsto include them (useful for the web repo)Behavior
rails g ruby_ui:component Link→ ejects only view + stimulus (no docs)rails g ruby_ui:component Link --with-docs→ ejects everything includinglink_docs.rbChanges
lib/generators/ruby_ui/component_generator.rb: addedclass_option :with_docsand updatedcomponents_file_pathsmethodtest/generators/component_generator_test.rb: added test suite covering both default (no docs) and--with-docsbehaviors