prettier-plugin-import-sort

0.0.7 verified Sat Apr 25 auth: no javascript deprecated

A Prettier plugin (v0.0.7, no recent releases) that integrates import-sort into Prettier to automatically sort JavaScript and TypeScript import statements. It requires import-sort style modules like import-sort-style-module and is configured via package.json or config files. The plugin acts as a bridge, applying import-sort's sorting logic during Prettier formatting. It is unmaintained since 2020 and users are advised to migrate to alternatives like @trivago/prettier-plugin-sort-imports or eslint-plugin-import for active support.

Common errors

error Error: Cannot find module 'import-sort-style-module' ↓

cause Missing the import-sort style package in node_modules.

fix

Run: npm install -D import-sort-style-module

error Ignored unknown option {plugins} ↓

cause Prettier version < 2.0 does not support plugins array in config.

fix

Upgrade Prettier to >= 2.0 or use prettier.resolveConfig.sync() method.

error Cannot read property 'sort' of undefined ↓

cause importSort configuration is malformed or missing, causing import-sort to fail.

fix

Check that 'importSort' key in package.json has correct structure with file extension mapping.

error No parser and no filepath given, using 'babel' ↓

cause Prettier cannot determine file type; needed for import-sort plugin.

fix

Ensure you are formatting a file with an appropriate extension (.js, .ts, etc.) or specify --parser.

Warnings

deprecated This plugin is no longer maintained. Consider using @trivago/prettier-plugin-sort-imports. ↓

fix Replace with @trivago/prettier-plugin-sort-imports or eslint-plugin-import.

gotcha importSort silently falls back to default configuration on setup errors, making debugging difficult. ↓

fix Ensure extension list in importSort config is exactly '.js, .jsx, .ts, .tsx' (commas and spaces). Avoid patterns like '*.js'.

gotcha Fails silently if no import-sort style module is installed; no warnings are shown. ↓

fix Install a style module (e.g., import-sort-style-module) and verify by running Prettier with --log-level debug.

gotcha TypeScript-specific parser may be required for advanced syntax like decorators, but misconfiguration goes unnoticed. ↓

fix Add 'parser': 'typescript' to importSort config if using TypeScript with decorators.

breaking Not compatible with Prettier v3+ due to internal plugin system changes. ↓

fix Use a Prettier v2-compatible version or switch to a maintained plugin.

Install

npm install prettier-plugin-import-sort

yarn add prettier-plugin-import-sort

pnpm add prettier-plugin-import-sort

Imports

default

wrong

import prettierPluginImportSort from 'prettier-plugin-import-sort';

correct

No import statement needed; plugin is auto-detected by Prettier.

Prettier plugins are not imported in code; they are listed in .prettierrc or detected automatically when installed.

require('prettier-plugin-import-sort')
wrong
```
const plugin = require('prettier-plugin-import-sort');
```
correct
```
No require needed; plugin auto-loads.
```
Prettier discovers plugins via node_modules; no explicit require is correct.
plugins in .prettierrc
wrong
```
{
  "plugins": ["prettier-plugin-import-sort", {}]
}
```
correct
```
{
  "plugins": ["prettier-plugin-import-sort"]
}
```
Plugin is a string, not an object. This is for .prettierrc JSON; plugins key is used to explicitly list plugins.

Quickstart

Shows setup and usage: install deps, configure importSort style and Prettier plugin, then format a file to sort imports.

// Install dependencies
npm install -D prettier prettier-plugin-import-sort import-sort-style-module

// package.json configuration
{
  "importSort": {
    ".js, .jsx, .ts, .tsx": {
      "style": "module"
    }
  },
  "prettier": {
    "plugins": ["prettier-plugin-import-sort"]
  }
}

// Example input file
import { z } from 'z';
import { a } from 'a';

// Run Prettier
npx prettier --write input.js

// Sorted output
import { a } from 'a';
import { z } from 'z';