Skip to content

docs(linter): Add configuration docs to no-useless-escape lint rule.#14791

Merged
camc314 merged 4 commits intooxc-project:mainfrom
connorshea:cshea/no-useless-escape
Oct 20, 2025
Merged

docs(linter): Add configuration docs to no-useless-escape lint rule.#14791
camc314 merged 4 commits intooxc-project:mainfrom
connorshea:cshea/no-useless-escape

Conversation

@connorshea
Copy link
Member

@connorshea connorshea commented Oct 19, 2025

Also add missing text for "Why is this bad?" section. I've updated this to use the autogen docs rather than an explicit Options section, since that seems to be the preferred implementation path for this kind of addition.

Part of #14743.

Results in:

## Configuration

This rule accepts a configuration object with the following properties:

### allowRegexCharacters

type: `string[]`

default: `[]`

An array of characters that are allowed to be escaped unnecessarily in regexes.

Also add missing text for "Why is this bad?" section.
@connorshea connorshea requested a review from camc314 as a code owner October 19, 2025 23:17
Copilot AI review requested due to automatic review settings October 19, 2025 23:17
@graphite-app
Copy link
Contributor

graphite-app bot commented Oct 19, 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 C-docs Category - Documentation. Related to user-facing or internal documentation labels Oct 19, 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 adds comprehensive documentation to the no-useless-escape lint rule, including missing content for the "Why is this bad?" section and a new "Options" section with details about the allowRegexCharacters configuration option.

  • Added explanatory text for why unnecessary escapes are problematic
  • Added complete Options documentation with configuration details and JSON example

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

connorshea and others added 3 commits October 19, 2025 17:19
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Connor Shea <connor.james.shea@gmail.com>
@connorshea connorshea requested a review from Copilot October 20, 2025 04:52
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

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@connorshea connorshea changed the title docs(linter): Add Options docs to no-useless-escape lint rule. docs(linter): Add configuration docs to no-useless-escape lint rule. Oct 20, 2025
Copy link
Contributor

@camc314 camc314 left a comment

Choose a reason for hiding this comment

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

Thank yoU!

@codspeed-hq
Copy link

codspeed-hq bot commented Oct 20, 2025

CodSpeed Performance Report

Merging #14791 will not alter performance

Comparing connorshea:cshea/no-useless-escape (9b2e7fb) with main (7be9489)1

Summary

✅ 4 untouched
⏩ 33 skipped2

Footnotes

  1. No successful run was found on main (6d5f7b2) during the generation of this report, so 7be9489 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

  2. 33 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

@camc314 camc314 merged commit c80da95 into oxc-project:main Oct 20, 2025
23 checks passed
@camc314 camc314 self-assigned this Oct 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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