Skip to content
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

added rule import/no-extraneous-dependencies to docs #2748

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

meddy672
Copy link

@meddy672 meddy672 commented Mar 23, 2023

Added the eslint rule import/no-extraneous-dependencies to the modules section. Fixes #2727


```

<a name="modules--import/no-extraneous-dependencies"></a><a name="10.11"></a>
Copy link
Collaborator

Choose a reason for hiding this comment

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

new sections don't get numbered links.

Suggested change
<a name="modules--import/no-extraneous-dependencies"></a><a name="10.11"></a>
<a name="modules--import/no-extraneous-dependencies"></a>

<a name="modules--import/no-extraneous-dependencies"></a><a name="10.11"></a>

- [10.11](#modules--import/no-extraneous-dependencies) Forbid the use of extraneous packages.
eslint: [`import/no-extraneous-dependencies`](https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-extraneous-dependencies.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
eslint: [`import/no-extraneous-dependencies`](https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-extraneous-dependencies.md)
eslint: [`import/no-extraneous-dependencies`](https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-extraneous-dependencies.md)

Comment on lines +1483 to +1490
// Not declared in package.json - es6.js
import es6 from 'es6';
const es6 = require('es6');

// good
// Declared in package.json es6.js
import es6 from 'es6';
const es6 = require('es6');
Copy link
Collaborator

Choose a reason for hiding this comment

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

let's use a package name someone's actually likely to use here.

but also, i'm not sure how helpful this example is since it's not showing package.json. but maybe that'd be overkill?

Copy link

Choose a reason for hiding this comment

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

I added this lint rule in our project when someone tried to use "axios" without mentioning it in package.json. That can be used as an example.

@ljharb ljharb marked this pull request as draft May 15, 2023 17:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for 'import/no-extraneous-dependencies' is missing
3 participants