Import Sort Parser for TypeScript

6.0.0 · maintenance · verified Sun Apr 19

import-sort-parser-typescript is a specialized parser module designed for the import-sort ecosystem, specifically to handle TypeScript and TSX files. It leverages the native TypeScript compiler for syntax parsing, enabling import sorting based on the TypeScript language rules. As a component, it is typically used in conjunction with `import-sort`, `import-sort-config`, and a chosen sorting style. The package is currently at version 6.0.0, but was last published approximately 7 years ago, suggesting a maintenance or possibly abandoned status rather than active development. Its primary differentiation lies in using the TypeScript parser directly, which historically provided accurate parsing for TypeScript-specific constructs, but its age raises concerns about compatibility with recent TypeScript versions and features. Release cadence is effectively halted given its last update.

Common errors

```
SyntaxError: Unexpected token '...', '...' expected (or similar parsing errors for new TS syntax)
```
cause Using `import-sort-parser-typescript` (last updated 7 years ago) with a modern TypeScript codebase that utilizes recent language features not understood by the outdated parser.

fix Downgrade your TypeScript version (not recommended) or, preferably, switch to a more modern import sorting tool or plugin that is actively maintained and supports your current TypeScript version. Refer to the warnings for alternatives.
```
Error: Unknown parser: "import-sort-parser-typescript"
```
cause Incorrectly specifying the parser in your `import-sort` configuration by using the full package name instead of the designated alias.

fix In your `importSort` configuration (e.g., in `package.json` or `.importsortrc.json`), ensure the parser is specified as `"parser": "typescript"` (the alias) and not `"parser": "import-sort-parser-typescript"`.

Warnings

breaking The package `import-sort-parser-typescript` has not been updated in approximately 7 years (last published Feb 16, 2019). This means it likely does not support newer TypeScript syntax features (e.g., decorators, new module resolutions, syntax additions in TS 4.x and 5.x) which can lead to parsing errors or incorrect sorting for modern TypeScript codebases.
Fix: Consider migrating to a more actively maintained import sorting solution that natively supports recent TypeScript versions, such as `@trivago/prettier-plugin-sort-imports`, `eslint-plugin-simple-import-sort`, or configuring ESLint's `sort-imports` rule with `@typescript-eslint/parser`.
gotcha This package is a parser for the `import-sort` ecosystem, not a standalone tool. It must be used with `import-sort` (e.g., via `import-sort-cli` or an editor extension) and configured to specify the 'typescript' parser. Direct programmatic use for parsing outside of the `import-sort` runner is uncommon.
Fix: Ensure you have `import-sort` and a runner (like `import-sort-cli`) installed and configured your `package.json` or `.importsortrc.json` to use `"parser": "typescript"` for your TypeScript files.
deprecated Given its age, the `import-sort` ecosystem itself might be considered deprecated by many modern TypeScript workflows in favor of built-in editor features, Prettier plugins, or ESLint rules for import sorting.
Fix: Explore native VS Code features ('Organize Imports'), Prettier plugins (e.g., `@trivago/prettier-plugin-sort-imports`), or ESLint rules (`sort-imports` with `@typescript-eslint/parser`) for potentially more robust and actively maintained import sorting solutions.

Install

npm install import-sort-parser-typescript npm
yarn add import-sort-parser-typescript yarn
pnpm add import-sort-parser-typescript pnpm

Imports

parser
wrong:
```
import { parser } from 'import-sort-parser-typescript';
```
correct:
```
import parser from 'import-sort-parser-typescript';
```
The package exports a default `parser` object, which is then passed to the main `import-sort` library for processing.
Parser Configuration
wrong:
```
"parser": "import-sort-parser-typescript"
```
correct:
```
{
  "importSort": {
    "parser": "typescript"
  }
}
```
When configuring `import-sort` in `package.json` or `.importsortrc.json`, you specify the parser name ('typescript'), not the package name directly.

Quickstart

Demonstrates how to integrate `import-sort-parser-typescript` into a project's `package.json` for automatic import sorting with the `import-sort` CLI tool. It sets up the necessary dependencies and configures `import-sort` to use the 'typescript' parser for .ts and .tsx files.

{
  "name": "my-project",
  "version": "1.0.0",
  "description": "Example project using import-sort with TypeScript",
  "main": "index.js",
  "scripts": {
    "sort-imports": "import-sort -l"
  },
  "devDependencies": {
    "import-sort": "^5.0.0",
    "import-sort-cli": "^6.0.0",
    "import-sort-config": "^6.0.0",
    "import-sort-parser-typescript": "^6.0.0",
    "import-sort-style-renke": "^6.0.0",
    "typescript": "^4.0.0" 
  },
  "importSort": {
    "\.ts$": {
      "parser": "typescript",
      "style": "renke"
    },
    "\.tsx?$": {
      "parser": "typescript",
      "style": "renke"
    }
  }
}

// To use this, save the above as package.json, then run:
// npm install
// npm run sort-imports

view raw JSON →