Repository navigation
docs: Update README for standalone package - #13
Conversation
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
![doistbot-app[bot]](https://avatars.githubusercontent.com/in/2345791?s=60&v=4){kind=small}
There was a problem hiding this comment.
The README changes effectively document the new standalone package capabilities and integration options. However, the GitHub Actions example requires a specific checkout configuration to work correctly, and the lint-staged example has a potential side effect regarding record maintenance that should be noted.
| ```json | ||
| { | ||
| "lint-staged": { | ||
| "src/**/*.{js,jsx,ts,tsx}": "npx @doist/react-compiler-tracker --check-files" |
There was a problem hiding this comment.
Using --check-files with lint-staged ensures no new violations are introduced, but it does not update the .react-compiler-tracker.json file when violations are fixed. This leads to the tracker file becoming stale (expecting errors that no longer exist). It would be helpful to note this limitation or the potential need for manual updates, contrasting it with the Husky workflow which handles updates automatically.
| - name: Check React Compiler violations | ||
| run: | | ||
| # Get changed files in the PR | ||
| FILES=$(git diff --name-only origin/main...HEAD -- '*.tsx' '*.ts' '*.jsx' '*.js' | tr '\n' ' ') |
There was a problem hiding this comment.
The command git diff ... origin/main...HEAD relies on origin/main being available, but the default actions/checkout configuration performs a shallow fetch and does not include remote branches. To prevent CI failures, consider adding a comment noting that fetch-depth: 0 is required in the actions/checkout step.
There was a problem hiding this comment.
This is just a general example that the user will need to adapt to their needs, so I don't think it needs to consider edge cases.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2 participants
Summary