Skip to content

docs(linter): Update comment in lint.rs about default value for tsconfig path#15530

Merged
connorshea merged 3 commits intomainfrom
improve-cli-comment
Nov 9, 2025
Merged

docs(linter): Update comment in lint.rs about default value for tsconfig path#15530
connorshea merged 3 commits intomainfrom
improve-cli-comment

Conversation

@connorshea
Copy link
Member

It wasn't previously clear what would be done if no tsconfig path was provided, so this clarifies that.

This comment will be automatically used by the CLI and documentation website: https://oxc.rs/docs/guide/usage/linter/cli.html#basic-configuration

It wasn't previously clear what would be done if no tsconfig path was provided, so this clarifies that.

This will be automatically used by the CLI and documentation website.
@connorshea connorshea requested a review from camc314 as a code owner November 9, 2025 22:11
Copilot AI review requested due to automatic review settings November 9, 2025 22:11
@graphite-app
Copy link
Contributor

graphite-app bot commented Nov 9, 2025

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.

@github-actions github-actions bot added A-linter Area - Linter A-cli Area - CLI C-docs Category - Documentation. Related to user-facing or internal documentation labels Nov 9, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR enhances the documentation for the tsconfig field in the BasicOptions struct by clarifying the fallback behavior when the parameter is not provided.

  • Added documentation explaining that if the tsconfig parameter is not provided, oxlint will look for tsconfig.json in the current working directory

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Connor Shea <connor.james.shea@gmail.com>
This was very difficult to figure out how to trigger. `cargo insta test` finally worked.
@connorshea connorshea merged commit 97d2104 into main Nov 9, 2025
18 checks passed
@connorshea connorshea deleted the improve-cli-comment branch November 9, 2025 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-cli Area - CLI A-linter Area - Linter C-docs Category - Documentation. Related to user-facing or internal documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants