feat: add require-read-r rule

[nzakas]

Adds shell/require-read-r, which mirrors ShellCheck SC2162: read without -r treats backslashes as escapes and mangles input.

Behavior

• Reports read when none of its short-flag arguments before -- contains r. Combined flags like -rs and separate flags like -t 5 -r both count.
• Autofix: inserts -r right after read (read -s pw → read -r -s pw).
• Recommended config: "error".

Documentation

Adds docs/rules/require-read-r.md, following the format of the @eslint/json, @eslint/css, and @eslint/markdown rule docs: description, background, rule details with incorrect and correct examples, options, when not to use it, and the ShellCheck reference. The rule's meta.docs.url points at that file, and its README table entry links to it.

Testing

• 8 RuleTester cases.
• An end-to-end verifyAndFix test in tests/autofix.test.ts.
• 5 documentation checks.

284 tests total; build, lint, and format checks pass.

🤖 Generated with Claude Code

---

_{Stack created with GitHub Stacks CLI • Give Feedback 💬}

[coderabbitai]

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 35 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 7d3d4563-9a34-4857-8ab6-1ff9d7728b99

📥 Commits

Reviewing files that changed from the base of the PR and between cade9ff and 99a4eeb.

📒 Files selected for processing (7)

• README.md
• docs/rules/require-read-r.md
• src/index.spec.ts
• src/index.ts
• src/rules/require-read-r.spec.ts
• src/rules/require-read-r.ts
• tests/autofix.test.ts

• Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[Copilot]

Copilot review overview

🟡 Changes recommended

Option operands containing -r can suppress valid reports even though raw mode is not enabled.

Review effort: Balanced
Findings: 1

Open (1)

• Incorrectly detects -r when it is an option operand · New

What changed in this PR

Adds the recommended bash/require-read-r rule to prevent read from mangling backslashes.

Changes:

• Implements and registers the autofixable rule.
• Adds unit, integration, and documentation coverage.
• Documents the rule and updates the README.

File	Description
src/​rules/​require-read-r.ts	Implements detection and autofixing.
src/​rules/​require-read-r.spec.ts	Adds rule tests.
src/​index.ts	Registers and recommends the rule.
src/​index.spec.ts	Verifies rule registration.
tests/​autofix.test.ts	Adds end-to-end autofix coverage.
docs/​rules/​require-read-r.md	Documents behavior and usage.
README.md	Adds the rule to the catalog.

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[nzakas]

Already addressed in 7b4a7d1: the rule now walks read's option clusters with arity, so the operand of -d (separate or attached) is not mistaken for -r. Both read -d -r value and read -dr value are covered as invalid cases. Reviewed and confirmed the suite passes on this branch.

[nzakas]

@copilot address review comments. Be sure to add tests.

[Copilot]

@copilot address review comments. Be sure to add tests.

Fixed in commit 7b4a7d1; added regression tests for separate and attached delimiter operands.