Open
Conversation
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
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.
Changed
.scribblyrc.json→scribbly.config.jsonin 4 places.Scout-detected fix.
Greptile Overview
Greptile Summary
This PR fixes a documentation discrepancy where the README referenced
.scribblyrc.jsoninstead of the actual config filenamescribbly.config.jsonthat theinitcommand creates (seesrc/config.ts:52).Changes:
scribbly.config.jsonscribbly.config.json).scribblyrc.jsonremains supported as a fallback in config loader for backward compatibility (src/config.ts:24)No issues found. Clean documentation fix.
Confidence Score: 5/5
Important Files Changed
.scribblyrc.jsontoscribbly.config.jsonto match actual config file created by init commandSequence Diagram
sequenceDiagram participant User participant CLI participant README participant ConfigLoader Note over README: Before PR: Referenced .scribblyrc.json Note over README: After PR: References scribbly.config.json User->>CLI: scribbly init CLI->>ConfigLoader: initConfig() ConfigLoader->>ConfigLoader: Write to ./scribbly.config.json ConfigLoader-->>User: Created default config at ./scribbly.config.json Note over README,ConfigLoader: Documentation now matches implementation User->>README: Read configuration docs README-->>User: Instructions reference scribbly.config.json ✓ User->>CLI: scribbly generate CLI->>ConfigLoader: loadConfig() ConfigLoader->>ConfigLoader: Check ./scribbly.config.json (priority 1) ConfigLoader->>ConfigLoader: Check ./.scribblyrc.json (fallback) ConfigLoader-->>CLI: Return config Note over ConfigLoader: Backward compatibility maintained