docs(linter): improve docs for jsdoc/require-property #10705

camc314 · 2025-04-29T19:55:31Z

camc314 · 2025-04-29T19:55:45Z

docs(linter): improve docs for jsdoc/require-property #10705 👈 (View in Graphite)
main

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

0-merge - adds this PR to the back of the merge queue
hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

_{An organization admin has enabled the Graphite Merge Queue in this repository.} _{Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.}

This stack of pull requests is managed by Graphite. Learn more about stacking.

codspeed-hq · 2025-04-29T20:01:53Z

CodSpeed Instrumentation Performance Report

Merging #10705 will not alter performance

_{Comparing c/04-29-docs_linter_improve_docs_for_jsdoc_require-property (5f15809) with main (f3cc3a2)}

Summary

✅ 36 untouched benchmarks

Sysix

Can we add an example how to configure it? Without reading the issue, I would never have known it :)

Boshen · 2025-04-30T14:25:48Z

Merge activity

Apr 30, 10:25 AM EDT: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
May 7, 11:49 AM EDT: Boshen added this pull request to the Graphite merge queue.
May 7, 11:53 AM EDT: Merged by the Graphite merge queue.

coderabbitai · 2025-04-30T14:26:45Z

Walkthrough

The change updates the documentation comment for the RequireProperty lint rule within the codebase. Specifically, it adds information clarifying that the rule can be configured using the jsdoc settings option. No modifications were made to the logic, control flow, or error handling of the rule itself. The update is limited to the documentation and does not alter any exported or public entities.

✨ Finishing Touches

📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

crates/oxc_linter/src/rules/jsdoc/require_property.rs (1)
28-29: Nitpick: Clarify which jsdoc setting is used

The note is helpful, but it would be clearer to mention the specific tagNamePreference key under jsdoc settings. For example:
- /// Note: this rule can be configured via the jsdoc settings option.
+ /// Note: tag names (e.g., `@property`) can be customized via the `jsdoc.tagNamePreference` setting.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c066be1 and 24a9730.

📒 Files selected for processing (1)

crates/oxc_linter/src/rules/jsdoc/require_property.rs (1 hunks)

camc314 · 2025-05-07T15:37:34Z

Can we add an example how to configure it? Without reading the issue, I would never have known it :)

I've added a link to the settings.jsdoc config. which i think should help (although docs there need to be improved)

closes #10252

camc314 mentioned this pull request Apr 29, 2025

feat(linter): implement fixer for unicorn/prefer-number-properties #10693

Merged

camc314 mentioned this pull request Apr 29, 2025

feat(linter): add fixer to jsx-curly-brace-presence #10704

Closed

github-actions bot added A-linter Area - Linter C-docs Category - Documentation. Related to user-facing or internal documentation labels Apr 29, 2025

camc314 requested review from Sysix and camchenry April 29, 2025 19:56

camc314 changed the base branch from c/04-29-feat_linter_add_fixer_to_jsx-curly-brace-presence to graphite-base/10705 April 29, 2025 19:57

camc314 force-pushed the c/04-29-docs_linter_improve_docs_for_jsdoc_require-property branch from b4d9eb6 to 24a9730 Compare April 29, 2025 19:57

camc314 force-pushed the graphite-base/10705 branch from 7f3a86c to e97a4e0 Compare April 29, 2025 19:57

camc314 changed the base branch from graphite-base/10705 to main April 29, 2025 19:57

camc314 marked this pull request as ready for review April 29, 2025 19:57

Sysix requested changes Apr 29, 2025

View reviewed changes

Boshen added the 0-merge Merge with Graphite Merge Queue label Apr 30, 2025

coderabbitai bot reviewed Apr 30, 2025

View reviewed changes

camc314 force-pushed the c/04-29-docs_linter_improve_docs_for_jsdoc_require-property branch from 24a9730 to 2cb6c36 Compare May 7, 2025 15:37

Sysix approved these changes May 7, 2025

View reviewed changes

docs(linter): improve docs for jsdoc/require-property (#10705)

5f15809

closes #10252

graphite-app bot force-pushed the c/04-29-docs_linter_improve_docs_for_jsdoc_require-property branch from 2cb6c36 to 5f15809 Compare May 7, 2025 15:50

graphite-app bot merged commit 5f15809 into main May 7, 2025
23 checks passed

graphite-app bot deleted the c/04-29-docs_linter_improve_docs_for_jsdoc_require-property branch May 7, 2025 15:53

graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label May 7, 2025

oxc-bot mentioned this pull request May 9, 2025

release(oxlint): v0.16.10 #10916

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs(linter): improve docs for jsdoc/require-property #10705

docs(linter): improve docs for jsdoc/require-property #10705

Uh oh!

camc314 commented Apr 29, 2025 •

edited

Loading

Uh oh!

camc314 commented Apr 29, 2025 •

edited

Loading

Uh oh!

codspeed-hq bot commented Apr 29, 2025 •

edited

Loading

Uh oh!

Sysix left a comment

Uh oh!

Boshen commented Apr 30, 2025 •

edited by graphite-app bot

Loading

Uh oh!

coderabbitai bot commented Apr 30, 2025

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

camc314 commented May 7, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

docs(linter): improve docs for jsdoc/require-property #10705

docs(linter): improve docs for jsdoc/require-property #10705

Uh oh!

Conversation

camc314 commented Apr 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

camc314 commented Apr 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

How to use the Graphite Merge Queue

Uh oh!

codspeed-hq bot commented Apr 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Instrumentation Performance Report

Merging #10705 will not alter performance

Summary

Uh oh!

Sysix left a comment

Choose a reason for hiding this comment

Uh oh!

Boshen commented Apr 30, 2025 • edited by graphite-app bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

coderabbitai bot commented Apr 30, 2025

Walkthrough

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

camc314 commented May 7, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

camc314 commented Apr 29, 2025 •

edited

Loading

camc314 commented Apr 29, 2025 •

edited

Loading

codspeed-hq bot commented Apr 29, 2025 •

edited

Loading

Boshen commented Apr 30, 2025 •

edited by graphite-app bot

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)