Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yamafaktory/shrimpit
Shrimpit 🍤 is a small CLI analysis tool for checking unused JavaScript, JSX & Vue templates ES6 exports in your project.
https://github.com/yamafaktory/shrimpit
es6 export exports import imports javascript jsx modules tool vuejs
Last synced: 3 months ago
JSON representation
Shrimpit 🍤 is a small CLI analysis tool for checking unused JavaScript, JSX & Vue templates ES6 exports in your project.
- Host: GitHub
- URL: https://github.com/yamafaktory/shrimpit
- Owner: yamafaktory
- License: mit
- Archived: true
- Created: 2016-12-11T23:04:52.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-22T11:57:17.000Z (5 months ago)
- Last Synced: 2024-09-22T15:47:50.875Z (4 months ago)
- Topics: es6, export, exports, import, imports, javascript, jsx, modules, tool, vuejs
- Language: JavaScript
- Homepage:
- Size: 1.48 MB
- Stars: 258
- Watchers: 6
- Forks: 16
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Shrimpit :fried_shrimp: [](https://github.com/yamafaktory/shrimpit/actions) [](https://www.npmjs.com/package/shrimpit) [](http://standardjs.com/)
Shrimpit is a small CLI analysis tool for checking unused JavaScript, JSX & Vue templates ES6 exports in your project.
## Install
### npm
```shell
npm i -g shrimpit
```
### yarn
```shell
yarn global add shrimpit
```
## Usage
```shell
shrimpit path/to/your/files /another/path
```
Globbing patterns are also supported:
```shell
shrimpit test/**/*.js
```
Adding the `--tree` flag will output the complete files tree with all the imports and the exports per file:
```shell
shrimpit --tree path/to/your/files
```
Please note that default unnamed exports are rendered as `default (unnamed)`:
```shell
shrimpit test --tree
Shrimpit!
> Files tree
{ test:
{ core:
{ a:
{ 'a.js':
{ imports:
[ { location: 'test/core/b/b.js',
name: 'test',
unnamedDefault: true },
{ location: 'test/core/b/b.js',
name: 'a',
unnamedDefault: false },
{ location: 'test/core/c/c.js',
name: 'User',
unnamedDefault: true } ],
exports:
[ { location: 'test/core/a/a.js',
name: 'a',
unnamedDefault: false },
{ location: 'test/core/a/a.js',
name: 'c',
unnamedDefault: false },
{ location: 'test/core/a/a.js', name: 'd', unnamedDefault: true } ] } },
b:
{ 'b.js':
{ imports:
[ { location: 'test/core/c/c.js',
name: 'Cat',
unnamedDefault: false },
{ location: 'test/core/d/d.js',
name: 'unamedFunction',
unnamedDefault: true },
{ location: 'test/core/a/a.js',
name: 'a',
unnamedDefault: false },
{ location: 'test/core/a/a.js',
name: 'c',
unnamedDefault: false },
{ location: 'test/core/a/a.js', name: 'd', unnamedDefault: true } ],
exports:
[ { location: 'test/core/b/b.js',
name: 'a',
unnamedDefault: false },
{ location: 'test/core/b/b.js',
name: 'b',
unnamedDefault: false },
{ location: 'test/core/b/b.js',
name: 'default (unnamed)',
unnamedDefault: true } ] } },
c:
{ 'c.js':
{ imports:
[ { location: 'test/core/a/a.js',
name: 'a',
unnamedDefault: false },
{ location: 'test/core/a/a.js',
name: 'c',
unnamedDefault: false },
{ location: 'test/core/a/a.js',
name: 'd',
unnamedDefault: false },
{ location: 'test/core/b/b.js',
name: 'b',
unnamedDefault: false } ],
exports:
[ { location: 'test/core/c/c.js',
name: 'Cat',
unnamedDefault: false },
{ location: 'test/core/c/c.js',
name: 'User',
unnamedDefault: true } ] } },
d:
{ 'd.js':
{ imports: [],
exports:
[ { location: 'test/core/d/d.js',
name: 'test/core/d',
unnamedDefault: true } ] } } } } }
> Unused exports
All Clear Ahead, Captain.
```
## Flow & Vue
Shrimpit supports [Flow annotations](https://flowtype.org/) and Vue templates out of the box!
# TypeScript (experimental)
Since Babel 7, the TypeScript AST can directly be parsed. You can use the `--typescript` flag to enable it:
```shell
shrimpit --tree --typescript path/to/your/files
```
Please note that the Flow and TypeScript parsers are mutually exclusive.
## Linting
The code quality is checked by the [JavaScript Standard Style](http://standardjs.com/).
## License
Released under the [MIT license](https://opensource.org/licenses/MIT) by Davy Duperron.