docs: improve the documentation #464
Conversation
Fixed the overall punctuation, the typos, and the structure of a few sentences. Also, added installation commands with Bun.
|
WalkthroughThe README.md file was updated to improve editorial quality, including grammar corrections, punctuation adjustments, capitalization consistency, clearer phrasing, and minor formatting enhancements. New installation instructions for the Bun package manager were added. No code, configuration, or logical instructions were changed. Changes
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
commit: |
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
There was a problem hiding this comment.
Important
Looks good to me! 👍
Reviewed everything up to b8cd1bd in 1 minute and 28 seconds. Click for details.
- Reviewed
273lines of code in1files - Skipped
0files when reviewing. - Skipped posting
12draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. README.md:15
- Draft comment:
Improved introductory sentence punctuation. The added period after the parenthesized clause enhances clarity. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
2. README.md:22
- Draft comment:
Added a comma in the phrase 'Multiple tsconfigs support, just like normal' for improved readability. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
3. README.md:53
- Draft comment:
Fixed a typo by replacing 'then' with 'than' to correctly compare priority between file types. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
4. README.md:55
- Draft comment:
Reworded the sentence regarding issues withimport/defaultandimport/namedrules for clarity and proper punctuation. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
5. README.md:71
- Draft comment:
Added Bun installation command foreslint-plugin-import-x, expanding installation options for users with Bun. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
6. README.md:87
- Draft comment:
Added Bun installation command foreslint-plugin-import, ensuring consistency across installation guides. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
7. README.md:97
- Draft comment:
Enhanced the ESLint configuration example by wrappingimport/requirein backticks and adding semicolons, which improves code snippet clarity. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
8. README.md:187
- Draft comment:
Standardized inline comment punctuation and capitalization in the .eslintrc configuration example for consistency. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
9. README.md:226
- Draft comment:
Improved the Bun resolution instructions by ending each bullet point with a period, which enhances overall readability. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
10. README.md:337
- Draft comment:
Clarified the explanation for reusing default options by directly usingrequire/import, and added an Oxford comma for better readability. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
11. README.md:347
- Draft comment:
Minor punctuation improvement in the Contributing section regarding the GitHub Actions reference enhances clarity. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
12. README.md:216
- Draft comment:
Typographical suggestion: The comment "Use an array of glob patterns" is missing a period at the end to be consistent with the other comments in this section. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%This comment is purely about a typographical suggestion, which is not related to the functionality or logic of the code. It doesn't provide any meaningful insight or suggestion for code improvement. Therefore, it violates the rule of not making purely informative comments.
Workflow ID: wflow_iFNtuolWiqLjncHl
You can customize 
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
53-55: Remove comma before “because”
Consider dropping the comma for smoother flow:
“do not post any issue here because they are working exactly as expected…”
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(11 hunks)
🧰 Additional context used
🧠 Learnings (1)
README.md (1)
Learnt from: JounQin
PR: import-js/eslint-import-resolver-typescript#0
File: :0-0
Timestamp: 2025-03-29T14:40:46.154Z
Learning: In the eslint-import-resolver-typescript repository, `yarn build` must be run before linting and testing as the linting and testing processes depend on artifacts generated during the build step.
🪛 LanguageTool
README.md
[formatting] ~55-~55: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...n-import`][], do not post any issue here, because they are working exactly as [expected](...
(COMMA_BEFORE_BECAUSE)
⏰ Context from checks skipped due to timeout of 90000ms (5)
- GitHub Check: Lint and Test with Node.js 22 on windows-latest
- GitHub Check: Lint and Test with Node.js 24 on macos-latest
- GitHub Check: Lint and Test with Node.js 24 on windows-latest
- GitHub Check: Lint and Test with Node.js 18 on windows-latest
- GitHub Check: Lint and Test with Node.js 20 on windows-latest
🔇 Additional comments (10)
README.md (10)
15-15: Improve plugin description clarity
The intro phrasing now clearly distinguishes this resolver from an ESLint plugin and mentions TypeScript support.
22-22: Add multi-tsconfig support bullet
This line succinctly highlights multiple tsconfig support, enhancing the feature list.
61-73: Include Bun in import-x installation
Bun commands are correctly added alongside NPM, PNPM, and Yarn.
78-89: Include Bun in import installation
Consistent Bun install instructions ensure parity across package manager sections.
95-136: Clarify flat config example
Code snippets undereslint-plugin-import-xare now formatted and commented more consistently.
138-177: Refine legacy config example
The legacyeslint-plugin-importexample improves clarity and includes Bun resolution.
183-224: Standardize.eslintrcsnippet
Rules and settings formatting is now uniform, improving readability.
235-238: Clarify Bun environment options
The three listed options for Bun resolution are concise and clear.
263-307: Improveunrs-resolveroptions docs
The default options blocks for conditionNames, extensions, extensionAlias, and mainFields are now better commented.
333-339: Enhance default options reuse note
The note on reusing defaults via import now clearly directs users to the relevant exports.
Minor changes based on the last review
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (7)
README.md (7)
106-106: Inline comment punctuation preference.Per previous feedback, inline comments need not end with a period—they’re treated as notes, not full sentences.
108-108: Inline comment punctuation preference.Consistent with earlier guidance, terminal punctuation on inline comments is optional.
147-147: Inline comment punctuation preference.Maintaining consistency with previous feedback: punctuation at end is optional.
149-149: Inline comment punctuation preference.As above, terminal punctuation on inline comments is discretionary.
187-187: Inline comment punctuation preference.Per earlier discussion, adding a period is optional for inline comments.
196-196: Inline comment punctuation preference.Retaining flexibility on terminal punctuation for clarity.
198-198: Inline comment punctuation preference.Consistent with the established style for single-line comments.
🧹 Nitpick comments (7)
README.md (7)
15-15: Address comma splice in descriptive sentence.The sentence currently reads as a comma splice. Consider splitting into two sentences or using a semicolon for clarity.
- This is a resolver for `eslint-plugin-import(-x)` plugin, not an ESLint plugin itself, it adds [`TypeScript`][] support to [`eslint-plugin-import`][]. (Or maybe you want to try [`eslint-plugin-import-x`][] for faster speed) + This is a resolver for the `eslint-plugin-import(-x)` plugin; it is not an ESLint plugin itself. It adds [`TypeScript`][] support to [`eslint-plugin-import`][]. Or, for faster performance, you can try [`eslint-plugin-import-x`][].
22-22: Clarify bullet phrasing for multiple tsconfigs.The current phrasing is a bit informal. Consider revising to:
- - Multiple tsconfigs support, just like normal + - Support for multiple tsconfig files, as with a standard setup
55-55: Remove comma before "because".Per style, drop the comma preceding the essential “because” clause:
- If you're facing some problems with rules `import/default` or `import/named` from [`eslint-plugin-import`][] , do not post any issue here, because they are working exactly as [expected](...). + If you're facing some problems with rules `import/default` or `import/named` from [`eslint-plugin-import`][] , do not post any issue here because they are working exactly as [expected](...).
138-138: Avoid starting with "But".For a more formal tone, remove the leading conjunction:
- But if you are using `eslint-plugin-import` or the older version of `eslint-plugin-import-x`, you can't use `require`/`import`: + If you are using `eslint-plugin-import` or an older version of `eslint-plugin-import-x`, you can't use `require`/`import`:
333-333: Refine phrasing for option passing."Forward other options" may read more naturally:
- You can pass through other options of [`unrs-resolver`][] directly. + You can forward other options directly to [`unrs-resolver`][].
337-337: Clarify import phrasing.Consider adjusting for readability:
- You can reuse `defaultConditionNames`, `defaultExtensions`, `defaultExtensionAlias`, and `defaultMainFields` by directly using `require`/`import`. + You can import and reuse `defaultConditionNames`, `defaultExtensions`, `defaultExtensionAlias`, and `defaultMainFields`.
346-346: Rephrase GitHub Actions sentence.Active voice is clearer:
- We have [GitHub Actions](https://github.com/…), which will run the above commands on your PRs. + GitHub Actions runs the above commands on each PR.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(10 hunks)
🧰 Additional context used
🧠 Learnings (1)
README.md (2)
Learnt from: JounQin
PR: import-js/eslint-import-resolver-typescript#0
File: :0-0
Timestamp: 2025-03-29T17:28:02.447Z
Learning: The eslint-import-resolver-typescript repository uses yarn as its package manager, and @1stg/eslint-config should never be missing as a dependency when running lint commands.
Learnt from: JounQin
PR: import-js/eslint-import-resolver-typescript#0
File: :0-0
Timestamp: 2025-03-29T14:40:46.154Z
Learning: In the eslint-import-resolver-typescript repository, `yarn build` must be run before linting and testing as the linting and testing processes depend on artifacts generated during the build step.
🪛 LanguageTool
README.md
[formatting] ~55-~55: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...n-import`][], do not post any issue here, because they are working exactly as [expected](...
(COMMA_BEFORE_BECAUSE)
⏰ Context from checks skipped due to timeout of 90000ms (5)
- GitHub Check: Lint and Test with Node.js 24 on macos-latest
- GitHub Check: Lint and Test with Node.js 24 on windows-latest
- GitHub Check: Lint and Test with Node.js 22 on windows-latest
- GitHub Check: Lint and Test with Node.js 20 on windows-latest
- GitHub Check: Lint and Test with Node.js 18 on windows-latest
🔇 Additional comments (18)
README.md (18)
53-53: Approve editorial update for priority explanation.The explanation of
.d.tspriority is clear and concise.
70-72: Approve Bun installation instructions.The new Bun commands are correctly formatted and consistent with the other package manager sections.
86-88: Approve Bun section foreslint-plugin-import.Installation steps mirror the earlier block and look good.
95-95: Approve flat config note.The instruction for flat ESLint config integration is clear and accurate.
117-117: Approve comment style.The inline comment is clear and consistent with surrounding examples.
120-120: Approve comment style.This annotation is concise and informative.
126-126: Approve comment style.Clarity and tone match the rest of the configuration comments.
141-141: Approve snippet header.The comment clearly indicates CommonJS support. No change needed.
153-153: Approve project config comment.The explanation is precise and helps users understand the
projectoption.
158-158: Approve comment style.This inline note is concise and consistent.
161-161: Approve comment style.Clarity and brevity are maintained.
167-167: Approve comment style.The guidance is direct and clear.
208-208: Approve comment style.Clear instruction without ambiguity.
211-211: Approve comment style.The phrasing effectively communicates the intent.
217-217: Approve comment style.Good consistency with other list items.
235-235: Approve Bun resolution bullet.This bullet cleanly presents one configuration option.
236-236: Approve ESLint invocation bullet.Instructions are straightforward and correctly punctuated.
237-237: Approverun.bunconfiguration link bullet.The link and description are accurate and helpful.
|
Thanks for your contribution! |
Fixed the overall punctuation, typos, and the structure of a few sentences. Also, added installation commands with Bun.
Important
Improve
README.mdby fixing punctuation, typos, sentence structure, and adding Bun installation commands.README.md.README.md.This description was created by
for b8cd1bd. You can customize this summary. It will automatically update as commits are pushed.
Summary by CodeRabbit