docs(migrate): add resolution steps for cyclic references in ESLint migration#4261
docs(migrate): add resolution steps for cyclic references in ESLint migration#4261Dotify71 wants to merge 4 commits into
Conversation
✅ Deploy Preview for biomejs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
WalkthroughThis PR expands the ESLint→Biome migration guide to replace a brief cyclic-reference warning with a detailed caution describing the failure mode and a concrete isolation workflow: temporarily comment out suspected plugin/shared-config entries in Suggested reviewers
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/content/docs/guides/migrate-eslint-prettier.mdx`:
- Around line 138-153: The snippet uses jsxA11y.flatConfigs.recommended and
defineConfig but neither is imported, causing runtime/syntax errors; import the
missing symbols by adding an import for jsxA11y (e.g., from
'eslint-plugin-jsx-a11y') and an import for defineConfig (e.g., from
'`@eslint/config`' or the appropriate package) at the top of the shown snippet so
jsxA11y and defineConfig are defined before they are referenced in the array
returned by defineConfig.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: cd2557be-f1f0-40f8-be06-da0ca9ad3baf
📒 Files selected for processing (1)
src/content/docs/guides/migrate-eslint-prettier.mdx
ematipico
left a comment
There was a problem hiding this comment.
Thank you! I left some suggestions
|
I've applied all the suggested changes! Note: It looks like the CI code-quality check is currently failing on src/playground/... due to some GritTargetLanguage TypeScript errors, but since I only touched the migration docs, I believe this is unrelated to my PR. |
Fixes #1818
This PR adds a workaround to the ESLint migration guide for cyclic reference errors. It explains how to temporarily comment out problematic plugins or shared configurations (e.g., React, @Stylistic, or @typescript-eslint) in the ESLint configuration file during the migration, and then restore them afterward.