Simple import sort
An ESLint plugin that automatically sorts imports and exports with a simple, opinionated approach.
What is Simple import sort?
eslint-plugin-simple-import-sort is an ESLint plugin that automatically sorts import and export statements in JavaScript and TypeScript code. It solves the problem of inconsistent import ordering by providing a simple, autofixable rule that integrates directly into ESLint workflows. The plugin groups imports logically and sorts them alphabetically, ensuring clean and maintainable codebases.
JavaScript and TypeScript developers who use ESLint and want to automate import sorting without configuring complex rules. It's ideal for teams seeking consistent code style with minimal setup.
Developers choose this plugin for its simplicity, reliability, and seamless autofix integration. Unlike more complex alternatives, it offers sensible defaults, handles edge cases like comments and TypeScript, and reduces merge conflicts by being git diff friendly.
Overview
Easy autofixable import sorting.
Use Cases
Best For
- Automatically sorting imports in ESLint-enabled projects
- Enforcing consistent import order across team codebases
- Reducing manual formatting work with autofix integration
- Handling TypeScript projects with type imports and exports
- Minimizing git diff noise by sorting on the `from` string
- Integrating with Prettier or dprint for comprehensive code formatting
Not Ideal For
- Projects still using CommonJS `require` statements extensively, as the plugin only supports ES module imports.
- Teams needing granular control over import ordering with multiple configuration options, such as custom sorting within groups or sorting by import names.
- Codebases where automatic grouping for exports is required, since exports rely on manual comments for grouping.
- Environments where sorting side effect imports is necessary, as they are intentionally kept in original order for safety.
Pros & Cons
Pros
Directly works with `eslint --fix` for automatic sorting, eliminating the need for separate tools and manual effort, as emphasized in the README's example usage.
Preserves comments during sorting and fully handles TypeScript, including type imports and exports, with examples provided in the README's sorting section.
Sorts based on the `from` string to minimize version control noise and reduce merge conflicts, a key feature explained under 'Why sort on from?' in the FAQ.
Offers a single but powerful `groups` option using regex patterns for defining import sections, allowing tailored grouping without complexity, as detailed in the Custom Grouping section.
Cons
Intentionally lacks support for CommonJS `require` statements, limiting usability in projects not yet migrated to ES modules, as admitted in the FAQ.
Only provides one option (`groups`) and fixed sorting rules within groups, which may not suffice for teams with complex or non-standard import ordering needs, as noted in the 'Not for everyone' section.
Requires manual comments to group exports, unlike imports which have automatic grouping, adding overhead for maintaining export organization.
Frequently Asked Questions
Related Projects
perfectionist sorting☂️ ESLint plugin for sorting various data such as objects, imports, types, enums, JSX props, etc.
filenamesEslint plugin to check filenames.
pathsA plugin for ESLint, to force use paths aliases from tsconfig
ESLint StylisticFormatting and stylistic ESLint core rules moved to this project and are maintained by the community
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.