README.md

Vue Unused Components Checker

Check your Vue project for unused Components.

This tool gathers all file names of .vue Components and check whether they are imported and used somewhere.

Purpose

To help eliminate dead code in your Vue project, this package scans your codebase for components that have not been imported anywhere and thus are unused, so you can spot and remove them easily.

Installation

You should have node and npm or yarn installed.

$ npm install vue-unused-components-checker -g

Basic Usage

Check the current file tree

$ check-unused-comp .

Check a specific folder

$ check-unused-comp src/js

Limit the count of open files, since this can lead to errors, when directories are too large

$ check-unused-comp -o 20 src/js

Ignore specific files using glob patterns. Default: **/{node_modules,.nuxt,dist,coverage}/**

$ check-unused-comp -i **/node_modules/** src/js

Documentation

Refer to the basic instructions above. More thorough documentation will be added asap.

Changelog

For a list of changes, please refer to the CHANGELOG.

Contributions

Contributions are more than welcome, check our CONTRIBUTING Guide.

License

MIT licensed.