Lisba/prettier-plugin-unused-imports-configurable

README

prettier-plugin-unused-imports-configurable

A Prettier plugin to remove unused imports from JavaScript and TypeScript modules, configurable to ignore specified folders.

Characteristics

Automatically cleans up unused imports: Detects and removes unused imports during code formatting.
Merges duplicate imports: Unifies imports from the same source to reduce redundant import statements.
Configurable for specific needs: Allows ignoring directories to avoid modifying imports in sensitive areas, making it ideal for monorepos or customized workflows.
Supports exclusion comments: Skips cleaning files with the // prettier-ignore-unused-imports-configurable comment placed above the first import declaration.
Handles complex import scenarios: Includes support for namespace imports import * as React from 'react', alias imports import { Component as Comp } from 'library', and qualified usages React.useEffect().
Works seamlessly with formatOnSave: Automatically applies unused import cleanup when you save your file if this option is enabled in your editor.
Extensive test coverage: Achieves more than 80% test coverage, ensuring reliability across all its features.

Content

prettier-plugin-unused-imports-configurable

Installation

npm: npm install --save-dev prettier-plugin-unused-imports-configurable

pnpm: pnpm add -D prettier-plugin-unused-imports-configurable

yarn: yarn add -D prettier-plugin-unused-imports-configurable

Configuration

In your .prettierrc config file add the following to start using the plugin:

{
  // ...other rules,
  "plugins": ["prettier-plugin-unused-imports-configurable"]
}

To ignore specific folders add its paths to the ignoredDirectories array:

{
  // ...other rules,
  "plugins": ["prettier-plugin-unused-imports-configurable"],
  "ignoreDirectories": ["src/specific-folder"]
}

You can also ignore specific files based on an exclusion comment. It could be on the first line of the file or among other comments, but it must be before the first import declaration:

  // prettier-ignore-unused-imports-configurable
  import { something } from 'somewhere';
  ...other imports

Usage

It works when prettier is used either by CLI (prettier --write .) or when you save your changes if formatOnSave option is activated in your editor.

Collaborate

In order to collaborate with the project you should:

Fork the repo.
Clone the repo to work locally with git clone repo-url.
Install dependencies with pnpm install.
Develop suggested changes in a new branch (make sure you are using the prettier config, you can run pnpm format or install the prettier extension if you are using vsc editor to format on save).
Run pnpm test to verify your changes doesn't have major bugs.
Push your changes to your repo git push [remote-repo-alias] [branch-name].
Make a pull request to the original repo.

NOTE: To make sure your changes behave as expected it is recommended to install the plugin in another project throught pmpn link. With pnpm you only need to pnpm add -D local/path-to/your-folder/prettier-plugin-unused-imports-configurable and that would be enought to use your local version of the plugin in your consumer project. You can check it looking inside the node_modules folder as any other package or running the commnad ls -l node_modules/prettier-plugin-unused-imports-configurable with a response similar yo prettier-plugin-unused-imports-configurable -> ~/Path-to/your-local-folder/prettier-plugin-unused-imports-configurable.

License

The MIT License. Full License here