import-js / eslint-plugin-import

ESLint plugin with rules that help validate proper imports.
MIT License
5.57k stars 1.57k forks source link

[Docs] `no-cycle`: add `disableScc` to docs #3070

Closed soryy708 closed 1 month ago

soryy708 commented 1 month ago

https://github.com/import-js/eslint-plugin-import/pull/2998 introduces a disableScc option to the no-cycle rule, but there's no reference to it in the rule's docs at https://github.com/import-js/eslint-plugin-import/blob/f72f2072f4245f2c3494816d7c14352fc9e07c0a/docs/rules/no-cycle.md

It's an error of omission, and we need to add it to the docs, so that users know about the escape hatch and what it does, without digging through issues/PRs about it.

Fixes #3063

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 94.94%. Comparing base (743ebca) to head (6218a8a). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #3070 +/- ## ========================================== - Coverage 95.13% 94.94% -0.20% ========================================== Files 82 82 Lines 3559 3559 Branches 1243 1243 ========================================== - Hits 3386 3379 -7 - Misses 173 180 +7 ``` | [Flag](https://app.codecov.io/gh/import-js/eslint-plugin-import/pull/3070/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=import-js) | Coverage Δ | | |---|---|---| | [](https://app.codecov.io/gh/import-js/eslint-plugin-import/pull/3070/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=import-js) | `94.94% <ø> (-0.20%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=import-js#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.