mohganji Setup React Doctor
One-time guided setup. Adds react-doctor analysis at both CI and pre-commit hook level. Defaults to setting up both -- confirms with user before proceeding.
Workflow
Step 1 -- Detect project setup
- Confirm the project uses React (check for
reactinpackage.jsondependencies) - If no
package.jsonbut.tsx/.jsxfiles exist, ask user to confirm React usage - Identify component directories (e.g.
src/components/,app/,pages/) - Check for existing ESLint React rules or other React linting
- Check if
.github/workflows/already exists
Present findings to user and ask them to confirm or correct. Use AskUserQuestion to clarify:
- If component directories can't be determined: ask where React components live
- If multiple potential component roots found (e.g. monorepo): ask which to include
Step 2 -- Ask user preferences
Use AskUserQuestion for each:
- Where to enforce -- default is both, confirm with user:
- Both CI and pre-commit hook (recommended)
- CI only -- GitHub Actions workflow
- Pre-commit hook only -- local enforcement
- Scope -- what to analyze:
- Changed files only (recommended for pre-commit) -- fast, focused
- Full project scan (recommended for CI) -- comprehensive
- CI enforcement mode (if CI selected):
- Fail the check (recommended) -- PR cannot merge
- Warn only -- post a comment but don't block
Step 3 -- Generate files
- If CI selected: generate
.github/workflows/react-doctor.yml - If pre-commit hook selected: write hook script to
.git/hooks/pre-commit(or append to existing) and make it executable - Hook should only run react-doctor on staged
.tsx/.jsxfiles
Step 4 -- Verify
- Read back generated files and sanity-check them
- Show the user what was generated for review
- Run react-doctor on a sample component as a smoke test
Key rules
- Skip setup entirely if the project doesn't use React -- inform user and exit
- Never overwrite existing workflow files or hooks without asking
- Idempotent -- running again detects existing setup and skips