Skip to content

[Docs] no-restricted-paths: clarify wording and fix errors #3172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 20, 2025

Conversation

greim
Copy link
Contributor

@greim greim commented Mar 27, 2025

Some of the example paths don't match the file trees given. This also cleans up some of the file tree formatting and clarifies the wording to hopefully avoid confusion.

Copy link

codecov bot commented Mar 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.80%. Comparing base (6e49a58) to head (f82095e).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3172      +/-   ##
==========================================
+ Coverage   95.63%   95.80%   +0.16%     
==========================================
  Files          83       83              
  Lines        3690     3691       +1     
  Branches     1333     1334       +1     
==========================================
+ Hits         3529     3536       +7     
+ Misses        161      155       -6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@greim
Copy link
Contributor Author

greim commented Mar 28, 2025

Copy link
Member

@ljharb ljharb left a comment

Choose a reason for hiding this comment

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

Seems great. Thanks!

@ljharb ljharb changed the title Fix mistakes and clarify docs for no-restricted-paths [Docs] no-restricted-paths: clarify wording and fix errors Jun 20, 2025
@ljharb ljharb added the docs label Jun 20, 2025
@ljharb ljharb merged commit f017790 into import-js:main Jun 20, 2025
364 checks passed
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request Jun 22, 2025
| datasource | package              | from   | to     |
| ---------- | -------------------- | ------ | ------ |
| npm        | eslint-plugin-import | 2.31.0 | 2.32.0 |


## [v2.32.0](https://github.com/import-js/eslint-plugin-import/blob/HEAD/CHANGELOG.md#2320---2025-06-20)

##### Added

- add \[`enforce-node-protocol-usage`] rule and `import/node-version` setting (\[[#3024](import-js/eslint-plugin-import#3024)], thanks \[[@GoldStrikeArch](https://github.com/GoldStrikeArch)] and \[[@sevenc-nanashi](https://github.com/sevenc-nanashi)])
- add TypeScript types (\[[#3097](import-js/eslint-plugin-import#3097)], thanks \[[@G-Rath](https://github.com/G-Rath)])
- \[`extensions`]: add \`pathGroupOverrides to allow enforcement decision overrides based on specifier (\[[#3105](import-js/eslint-plugin-import#3105)], thanks \[[@Xunnamius](https://github.com/Xunnamius)])
- \[`order`]: add `sortTypesGroup` option to allow intragroup sorting of type-only imports (\[[#3104](import-js/eslint-plugin-import#3104)], thanks \[[@Xunnamius](https://github.com/Xunnamius)])
- \[`order`]: add `newlines-between-types` option to control intragroup sorting of type-only imports (\[[#3127](import-js/eslint-plugin-import#3127)], thanks \[[@Xunnamius](https://github.com/Xunnamius)])
- \[`order`]: add `consolidateIslands` option to collapse excess spacing for aesthetically pleasing imports (\[[#3129](import-js/eslint-plugin-import#3129)], thanks \[[@Xunnamius](https://github.com/Xunnamius)])

##### Fixed

- \[`no-unused-modules`]: provide more meaningful error message when no .eslintrc is present (\[[#3116](import-js/eslint-plugin-import#3116)], thanks \[[@michaelfaith](https://github.com/michaelfaith)])
- configs: added missing name attribute for eslint config inspector (\[[#3151](import-js/eslint-plugin-import#3151)], thanks \[[@NishargShah](https://github.com/NishargShah)])
- \[`order`]: ensure arcane imports do not cause undefined behavior (\[[#3128](import-js/eslint-plugin-import#3128)], thanks \[[@Xunnamius](https://github.com/Xunnamius)])
- \[`order`]: resolve undefined property access issue when using `named` ordering (\[[#3166](import-js/eslint-plugin-import#3166)], thanks \[[@Xunnamius](https://github.com/Xunnamius)])
- \[`enforce-node-protocol-usage`]: avoid a crash with some TS code (\[[#3173](import-js/eslint-plugin-import#3173)], thanks \[[@ljharb](https://github.com/ljharb)])
- \[`order`]: codify invariants from docs into config schema (\[[#3152](import-js/eslint-plugin-import#3152)], thanks \[[@Xunnamius](https://github.com/Xunnamius)])

##### Changed

- \[Docs] \[`extensions`], \[`order`]: improve documentation (\[[#3106](import-js/eslint-plugin-import#3106)], thanks \[[@Xunnamius](https://github.com/Xunnamius)])
- \[Docs] add flat config guide for using `tseslint.config()` (\[[#3125](import-js/eslint-plugin-import#3125)], thanks \[[@lnuvy](https://github.com/lnuvy)])
- \[Docs] add missing comma (\[[#3122](import-js/eslint-plugin-import#3122)], thanks \[[@RyanGst](https://github.com/RyanGst)])
- \[readme] Update flatConfig example to include typescript config (\[[#3138](import-js/eslint-plugin-import#3138)], thanks \[[@intellix](https://github.com/intellix)])
- \[Refactor] \[`order`]: remove unnecessary negative check (\[[#3167](import-js/eslint-plugin-import#3167)], thanks \[[@JounQin](https://github.com/JounQin)])
- \[Docs] \[`no-unused-modules`]: add missing double quote (\[[#3191](import-js/eslint-plugin-import#3191)], thanks \[[@albertpastrana](https://github.com/albertpastrana)])
- \[Docs] `no-restricted-paths`: clarify wording and fix errors (\[[#3172](import-js/eslint-plugin-import#3172)], thanks \[[@greim](https://github.com/greim)])
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants