Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonnyburger/eslint-plugin-small-import
ESLint rule for preventing the full import of big libraries when just a part of it can be imported.
https://github.com/jonnyburger/eslint-plugin-small-import
eslint eslint-plugin lodash
Last synced: about 2 months ago
JSON representation
ESLint rule for preventing the full import of big libraries when just a part of it can be imported.
- Host: GitHub
- URL: https://github.com/jonnyburger/eslint-plugin-small-import
- Owner: JonnyBurger
- License: mit
- Created: 2019-12-14T18:44:02.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2019-12-14T20:18:01.000Z (about 5 years ago)
- Last Synced: 2024-10-26T22:25:20.571Z (2 months ago)
- Topics: eslint, eslint-plugin, lodash
- Language: TypeScript
- Homepage:
- Size: 2.69 MB
- Stars: 10
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-plugin-small-import
ESLint rule for preventing the full import of big libraries when just a part of it can be imported.
## Installation
```
npm i eslint-plugin-small-import
```
Add this to your `.eslintrc` or your config::
```json
"plugins": ["small-import"],
"rules": {
"small-import/no-full-import": "error"
}
```
## Disallow full import (no-full-import)
Some JavaScript libraries are a vast collection of independent helpers functions which are combined in one package, such as [`lodash`](https://lodash.com) or [`date-fns`](https://date-fns.org/). If you import one of their functions, you usually import the full suite of functions, causing higher memory consumption, startup time and bundle sizes.
The solution for this problem is to import each function directly from it's location in the package rather than the index file of the package. However, it is more tedious since more code has to be written.
### Rule details
This rule will automatically detect these cases and convert the imports. It supports `lodash`, `date-fns` and `rambda`
out of the box, but can be configured to support more libraries as well.
### Options
A map of packages can be supplied, where the keys are the names of the libraries and the values are the location of the distinct functions within the package. More practically, the values determine what gets put inbetween the package name and the function name. The default configuration is:
```json
["error", {
"packages": {
"lodash": "/",
"date-fns": "/",
"rambda": "/src/"
}
}]
```
### Examples
Examples of **correct** code for this rule:
```js
import sortBy from 'lodash/sortBy'
import groupBy from 'lodash/groupBy'
import format from 'date-fns/format'
import append from 'rambda/src/append'
```
Examples of **incorrect** code for this rule:
```js
import {sortBy, groupBy} from 'lodash'
import {format} from 'date-fns'
import {append} from 'rambda'
```
### When Not To Use It
If your application is not sensitive to memory consumption, startup time or bundle size, e.g. in a script, then you can disable this rule.
If you are not using the `import` syntax yet, it's not supported by this rule.
If you don't use packages which would cause this problem, you can disable this rule.
### Related rules
- [eslint-plugin-lodash/import-scope](https://github.com/wix/eslint-plugin-lodash/blob/HEAD/docs/rules/import-scope.md)
### License
MIT
## Author
© [Jonny Burger](https://jonny.io)