feat(docs): add explicit labels for non-recommended rules#3641
feat(docs): add explicit labels for non-recommended rules#3641ematipico merged 3 commits intobiomejs:mainfrom
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
|
WalkthroughThe changes update the lint documentation generator and multiple docs so non-recommended rules are explicitly labelled. In Pre-merge checks and finishing touches✅ Passed checks (4 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
src/content/docs/linter/rules/use-block-statements.mdx (1)
15-15: Consistent labelling applied.
🧹 Nitpick comments (5)
src/content/docs/linter/rules/use-symbol-description.mdx (1)
12-17: Nice clarity win; consider slightly tighter wording for consistency.
Line 15 reads well and meets the goal. If you want it crisper/consistent with other pages, consider: “This rule is not recommended and is disabled by default.” (Less “meaning”, more “stating”.)src/content/docs/linter/rules/use-filenaming-convention.mdx (1)
12-17: Nice clarity win; keep phrasing consistent across rule pages.Line 15 nails the “disabled by default because not recommended” message. Only suggestion: ensure the generator uses the same wording everywhere (e.g., “non‑recommended” vs “not part of the recommended rules”) to avoid a docs patchwork.
src/content/docs/linter/rules/no-magic-numbers.mdx (1)
12-17: Nice clarity bump; wording is correct, but consider a tiny copy polish.Line 15 does exactly what the issue asked for. Optional nit: “This rule is not part of the recommended ruleset; it is disabled by default.” reads a touch cleaner. Also, since this is generated (Lines 2–3), any copy tweak should happen in the generator/source so it stays consistent.
src/content/docs/linter/rules/use-throw-new-error.mdx (1)
12-17: Nice clarity win; consider aligning wording with the site’s canonical “non‑recommended” label.Line 15 reads well, but if the UI/legend says “non‑recommended” (or “not recommended”), consider matching that exact phrasing for consistency. Since this file is auto-generated, any copy tweak belongs in the generator source, not here.
src/content/docs/linter/css/rules.mdx (1)
13-14: Legend entries correctly document the not-recommended status.The new legend lines clearly explain what the information icon represents. The text "disabled by default" aligns well with the PR's intent. Small observation: the Icon component in the legend lacks the
size="1.2rem"attribute used in table rows—might want consistency, though this could be intentional for visual hierarchy.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (107)
codegen/src/lintdoc.rs(5 hunks)src/content/docs/assist/css/actions.mdx(2 hunks)src/content/docs/assist/graphql/actions.mdx(1 hunks)src/content/docs/assist/html/actions.mdx(1 hunks)src/content/docs/assist/javascript/actions.mdx(2 hunks)src/content/docs/assist/json/actions.mdx(2 hunks)src/content/docs/linter/css/rules.mdx(2 hunks)src/content/docs/linter/graphql/rules.mdx(2 hunks)src/content/docs/linter/html/rules.mdx(1 hunks)src/content/docs/linter/javascript/rules.mdx(12 hunks)src/content/docs/linter/json/rules.mdx(1 hunks)src/content/docs/linter/rules/no-alert.mdx(1 hunks)src/content/docs/linter/rules/no-await-in-loops.mdx(1 hunks)src/content/docs/linter/rules/no-barrel-file.mdx(1 hunks)src/content/docs/linter/rules/no-bitwise-operators.mdx(1 hunks)src/content/docs/linter/rules/no-common-js.mdx(1 hunks)src/content/docs/linter/rules/no-console.mdx(1 hunks)src/content/docs/linter/rules/no-constant-binary-expressions.mdx(1 hunks)src/content/docs/linter/rules/no-default-export.mdx(1 hunks)src/content/docs/linter/rules/no-delete.mdx(1 hunks)src/content/docs/linter/rules/no-done-callback.mdx(1 hunks)src/content/docs/linter/rules/no-empty-block-statements.mdx(1 hunks)src/content/docs/linter/rules/no-enum.mdx(1 hunks)src/content/docs/linter/rules/no-evolving-types.mdx(1 hunks)src/content/docs/linter/rules/no-excessive-cognitive-complexity.mdx(1 hunks)src/content/docs/linter/rules/no-excessive-lines-per-function.mdx(1 hunks)src/content/docs/linter/rules/no-exported-imports.mdx(1 hunks)src/content/docs/linter/rules/no-for-each.mdx(1 hunks)src/content/docs/linter/rules/no-global-dirname-filename.mdx(1 hunks)src/content/docs/linter/rules/no-implicit-boolean.mdx(1 hunks)src/content/docs/linter/rules/no-implicit-coercions.mdx(1 hunks)src/content/docs/linter/rules/no-inferrable-types.mdx(1 hunks)src/content/docs/linter/rules/no-magic-numbers.mdx(1 hunks)src/content/docs/linter/rules/no-misplaced-assertion.mdx(1 hunks)src/content/docs/linter/rules/no-namespace-import.mdx(1 hunks)src/content/docs/linter/rules/no-namespace.mdx(1 hunks)src/content/docs/linter/rules/no-negation-else.mdx(1 hunks)src/content/docs/linter/rules/no-nested-ternary.mdx(1 hunks)src/content/docs/linter/rules/no-nodejs-modules.mdx(1 hunks)src/content/docs/linter/rules/no-noninteractive-element-interactions.mdx(1 hunks)src/content/docs/linter/rules/no-parameter-assign.mdx(1 hunks)src/content/docs/linter/rules/no-parameter-properties.mdx(1 hunks)src/content/docs/linter/rules/no-process-env.mdx(1 hunks)src/content/docs/linter/rules/no-process-global.mdx(1 hunks)src/content/docs/linter/rules/no-re-export-all.mdx(1 hunks)src/content/docs/linter/rules/no-restricted-elements.mdx(1 hunks)src/content/docs/linter/rules/no-restricted-globals.mdx(1 hunks)src/content/docs/linter/rules/no-restricted-imports.mdx(1 hunks)src/content/docs/linter/rules/no-restricted-types.mdx(1 hunks)src/content/docs/linter/rules/no-secrets.mdx(1 hunks)src/content/docs/linter/rules/no-shouty-constants.mdx(1 hunks)src/content/docs/linter/rules/no-skipped-tests.mdx(1 hunks)src/content/docs/linter/rules/no-substr.mdx(1 hunks)src/content/docs/linter/rules/no-unassigned-variables.mdx(1 hunks)src/content/docs/linter/rules/no-undeclared-variables.mdx(1 hunks)src/content/docs/linter/rules/no-unused-template-literal.mdx(1 hunks)src/content/docs/linter/rules/no-useless-else.mdx(1 hunks)src/content/docs/linter/rules/no-useless-string-concat.mdx(1 hunks)src/content/docs/linter/rules/no-value-at-rule.mdx(1 hunks)src/content/docs/linter/rules/no-var.mdx(1 hunks)src/content/docs/linter/rules/no-void.mdx(1 hunks)src/content/docs/linter/rules/no-yoda-expression.mdx(1 hunks)src/content/docs/linter/rules/use-as-const-assertion.mdx(1 hunks)src/content/docs/linter/rules/use-at-index.mdx(1 hunks)src/content/docs/linter/rules/use-await.mdx(1 hunks)src/content/docs/linter/rules/use-block-statements.mdx(1 hunks)src/content/docs/linter/rules/use-collapsed-else-if.mdx(1 hunks)src/content/docs/linter/rules/use-collapsed-if.mdx(1 hunks)src/content/docs/linter/rules/use-consistent-array-type.mdx(1 hunks)src/content/docs/linter/rules/use-consistent-builtin-instantiation.mdx(1 hunks)src/content/docs/linter/rules/use-consistent-curly-braces.mdx(1 hunks)src/content/docs/linter/rules/use-consistent-member-accessibility.mdx(1 hunks)src/content/docs/linter/rules/use-consistent-object-definitions.mdx(1 hunks)src/content/docs/linter/rules/use-consistent-type-definitions.mdx(1 hunks)src/content/docs/linter/rules/use-default-parameter-last.mdx(1 hunks)src/content/docs/linter/rules/use-default-switch-clause.mdx(1 hunks)src/content/docs/linter/rules/use-enum-initializers.mdx(1 hunks)src/content/docs/linter/rules/use-error-message.mdx(1 hunks)src/content/docs/linter/rules/use-explicit-length-check.mdx(1 hunks)src/content/docs/linter/rules/use-exports-last.mdx(1 hunks)src/content/docs/linter/rules/use-filenaming-convention.mdx(1 hunks)src/content/docs/linter/rules/use-for-of.mdx(1 hunks)src/content/docs/linter/rules/use-fragment-syntax.mdx(1 hunks)src/content/docs/linter/rules/use-graphql-naming-convention.mdx(1 hunks)src/content/docs/linter/rules/use-grouped-accessor-pairs.mdx(1 hunks)src/content/docs/linter/rules/use-guard-for-in.mdx(1 hunks)src/content/docs/linter/rules/use-naming-convention.mdx(1 hunks)src/content/docs/linter/rules/use-node-assert-strict.mdx(1 hunks)src/content/docs/linter/rules/use-number-namespace.mdx(1 hunks)src/content/docs/linter/rules/use-number-to-fixed-digits-argument.mdx(1 hunks)src/content/docs/linter/rules/use-numeric-separators.mdx(1 hunks)src/content/docs/linter/rules/use-object-spread.mdx(1 hunks)src/content/docs/linter/rules/use-readonly-class-properties.mdx(1 hunks)src/content/docs/linter/rules/use-self-closing-elements.mdx(1 hunks)src/content/docs/linter/rules/use-shorthand-assign.mdx(1 hunks)src/content/docs/linter/rules/use-simplified-logic-expression.mdx(1 hunks)src/content/docs/linter/rules/use-single-js-doc-asterisk.mdx(1 hunks)src/content/docs/linter/rules/use-single-var-declarator.mdx(1 hunks)src/content/docs/linter/rules/use-static-response-methods.mdx(1 hunks)src/content/docs/linter/rules/use-strict-mode.mdx(1 hunks)src/content/docs/linter/rules/use-symbol-description.mdx(1 hunks)src/content/docs/linter/rules/use-throw-new-error.mdx(1 hunks)src/content/docs/linter/rules/use-throw-only-error.mdx(1 hunks)src/content/docs/linter/rules/use-top-level-regex.mdx(1 hunks)src/content/docs/linter/rules/use-trim-start-end.mdx(1 hunks)src/content/docs/linter/rules/use-unified-type-signatures.mdx(1 hunks)src/content/docs/linter/rules/use-while.mdx(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - biomejs
- GitHub Check: Header rules - biomejs
- GitHub Check: Pages changed - biomejs
🔇 Additional comments (101)
src/content/docs/linter/rules/no-shouty-constants.mdx (1)
12-17: Clear “disabled by default” labelling — good placement in the Summary.
The added bullet is explicit and scannable, and it sits nicely alongside “unsafe fix” and default severity.src/content/docs/linter/rules/no-default-export.mdx (1)
12-17: Clear “non‑recommended” callout — aligns with the docs goal.
The added Summary bullet (Line 15) makes the default-disabled status obvious at a glance and reads cleanly alongside the other metadata.src/content/docs/linter/rules/use-number-to-fixed-digits-argument.mdx (1)
12-17: Good explicit “not recommended” labelling (nice).Line 15 does exactly what the issue asks for: it makes the default-disabled/non-recommended status obvious without relying on vibes.
One thing to double-check: Line 16 says safe fix, but the example output at Line 48 prints Unsafe fix—worth aligning via the generator/source metadata so readers don’t get mixed signals.src/content/docs/linter/rules/no-value-at-rule.mdx (1)
15-15: Approved — explicit labelling is clear.The added line effectively communicates that this rule is non-recommended and disabled by default, placing it prominently in the summary section where users will see it immediately.
Since this is auto-generated, ensure the code generator (lintdoc.rs) correctly gates this text to non-nursery, non-domain-scoped rules per the PR objectives.
src/content/docs/linter/rules/use-object-spread.mdx (1)
15-15: Perfect placement for the non-recommended indicator.The addition clearly communicates that this rule is disabled by default and not part of the recommended set. Positioned nicely in the Summary section alongside other rule metadata, making it immediately visible to users reviewing the documentation.
src/content/docs/linter/rules/no-parameter-properties.mdx (1)
15-15: Clear and well-placed documentation update.Adding this note to the Summary section makes it immediately obvious that the rule is non-recommended and disabled by default. Consistent with the PR's objective to provide explicit labelling.
src/content/docs/linter/rules/no-excessive-lines-per-function.mdx (1)
15-15: Excellent clarity.The new explicit label is clear, concise, and directly addresses the PR objective—making it immediately obvious that this rule is non-recommended and disabled by default. The placement in the Summary section is perfect.
src/content/docs/linter/rules/use-naming-convention.mdx (1)
15-15: Clear and well-placed labelling. The note is direct, unambiguous, and sits prominently in the Summary section—exactly where users need to see it. ✓src/content/docs/linter/rules/use-exports-last.mdx (1)
15-15: Excellent—explicit labelling is now clear.The note succinctly clarifies that the rule is non-recommended and disabled by default, placed appropriately in the Summary section alongside other metadata. This directly addresses the PR objective to make non-recommended status obvious at a glance.
Since this file is auto-generated from the Biome repository's code generator, ensure the upstream changes to
lintdoc.rs(mentioned in the PR) are consistently applied across all affected rule documentation files.src/content/docs/linter/rules/use-while.mdx (1)
15-15: Excellent placement and clear messaging.The note is well-positioned in the Summary section and explicitly conveys the rule's non-recommended status. Aligns perfectly with the PR objectives to eliminate ambiguity about which rules are disabled by default.
src/content/docs/linter/rules/no-excessive-cognitive-complexity.mdx (1)
15-15: Excellent label placement for clarity.The added line explicitly communicates the rule's status in the Summary section, making it immediately visible to users. This directly addresses the PR objectives to clarify non-recommended rules without relying on implicit cues.
Since this file is auto-generated (as noted in the header), the actual implementation resides in the code generator. The output here looks good.
src/content/docs/linter/rules/no-process-global.mdx (1)
15-15: Clear and well-placed label.The addition explicitly communicates that this rule is non-recommended and disabled by default, directly addressing the PR objective. The placement in the Summary section is appropriate and consistent with other rule metadata.
src/content/docs/linter/rules/no-misplaced-assertion.mdx (1)
15-15: Clear and well-placed label.The note explicitly indicates non-recommended status in the Summary section, making it immediately visible. The phrasing is straightforward and consistent with the PR objectives. Since this file is auto-generated, the underlying generator logic in
lintdoc.rsis doing the heavy lifting—this output looks spot on.Please verify that this label appears consistently across all non-recommended, non-nursery, and non-domain-scoped rules as intended by the generator changes.
src/content/docs/linter/rules/no-unassigned-variables.mdx (1)
15-15: Excellent—clear and explicit labelling for non-recommended status.The addition on line 15 directly achieves the PR objective by making it immediately obvious that this rule is not part of the recommended set. The message pairs the non-recommended status with the practical implication ("disabled by default"), which is exactly what the issue #3640 called for.
src/content/docs/linter/rules/use-error-message.mdx (1)
15-15: Well placed and clearly worded non-recommended indicator.The addition of the status line directly addresses the PR objective, communicating that the rule is disabled by default. The placement in the summary section and phrasing are consistent with how documentation typically conveys rule status.
src/content/docs/linter/rules/no-process-env.mdx (1)
15-15: Explicit labelling is spot on.The addition clearly communicates that
noProcessEnvis disabled by default and not part of the recommended ruleset. Placement in the Summary section is ideal for visibility. Since this is auto-generated output, the underlying source generator (lintdoc.rs) presumably handles this consistently across all affected rules.src/content/docs/linter/rules/use-consistent-type-definitions.mdx (1)
15-15: Excellent clarity on rule status. ✓The added note clearly communicates that this rule is not recommended and disabled by default, making the status immediately obvious to users without requiring them to infer it from absence of indicators elsewhere.
src/content/docs/linter/rules/use-number-namespace.mdx (1)
15-15: Clear and well-placed status indicator.The addition explicitly states that the rule is not part of the recommended set and is disabled by default. The placement within the Summary section is logical and provides users with essential configuration context upfront.
src/content/docs/linter/rules/no-implicit-coercions.mdx (1)
15-15: Excellent clarity on rule status.The new bullet succinctly communicates that this rule is neither recommended nor enabled by default. The placement in the Summary section is spot on—users get the key information upfront. Nicely done.
src/content/docs/linter/rules/no-re-export-all.mdx (1)
15-15: Explicit non-recommended label is clear and well-placed.The added line accurately communicates both that the rule is not recommended and disabled by default. The placement in the Summary section alongside other rule metadata is appropriate and maintains consistency with the existing format.
Since this is an auto-generated file, the implementation lives in the code generator; the output here looks correct.
src/content/docs/linter/rules/no-barrel-file.mdx (1)
15-15: Clear and appropriately placed non-recommended label.The addition at line 15 effectively communicates that this rule is disabled by default, fulfilling the PR objective to explicitly label non-recommended rules. The placement in the Summary section ensures visibility, and the wording is unambiguous.
Since this file is auto-generated, the implementation is sound as produced by the Rust code generator.
src/content/docs/linter/rules/use-self-closing-elements.mdx (1)
15-15: Verify this change came from the code generator, not a manual edit.The file header warns against manual modifications. Since
lintdoc.rsis responsible for generating these docs, please confirm this label was added via the code generator and thatuseSelfClosingElementsis correctly classified as non-recommended in the source repository.src/content/docs/linter/rules/use-readonly-class-properties.mdx (1)
15-15: Clear and well-placed documentation addition.The new line explicitly clarifies the rule's non-recommended status, directly addressing the PR objective. The placement within the Summary section is sensible alongside other rule metadata.
Since this file is auto-generated, ensure this change originates from the
lintdoc.rscode generator modifications (as mentioned in the PR summary) rather than manual edits, which would be overwritten on rebuild.src/content/docs/linter/rules/no-inferrable-types.mdx (1)
15-15: Explicit non-recommended labelling looks good.The added summary note clearly indicates this rule is not part of the recommended set and is disabled by default. The placement in the Summary section is logical and consistent with other rule metadata.
src/content/docs/linter/rules/use-strict-mode.mdx (1)
15-15: Clear and well-placed labelling for non-recommended status.The addition on line 15 explicitly states the non-recommended status in the summary, making it immediately obvious to users. The placement—right after the diagnostic category and before rule properties—is logical and ensures visibility without disrupting the flow. The wording is unambiguous and aligns with the PR objective to provide explicit labelling analogous to recommended rules.
src/content/docs/linter/rules/no-exported-imports.mdx (2)
15-15: Verify this change was made via the code generator, not by directly editing this auto-generated file.The file header (lines 2-3) states this is auto-generated and manual modifications will be lost. This addition should have originated from changes to
lintdoc.rs, not from direct edits to this MDX file.Could you confirm that the changes to add the not-recommended label (line 15) were made in the Rust code generator and not directly to this file? This ensures the change will persist across future regenerations.
15-15: Message wording and placement look good.Assuming the change originated from the code generator, the added text "This is not part of the recommended rules, meaning it is disabled by default." clearly communicates the rule's status. The placement in the Summary section is logical and follows the pattern of providing rule metadata upfront.
src/content/docs/linter/rules/use-shorthand-assign.mdx (1)
15-15: Explicit non-recommended label lands cleanly in the Summary section.The added line clearly communicates the non-recommended status upfront, right where users naturally scan for rule metadata. The placement and wording align well with the PR objectives.
Since this file is auto-generated, the actual implementation is in the source code generator—assuming
lintdoc.rswas modified to produce this consistently across all non-recommended rules, this change should work nicely.src/content/docs/linter/rules/use-node-assert-strict.mdx (1)
15-15: Clear and well-placed not-recommended indicator.The added note explicitly documents that this rule is not recommended and disabled by default, making the status immediately obvious to users visiting the rule documentation. The placement in the Summary section is ideal for visibility.
Since this is an auto-generated file, please verify that the code generator has been updated to consistently apply this note across all non-recommended rules (excluding nursery and domain-scoped rules per the PR objectives). If the generator changes are within scope of this PR, I'd be happy to review those as well.
src/content/docs/linter/rules/no-secrets.mdx (1)
15-15: Explicit non-recommended label is clear and well-placed.The new bullet point succinctly communicates both that the rule is not recommended and is disabled by default. The placement in the Summary section is ideal for user visibility, and the wording aligns perfectly with the PR's objective to avoid implicit cues.
Since this file is auto-generated (per the header), please verify that the generator correctly applies this label only to non-nursery, non-domain-scoped rules as specified in the PR objectives.
src/content/docs/linter/rules/use-collapsed-if.mdx (1)
15-15: Explicit non-recommended labelling is clear and well-placed.The addition on line 15 directly fulfils the PR objectives by making the non-recommended status immediately obvious to users. The wording is clear, the placement in the Summary section is logical, and the explanatory clause ("meaning it is disabled by default") removes any ambiguity.
src/content/docs/linter/rules/no-constant-binary-expressions.mdx (1)
15-15: Clear and well-placed non-recommended indicator.The new bullet appropriately signals the rule's default disabled status in the Summary section, making it immediately obvious to users. Formatting and messaging align well with the PR objectives.
src/content/docs/linter/rules/use-consistent-curly-braces.mdx (1)
15-15: Clear messaging for non-recommended rules.The added line effectively communicates that the rule is disabled by default and not recommended. Placement in the Summary section is logical and the phrasing aligns well with the PR's objective.
Since this is auto-generated output (as noted in the file header), please verify that
lintdoc.rsand the generator logic properly inject this text for all non-recommended, non-nursery, non-domain-scoped rules across the full documentation suite.src/content/docs/linter/rules/no-empty-block-statements.mdx (1)
15-15: Explicit non-recommended label is clear and well-positioned.The added line succinctly communicates that this rule is disabled by default and not part of the recommended set, achieving the PR objective with straightforward language.
src/content/docs/linter/rules/no-undeclared-variables.mdx (1)
15-15: Clear and well-placed documentation update.The addition of explicit non-recommended status in the summary section achieves the PR objective elegantly. The statement is immediately visible and unambiguous, striking the right tone without over-explaining.
Since this file is auto-generated, the change is producing the expected output from the code generator. The placement and wording follow the pattern of surrounding items.
As a sanity check, please verify that the source generator (
lintdoc.rs) correctly identifies this rule as non-recommended and that the statement appears consistently across all affected rule documentation pages.src/content/docs/linter/rules/no-substr.mdx (2)
1-3: Verify that this auto-generated file was not manually edited.This file explicitly states "Don't modify this file manually" (lines 2–3). The addition at line 15 must originate from the updated generator code (
lintdoc.rs), not from a manual edit, or it will be lost on the next build.The PR context mentions the generator was modified to apply not-recommended labels, so I'm assuming this change reflects that generator update. However, I cannot verify this without seeing the generator code.
To confirm the generator-based approach:
- Share the changes made to
lintdoc.rs(or equivalent) that produces this "not part of the recommended rules" text.- Verify that all non-nursery, non-domain-scoped rules that are not recommended now receive this label automatically.
Alternatively, if this line was manually added, please revert it and ensure the generator produces it instead.
Also applies to: 15-15
15-15: Message content is clear and well-placed.Assuming the change came from the generator: the phrasing directly addresses the PR objective by explicitly stating the non-recommended and default-disabled status. Positioning it in the Summary section alongside other rule metadata is appropriate.
src/content/docs/linter/rules/no-noninteractive-element-interactions.mdx (2)
15-15: Clear and well-placed label for non-recommended status.The added line succinctly communicates that this rule is non-recommended and disabled by default, meeting the PR objective. The placement in the Summary section—immediately after the diagnostic category—makes it immediately visible to users.
2-3: Consistency verified across the auto-generated ruleset.The "not part of the recommended rules" label is consistently applied across all 96 non-recommended rule files in identical wording ("This is not part of the recommended rules, meaning it is disabled by default.") and placement. No inconsistencies detected.
src/content/docs/linter/rules/no-global-dirname-filename.mdx (1)
15-15: Clear labelling of non-recommended status is spot on.The explicit note in the Summary section directly addresses the PR objective and makes the rule's non-recommended status immediately obvious. Verification confirms that consistent labelling has been applied across all non-recommended rules in the current version, and the source generator in biomejs/biome has been properly updated.
src/content/docs/linter/rules/use-numeric-separators.mdx (1)
15-15: Clear and well-positioned label for non-recommended status.The added line explicitly communicates that
useNumericSeparatorsis disabled by default. Placement in the Summary section is appropriate, and the label is applied consistently across 98+ other non-recommended rules with identical wording.src/content/docs/linter/rules/no-common-js.mdx (1)
15-15: Clear and consistent non-recommended labelling across all affected rules.The added line is present and correctly communicates the non-recommended status. Verification confirms the label is consistently applied across 91 rule files, indicating systematic generation from the source rather than isolated manual edits.
src/content/docs/linter/rules/use-simplified-logic-expression.mdx (1)
15-15: Content is correct; generator verification requires checking the main Biome repository.The added line correctly labels this rule as non-recommended and disabled by default. However, since this is the documentation website repository (which syncs from biomejs/biome), the generator code (
lintdoc.rs) and its modifications live in the main Biome repository. Verification that the generator applies this label only to non-nursery, non-domain-scoped rules would need to occur there.src/content/docs/linter/rules/no-for-each.mdx (1)
1-3: This is not a manual edit. The text at line 15 is correctly auto-generated from the modifiedlintdoc.rsgenerator, which now emits this line for non-recommended rules. The file header is accurate—these MDX files are auto-generated—and the proper workflow was followed: modify the source generator, then the output files are regenerated accordingly. No action needed.Likely an incorrect or invalid review comment.
src/content/docs/linter/rules/no-yoda-expression.mdx (1)
15-15: The non-recommended label is correctly auto-generated for this rule.The line 15 addition is generated by lintdoc.rs as part of the feature that marks non-recommended rules (excluding nursery and domain-scoped rules, which have separate labelling). This is working as intended—the inconsistency across rule files is by design, not an oversight. No verification is needed.
src/content/docs/linter/rules/use-throw-only-error.mdx (1)
15-15: Documentation content is accurate and well-placed.The added line clearly communicates that this rule is not part of the recommended set. Since this is auto-generated, the logic should originate from the code generator.
src/content/docs/linter/rules/no-negation-else.mdx (1)
15-15: Change is consistent and accurate.src/content/docs/linter/rules/no-restricted-globals.mdx (1)
15-15: Approved.src/content/docs/linter/rules/no-useless-string-concat.mdx (1)
15-15: Approved.src/content/docs/linter/rules/use-consistent-member-accessibility.mdx (1)
15-15: Approved.src/content/docs/linter/rules/no-namespace.mdx (1)
15-15: Approved.src/content/docs/linter/rules/use-grouped-accessor-pairs.mdx (1)
15-15: Approved.src/content/docs/linter/rules/no-enum.mdx (1)
15-15: Approved.src/content/docs/linter/rules/use-guard-for-in.mdx (1)
12-17: Nice clarity win: explicit “not recommended” + “disabled by default”.The new Summary bullet is concise and matches the stated goal (make non-recommended status obvious at a glance).
src/content/docs/linter/rules/use-unified-type-signatures.mdx (1)
12-18: Good addition; wording is consistent with the rest of the docs.This makes the default-disabled status hard to miss, which is exactly what folks will scan for.
src/content/docs/linter/rules/use-consistent-object-definitions.mdx (1)
12-18: LGTM: Summary now clearly signals default-off behaviour.src/content/docs/linter/rules/no-bitwise-operators.mdx (1)
12-18: LGTM: explicit non-recommended label reads well in the Summary list.src/content/docs/linter/rules/no-implicit-boolean.mdx (1)
12-18: Good: makes “not recommended” unambiguous (no more guessing from defaults).src/content/docs/linter/rules/no-restricted-elements.mdx (1)
12-18: Clear and consistent: non-recommended status is now explicit.src/content/docs/linter/rules/use-at-index.mdx (1)
12-18: Good call: explicitly stating default-disabled helps prevent “why isn’t this firing?” confusion.src/content/docs/linter/rules/use-for-of.mdx (1)
12-18: LGTM: Summary note makes the rule’s default stance obvious.src/content/docs/linter/rules/no-skipped-tests.mdx (1)
12-17: Nice clarity win: the “disabled by default” status is now explicit.
This directly addresses the “why isn’t this on by default?” confusion without adding noise.src/content/docs/linter/rules/no-restricted-imports.mdx (1)
12-18: Good: non-recommended status is now unmistakable in the Summary.src/content/docs/linter/rules/use-collapsed-else-if.mdx (1)
12-18: LGTM: the new Summary line makes default behaviour clear at a glance.src/content/docs/linter/rules/use-default-switch-clause.mdx (1)
12-18: Looks good: explicit “disabled by default” labelling is exactly what users need here.src/content/docs/linter/rules/no-namespace-import.mdx (1)
12-18: Solid: this avoids the classic “why isn’t Biome warning me about this?” support thread.src/content/docs/linter/rules/use-graphql-naming-convention.mdx (1)
12-18: Nice: makes the opt-in nature of this rule obvious without burying it in prose.src/content/docs/linter/rules/no-restricted-types.mdx (1)
12-18: Good call: this is exactly the kind of rule that should scream “opt-in”.src/content/docs/linter/rules/no-nodejs-modules.mdx (1)
12-18: LGTM: the new label sets expectations correctly (especially for web-only projects).src/content/docs/linter/rules/use-static-response-methods.mdx (1)
15-15: Consistent documentation pattern across all rule files. ✓All eight auto-generated rule documentation files correctly add the non-recommended indicator to their Summary sections. The placement (after Diagnostic Category) and wording are consistent, making the status immediately clear to users.
src/content/docs/linter/rules/use-consistent-array-type.mdx (1)
15-15: Documentation update is clear and well-positioned.The explicit label for non-recommended rules is consistent with the PR objectives and placed logically in the Summary section. Since this is an auto-generated file, ensure the source generator (lintdoc.rs or equivalent) has been updated to produce this text for all applicable non-nursery, non-domain-scoped rules.
src/content/docs/linter/rules/use-enum-initializers.mdx (1)
15-15: Consistent documentation update across rules.Same clear labelling applied here. Good consistency.
src/content/docs/linter/rules/use-explicit-length-check.mdx (1)
15-15: Documentation label applied consistently.Pattern holds across multiple rule documentation files.
src/content/docs/linter/rules/use-top-level-regex.mdx (1)
15-15: Documentation update maintains consistency.src/content/docs/linter/rules/use-as-const-assertion.mdx (1)
15-15: Consistent labelling across documentation.src/content/docs/linter/rules/no-var.mdx (1)
15-15: Documentation update consistent with broader changes.src/content/docs/linter/rules/no-await-in-loops.mdx (1)
15-15: Documentation label applied as expected.src/content/docs/linter/rules/no-evolving-types.mdx (1)
15-15: Documentation update pattern is uniform across all rule files.All eight rule documentation files consistently apply the non-recommended label. The implementation is clear, accessible, and fulfils the PR objective to make non-recommended status explicit at a glance.
src/content/docs/linter/rules/no-nested-ternary.mdx (1)
15-15: LGTM – Clear labelling added.The explicit not-recommended notice makes the rule's default state immediately obvious to users.
src/content/docs/linter/graphql/rules.mdx (2)
13-14: Legend enhanced with not-recommended indicator.Good use of the information icon to distinguish not-recommended rules from recommended ones.
39-39: Table icon correctly applied.The
useGraphqlNamingConventionrule now displays its not-recommended status inline.codegen/src/lintdoc.rs (5)
538-541: Status applicability logic is correct.The
status_applicableflag properly excludes nursery and domain-scoped rules from recommendation status, as these have their own distinct labelling systems.
564-566: Not-recommended icon rendering is appropriate.Using the
informationicon to indicate not-recommended status provides clear visual distinction from theapprove-check-circleused for recommended rules.
707-710: Consistent status logic in rule content generation.The same
status_applicablecalculation is applied here, ensuring consistency between the rules table and individual rule pages.
774-779: Clear explanatory text for non-recommended rules.The summary text explicitly states both aspects: not being part of recommended rules and being disabled by default. This removes any ambiguity for users.
478-479: Legend updated with not-recommended explanation.The addition to the language page legend ensures users understand the information icon's meaning before encountering it in the rules table.
src/content/docs/linter/rules/use-default-parameter-last.mdx (1)
15-15: Explicit labeling approved.Clear, straightforward documentation that makes non-recommended status immediately obvious to users.
src/content/docs/linter/rules/no-useless-else.mdx (1)
15-15: Consistent pattern applied.Same explicit labelling as the previous rule file, which is good for UX consistency.
src/content/docs/linter/rules/no-alert.mdx (1)
15-15: Consistent labelling maintained.Third file with identical pattern confirms the code generator is reliably applying these labels across rules.
src/content/docs/linter/html/rules.mdx (1)
13-14: Typo fix and legend clarification approved.Removed the stray 'x' from the broken icon tag and added clear documentation for the new not-recommended indicator. The legend now covers both recommended and not-recommended states.
src/content/docs/assist/graphql/actions.mdx (1)
13-14: Same fixes applied consistently.Icon typo corrected and not-recommended legend added, matching the pattern from HTML rules file.
src/content/docs/assist/css/actions.mdx (1)
13-14: Icon fixes, legend clarification, and rule table integration approved.Fixed the icon tag typo, added the not-recommended legend entry, and correctly integrated the not-recommended icon into the useSortedProperties rule row alongside the safe-fix indicator.
Also applies to: 23-23
src/content/docs/linter/json/rules.mdx (1)
13-14: Icon and legend fixes applied.Same typo correction and not-recommended legend addition as other rules documentation files.
src/content/docs/assist/html/actions.mdx (1)
13-14: Final legend file updated consistently.Icon typo fixed and not-recommended legend added, consistent with all other legend updates across the PR.
src/content/docs/linter/css/rules.mdx (1)
59-59: Not-recommended indicator correctly applied to noValueAtRule.The icon, label, and formatting match the established pattern for recommended rules. Since noValueAtRule is style-scoped (non-nursery, non-domain), it's correctly eligible for this marking per the PR objectives.
src/content/docs/assist/json/actions.mdx (2)
13-14: Legend entries identical and correct.Consistent with the CSS file. The not-recommended label text and icon choice are appropriate across all documentation types.
23-23: Not-recommended indicator placed correctly alongside safe-fix icon.Good that both status indicators coexist without conflict. useSortedKeys now clearly shows it's not recommended but has a safe automatic fix.
src/content/docs/assist/javascript/actions.mdx (2)
13-14: Legend consistent with other assist documentation.The legend correctly establishes the not-recommended indicator convention.
24-25: Both rules correctly updated with not-recommended status and safe-fix icons.useSortedAttributes and useSortedKeys now display their status clearly, with icon order (not-recommended first, fix second) matching other rules in the file.
src/content/docs/linter/javascript/rules.mdx (2)
13-14: Legend entries consistent across all four documentation files.The legend is now uniform and clear. Well done maintaining consistency from CSS through to JavaScript linter rules.
31-31: Bulk not-recommended rule updates applied consistently across all sections.The thirty-plus rule updates display the not-recommended icon correctly and without syntax errors. Icon sizing is uniform. One thing to verify: useExhaustiveDependencies (line 152) shows no not-recommended indicator—this was highlighted as a motivating example in issue #3640. Confirm this rule is correctly classified (whether it's actually recommended or perhaps domain-scoped/nursery, exempting it from the not-recommended label per PR objectives).
Also applies to: 69-70, 74-75, 94-94, 118-118, 125-125, 129-130, 133-133, 140-140, 152-152, 161-161, 224-225, 229-230, 234-234, 244-244, 250-277, 281-318, 324-324, 329-329, 336-336, 338-338, 351-351, 353-353, 370-370, 380-380, 386-386, 391-391, 394-394, 396-396, 399-399, 403-405
| ## Summary | ||
| - Rule available since: `v1.0.0` | ||
| - Diagnostic Category: [`lint/style/useFragmentSyntax`](/reference/diagnostics#diagnostic-category) | ||
| - This is not part of the recommended rules, meaning it is disabled by default. |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
head -20 src/content/docs/linter/rules/use-fragment-syntax.mdxRepository: biomejs/website
Length of output: 1000
🏁 Script executed:
# Check if the file actually contains the claimed line 15
sed -n '15p' src/content/docs/linter/rules/use-fragment-syntax.mdxRepository: biomejs/website
Length of output: 138
🏁 Script executed:
# Search for similar changes in other rule files
find src/content/docs/linter/rules -name "*.mdx" -type f | head -10 | xargs grep -l "This is not part of the recommended rules" 2>/dev/null | head -5Repository: biomejs/website
Length of output: 41
🏁 Script executed:
# Check the git history for this specific file to understand if it's generated
cd src/content/docs/linter/rules && git log --oneline use-fragment-syntax.mdx 2>/dev/null | head -5Repository: biomejs/website
Length of output: 124
This change needs to be made upstream in biomejs/biome, or the auto-generation header should be removed.
The file header explicitly warns that manual edits will be lost on the next build. The commit 605cf55 shows this change was intentional, but unless the same change exists in the source repository, it will be overwritten when the generation tool runs next. Either sync this with the upstream source, or update the file header to reflect that this file is now manually maintained.
🤖 Prompt for AI Agents
In src/content/docs/linter/rules/use-fragment-syntax.mdx around line 15, the
file still contains an auto-generation header warning that manual edits will be
lost but the current change was made intentionally (commit 605cf55); either
propagate this change upstream to biomejs/biome or mark the file as manually
maintained: if syncing upstream, open the corresponding file in the
biomejs/biome repo, apply the same change (include commit metadata) and create a
PR referencing 605cf55; if keeping it local, update this file's header to remove
or modify the autogen warning to state that the file is now manually maintained
and update any docs/build scripts to prevent regeneration, then commit with a
clear message indicating intentional manual maintenance.
|
Addressed your feedback @ematipico in the latest git commit |
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
codegen/src/lintdoc.rs (1)
762-771: Fix grammar error in recommended rules text.Line 764 reads "which means is enabled by default" but should be "which means it is enabled by default". The not-recommended message on line 769 is grammatically correct.
Apply this diff:
if is_recommended { writeln!( content, - "- This rule is **recommended**, which means is enabled by default." + "- This rule is **recommended**, which means it is enabled by default." )?; } else if is_not_recommended {
🧹 Nitpick comments (1)
src/content/docs/linter/rules/no-undeclared-dependencies.mdx (1)
18-18: Not-recommended status indicator added.The non-recommended status is clearly communicated. However, consider whether the phrasing should match the positive tone used for recommended rules (e.g., "This rule is not recommended and is disabled by default" for consistency).
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
src/components/generated/DefaultConfiguration.mdxis excluded by!**/generated/**
📒 Files selected for processing (44)
codegen/src/lintdoc.rs(4 hunks)src/content/docs/assist/css/actions.mdx(1 hunks)src/content/docs/assist/graphql/actions.mdx(1 hunks)src/content/docs/assist/html/actions.mdx(1 hunks)src/content/docs/assist/javascript/actions.mdx(1 hunks)src/content/docs/assist/json/actions.mdx(1 hunks)src/content/docs/linter/css/rules.mdx(1 hunks)src/content/docs/linter/graphql/rules.mdx(1 hunks)src/content/docs/linter/html/rules.mdx(1 hunks)src/content/docs/linter/javascript/rules.mdx(16 hunks)src/content/docs/linter/json/rules.mdx(1 hunks)src/content/docs/linter/rules/no-array-index-key.mdx(1 hunks)src/content/docs/linter/rules/no-children-prop.mdx(1 hunks)src/content/docs/linter/rules/no-dangerously-set-inner-html-with-children.mdx(1 hunks)src/content/docs/linter/rules/no-dangerously-set-inner-html.mdx(1 hunks)src/content/docs/linter/rules/no-document-import-in-page.mdx(1 hunks)src/content/docs/linter/rules/no-duplicate-test-hooks.mdx(1 hunks)src/content/docs/linter/rules/no-excessive-nested-test-suites.mdx(1 hunks)src/content/docs/linter/rules/no-exports-in-test.mdx(1 hunks)src/content/docs/linter/rules/no-focused-tests.mdx(1 hunks)src/content/docs/linter/rules/no-head-element.mdx(1 hunks)src/content/docs/linter/rules/no-head-import-in-document.mdx(1 hunks)src/content/docs/linter/rules/no-img-element.mdx(1 hunks)src/content/docs/linter/rules/no-nested-component-definitions.mdx(1 hunks)src/content/docs/linter/rules/no-private-imports.mdx(1 hunks)src/content/docs/linter/rules/no-qwik-use-visible-task.mdx(1 hunks)src/content/docs/linter/rules/no-react-prop-assignments.mdx(1 hunks)src/content/docs/linter/rules/no-react-specific-props.mdx(1 hunks)src/content/docs/linter/rules/no-render-return-value.mdx(1 hunks)src/content/docs/linter/rules/no-solid-destructured-props.mdx(1 hunks)src/content/docs/linter/rules/no-undeclared-dependencies.mdx(1 hunks)src/content/docs/linter/rules/no-unwanted-polyfillio.mdx(1 hunks)src/content/docs/linter/rules/use-component-export-only-modules.mdx(1 hunks)src/content/docs/linter/rules/use-exhaustive-dependencies.mdx(1 hunks)src/content/docs/linter/rules/use-google-font-preconnect.mdx(1 hunks)src/content/docs/linter/rules/use-hook-at-top-level.mdx(1 hunks)src/content/docs/linter/rules/use-image-size.mdx(1 hunks)src/content/docs/linter/rules/use-import-extensions.mdx(1 hunks)src/content/docs/linter/rules/use-json-import-attributes.mdx(1 hunks)src/content/docs/linter/rules/use-jsx-key-in-iterable.mdx(1 hunks)src/content/docs/linter/rules/use-qwik-classlist.mdx(1 hunks)src/content/docs/linter/rules/use-react-function-components.mdx(1 hunks)src/content/docs/linter/rules/use-solid-for-component.mdx(1 hunks)src/content/docs/linter/rules/use-unique-element-ids.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (8)
- src/content/docs/linter/rules/no-dangerously-set-inner-html-with-children.mdx
- src/content/docs/assist/json/actions.mdx
- src/content/docs/linter/rules/no-focused-tests.mdx
- src/content/docs/linter/rules/use-solid-for-component.mdx
- src/content/docs/linter/rules/no-excessive-nested-test-suites.mdx
- src/content/docs/assist/html/actions.mdx
- src/content/docs/linter/rules/no-duplicate-test-hooks.mdx
- src/content/docs/linter/rules/no-exports-in-test.mdx
🚧 Files skipped from review as they are similar to previous changes (5)
- src/content/docs/assist/css/actions.mdx
- src/content/docs/linter/css/rules.mdx
- src/content/docs/linter/graphql/rules.mdx
- src/content/docs/linter/json/rules.mdx
- src/content/docs/assist/graphql/actions.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - biomejs
- GitHub Check: Header rules - biomejs
- GitHub Check: Pages changed - biomejs
🔇 Additional comments (28)
src/content/docs/linter/rules/no-react-specific-props.mdx (1)
15-15: Good use of explicit labelling.The added bullet accurately states the rule's status in the Summary section, making it immediately apparent to readers without digging through configuration. Straightforward and effective—though do verify that this change originates from the codegen tool rather than manual edits (since the file header warns against manual modifications).
src/content/docs/linter/rules/use-jsx-key-in-iterable.mdx (1)
15-15: Explicit labelling is clear and well-placed.The new line clearly communicates that the rule is recommended and enabled by default. Since this is an auto-generated file, I assume the template changes in the codegen are generating this correctly. Looks good to me.
src/content/docs/linter/rules/use-unique-element-ids.mdx (1)
15-15: Excellent—explicit labelling is a big win for discoverability.The new summary line makes the non-recommended status immediately clear to users browsing the documentation, matching the PR objectives perfectly. The wording is straightforward and the placement in the Summary section is spot-on.
src/content/docs/linter/rules/no-qwik-use-visible-task.mdx (1)
15-15: Status indicator is clear and well-placed.The addition of the rule status line is appropriate and aligns with the PR objectives to explicitly label rule recommendations. The placement in the Summary section and formatting are consistent with the document structure.
src/content/docs/linter/rules/use-react-function-components.mdx (1)
15-15: Well integrated documentation update.The added line clearly signals non-recommended status and aligns with the PR's objective to make rule recommendation status explicit. Placement in the Summary section ensures visibility, and the wording parallels the intent established in the linked issue #3640.
Since this is an auto-generated file, please verify that
codegen/src/lintdoc.rshas been updated to emit this line for non-recommended rules across all affected rule documentation pages.src/content/docs/linter/rules/use-component-export-only-modules.mdx (1)
15-15: LGTM — clear and well-placed labelling.The addition of the "not part of the recommended rules" text fits naturally into the Summary section and communicates the rule's status explicitly, as intended. However, since this file is auto-generated, ensure the underlying code generator (
codegen/src/lintdoc.rsper the PR summary) has been properly updated to produce this output consistently across all affected rule pages.src/content/docs/linter/rules/no-img-element.mdx (1)
15-15: Accurate documentation of rule status.The added line correctly documents that
noImgElementis a recommended rule and enabled by default. Since this file is auto-generated, the underlying codegen changes are what matter, but this documentation output looks good.src/content/docs/linter/rules/no-head-element.mdx (1)
15-15: Approved: explicit labelling aligns with PR objectives.The addition of clear "This rule is recommended, which means is enabled by default" text effectively communicates the rule's status at a glance. However, given the PR notes that domain-scoped rules have "their own distinct labelling," please verify that pairing the explicit
recommendedlabel with the existingnextdomain badge (line 19) is intentional and doesn't create redundant labelling.src/content/docs/linter/rules/use-import-extensions.mdx (1)
18-18: Excellent clarity on non-recommended status.The new line explicitly surfaces the rule's non-recommended status right in the Summary, which aligns perfectly with the PR objectives and makes it immediately obvious to users. The wording is clear and unambiguous.
src/content/docs/linter/rules/no-react-prop-assignments.mdx (2)
15-15: Verify: Should domain-scoped rules display this indicator?The added line properly communicates the non-recommended status. However, the PR objectives state that "domain-scoped rules are excluded from this indicator," and this rule belongs to the
reactdomain (line 19). Please confirm whether this rule should actually have this indicator, or whether the codegen exclusion logic needs adjustment.
12-21: Formatting and placement look good.The "not recommended" line is well-integrated into the Summary section, maintains consistent formatting with adjacent metadata, and clearly communicates the rule status at a glance—precisely the intent of the PR.
src/content/docs/linter/html/rules.mdx (1)
13-13: Icon tag syntax corrected. Removing the stray "x" from the JSX attribute is the right call—this was preventing proper component rendering.src/content/docs/assist/javascript/actions.mdx (1)
13-13: Icon tag syntax corrected. Same JSX attribute fix as the HTML rules file—stray "x" removed. Consistent fix across auto-generated docs.src/content/docs/linter/javascript/rules.mdx (2)
13-13: Icon tag syntax corrected. Stray "x" removed; matches fixes in other auto-generated files.
110-580: Extensive rule table updates look consistent with code generation changes. Icon spans added across rule sections align with the PR's goal of surfacing rule recommendation status. Since this is auto-generated, these should flow from your updated codegen logic (lintdoc.rs).Consider confirming that all these changes are indeed output from the code generator rather than manual edits to the auto-generated file.
src/content/docs/linter/rules/use-image-size.mdx (1)
15-15: The generated content is correct. TheuseImageSizerule is properly labelled as recommended and enabled by default on line 15, matching the consistent pattern used for other recommended rules in the codebase (e.g.,no-const-assign).src/content/docs/linter/rules/no-dangerously-set-inner-html.mdx (1)
15-15: Status indicator added correctly.The recommended status line is properly placed and clearly communicates the rule's default enablement to users.
src/content/docs/linter/rules/no-children-prop.mdx (1)
15-15: Status indicator added correctly.Consistent with other recommended rules and clearly indicates default enablement.
src/content/docs/linter/rules/no-array-index-key.mdx (1)
15-15: Status indicator added correctly.Properly placed and consistent with other recommended rules.
src/content/docs/linter/rules/no-document-import-in-page.mdx (1)
15-15: Status indicator added correctly.Consistent placement and messaging across the recommended rules set.
src/content/docs/linter/rules/no-render-return-value.mdx (1)
15-15: Status indicator added correctly.Properly positioned and consistent with the broader documentation updates.
src/content/docs/linter/rules/use-exhaustive-dependencies.mdx (1)
15-15: Status indicator added correctly.Consistent with other recommended rules and clearly communicates the rule's enablement status.
src/content/docs/linter/rules/use-google-font-preconnect.mdx (1)
15-15: Status indicator added correctly.Consistent with the recommended rules set and properly surfaces the enablement status.
src/content/docs/linter/rules/no-nested-component-definitions.mdx (1)
15-15: LGTM – auto-generated content is correct.The not-recommended label has been properly added. Since this file is auto-generated, any issues would need to be addressed in the Rust codegen source.
src/content/docs/linter/rules/use-qwik-classlist.mdx (1)
15-15: Grammar issue in auto-generated text.The phrase "which means is enabled" is missing the word "it". However, since this file is auto-generated, the fix must be applied in
codegen/src/lintdoc.rsat line 764.codegen/src/lintdoc.rs (3)
537-537: Good fix – domains check removed correctly.The previous logic incorrectly excluded domain-scoped rules from being marked as recommended. This change aligns with the feedback from past reviews.
701-702: Logic for is_not_recommended looks sound.The new flag correctly identifies non-nursery, non-recommended rules. Nursery rules are properly excluded from receiving the "not recommended" label, which is exactly what the PR objectives call for.
559-573: Good addition of explicit icon sizes.Adding
size="1.2rem"attributes ensures consistent icon rendering across the documentation.
Non-recommended linter rules now display an information icon in rules tables and explicit text on individual rule pages. Nursery and domain-scoped rules are excluded from this indicator as they have their own distinct labeling. Closes biomejs#3640
Removes the information icon and explicit text for non-recommended rules from both rule table listings and individual rule pages. The indicator that was added to distinguish non-recommended rules is no longer needed. Changes made to codegen: - Removed logic for generating non-recommended status icons in rule tables - Removed non-recommended status indicator from rule page metadata - Cleaned up conditional logic for recommendation status Generated documentation updated across 45 files including rule listings and individual rule pages.
chore: fix URL for Biome schema
PaulRBerg
force-pushed
the
feat/explicit-non-recommended
branch
from
16ff90f to
da92326
Compare
3 participants
Non-recommended linter rules now display an information icon in rules tables and explicit text on individual rule pages. This makes it clearer which rules are disabled by default without being recommended.
Nursery and domain-scoped rules are excluded from this indicator as they have their own distinct labeling.
Closes #3640