Open
Conversation
Additional Comments (2)
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time! Prompt To Fix With AIThis is a comment left during a code review.
Path: README.md
Line: 102:102
Comment:
inconsistent config filename - should be `scribbly.config.json` to match the rest of the documentation
```suggestion
Create a `scribbly.config.json` file in your project root:
```
<sub>Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!</sub>
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: README.md
Line: 154:154
Comment:
inconsistent config filename - should be `scribbly.config.json` to match the actual config file created by `scribbly init`
```suggestion
scribbly watch --config custom.scribbly.config.json
```
How can I resolve this? If you propose a fix, please make it concise. |
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.
Updates README to reference correct config filename: scribbly.config.json instead of .scribblyrc.json
Greptile Overview
Greptile Summary
Updated README.md to reference the correct config filename
scribbly.config.jsoninstead of.scribblyrc.jsonin 2 locations (lines 47 and 210).Issues found:
.scribblyrc.jsoncustom.scribblyrc.jsonThe code (
src/config.ts:52) confirms thatscribbly initcreatesscribbly.config.jsonas the primary config file, though.scribblyrc.jsonis supported as a fallback for backwards compatibility.Confidence Score: 3/5
Important Files Changed
Sequence Diagram
sequenceDiagram participant User participant README participant CLI as scribbly init participant Config as config.ts User->>README: Reads documentation README-->>User: Instructions reference scribbly.config.json (lines 47, 210) README-->>User: But also references .scribblyrc.json (lines 102, 154) User->>CLI: Runs scribbly init CLI->>Config: initConfig() Config->>Config: Create ./scribbly.config.json Config-->>User: Config file created Note over User,README: Inconsistency: README shows both filenames