Conversation
|
Parser conformance results onjs/262
jsx/babel
markdown/commonmark
symbols/microsoft
ts/babel
ts/microsoft
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review infoConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughThe rules check harness now validates that lint rules declare proper options types. Using TypeId at runtime, the harness detects when a rule declares Possibly related PRs
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)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@crates/biome_rule_options/src/no_initializer_with_definite.rs`:
- Line 6: Add an inline rustdoc comment for the public options struct
NoInitializerWithDefiniteOptions describing its purpose and usage so it appears
in generated docs; update the declaration of NoInitializerWithDefiniteOptions to
include a concise triple-slash doc comment (one-line summary, optional second
line for brief details) above the struct definition to follow the guideline "Use
inline rustdoc documentation for rules, assists, and their options".
ℹ️ Review info
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
crates/biome_js_analyze/src/syntax/correctness/no_duplicate_private_class_members.rscrates/biome_js_analyze/src/syntax/correctness/no_initializer_with_definite.rscrates/biome_js_analyze/src/syntax/correctness/no_super_without_extends.rscrates/biome_js_analyze/src/syntax/correctness/no_type_only_import_attributes.rscrates/biome_rule_options/src/lib.rscrates/biome_rule_options/src/no_duplicate_private_class_members.rscrates/biome_rule_options/src/no_initializer_with_definite.rscrates/biome_rule_options/src/no_super_without_extends.rscrates/biome_rule_options/src/no_type_only_import_attributes.rsxtask/rules_check/src/lib.rs
| #[derive(Default, Clone, Debug, Deserialize, Deserializable, Merge, Eq, PartialEq, Serialize)] | ||
| #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))] | ||
| #[serde(rename_all = "camelCase", deny_unknown_fields, default)] | ||
| pub struct NoInitializerWithDefiniteOptions {} |
There was a problem hiding this comment.
Add inline rustdoc for the new options type.
Line 6 introduces a public options struct without a /// doc comment. Please add a short rustdoc summary so this stays discoverable in generated docs (future-you will thank present-you).
As per coding guidelines: “Use inline rustdoc documentation for rules, assists, and their options”.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@crates/biome_rule_options/src/no_initializer_with_definite.rs` at line 6, Add
an inline rustdoc comment for the public options struct
NoInitializerWithDefiniteOptions describing its purpose and usage so it appears
in generated docs; update the declaration of NoInitializerWithDefiniteOptions to
include a concise triple-slash doc comment (one-line summary, optional second
line for brief details) above the struct definition to follow the guideline "Use
inline rustdoc documentation for rules, assists, and their options".
Merging this PR will not alter performance
Comparing Footnotes
|
|
Actually at a bit of a loss for why the CI is failing here. Everything passes for me locally. But seeing as its all related to syntax rules, it would make sense for those to not have options, so I'm just going to exclude them. |
0fc9bbe to
7b35275
Compare
Summary
fixes #9263
Test Plan
CI should be green
Docs