feat(cli): add markdown reports, Windows-safe build script, and Next.js rule reliability fixes#88
Open
damian3rd wants to merge 1 commit intomillionco:mainfrom
Conversation
…ilize Next.js rule detection
|
@damian3rd is attempting to deploy a commit to the Million Team on Vercel. A member of the Team first needs to authorize it. |
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.
Summary
This PR adds a new CLI-only output option,
--report-md <path>, to generate a persistent Markdown report after a React Doctor scan.Motivation
React Doctor currently provides rich terminal output and temporary diagnostics files, but there is no first-class, persistent Markdown report for sharing, archiving, or attaching to review workflows.
What Changed
--report-md <path>CLI option.packages/react-doctor/src/utils/write-markdown-report.tspackages/react-doctor/README.md.packages/react-doctor/tests/write-markdown-report.test.tspackages/react-doctor/package.json:rm -rf dist && NODE_ENV=production tsdownnode -e "require('node:fs').rmSync('dist',{recursive:true,force:true})" && tsdownpackages/react-doctor/src/plugin/rules/nextjs.ts:run-oxlintNext.js rule assertionsReport Contents
Generated report includes:
plugin/rulewith file-line referencesExample
npx -y react-doctor@latest . --report-md react-doctor-report.mdBackward Compatibility
--report-mdis not provided.--scorebehavior remains terminal-focused; report generation is optional and explicit.nr teston Windows is now unblocked from failing at therm -rf distbuild step.Validation
Code changes were implemented with tests and documentation updates. Validation in this environment:
nr test:pnpm.cmd --filter react-doctor exec vitest run --pool=threads tests/run-oxlint.test.tspnpm.cmd --filter react-doctor exec vitest run --pool=threads tests/write-markdown-report.test.tspnpm.cmd --filter react-doctor run typecheckpassed.nr lintcompleted successfully (warnings only, no errors).nr format:checkfails due repository-wide existing formatting baseline (170 files), not introduced by this PR.Recommended verification on a standard dev environment:
ni nr test nr lint nr format:check