Import Sort Babylon Parser

Common errors

• SyntaxError: Unexpected token (X:Y)

  cause The Babel parser used by `import-sort-parser-babylon` did not recognize a specific language feature (e.g., new syntax, TypeScript, JSX) because the corresponding plugin was not enabled in the configuration.
  fix Add the required Babel parser plugin (e.g., `jsx`, `typescript`, `decorators-legacy`) to the `parserOptions.plugins` array in your `importSort` configuration within `package.json` or `.importsortrc`.

• parser.parseImports is not a function

  cause The `import-sort` core or integration could not find or correctly load the parser function from `import-sort-parser-babylon`, possibly due to incorrect module resolution or a corrupted installation.
  fix Ensure `import-sort-parser-babylon` is correctly installed and listed in your project dependencies. Verify your `importSort` configuration specifies `'babylon'` as the parser name, and restart any IDE extensions or CLI processes to reload the configuration.

• Configuration error: Unknown parser 'babylon'

  cause The `import-sort` tool itself (or its CLI/IDE integration) failed to locate the `import-sort-parser-babylon` package, often due to an incorrect package name in the configuration or an incomplete installation.
  fix Double-check that `import-sort-parser-babylon` is installed in your project and that your `importSort` configuration correctly specifies `parser: 'babylon'` (or similar, depending on the exact `import-sort` configuration structure).

Warnings

• breaking The underlying parser 'babylon' was renamed to '@babel/parser'. While 'import-sort-parser-babylon' might abstract this, direct usage or advanced configuration might require referencing '@babel/parser' features or plugins.
  Fix: Ensure your Babel configuration (if separate) is updated to use `@babel/parser`. If passing `parserOptions` directly to `import-sort`, ensure plugin names align with `@babel/parser`'s expected values. Review `prettier-plugin-sort-imports` migration guides for common parser option changes.
• gotcha Incorrect or missing Babel parser plugins in your `import-sort` configuration can lead to parsing errors for modern JavaScript or TypeScript syntax (e.g., decorators, class properties).
  Fix: Always explicitly define necessary Babel plugins within the `parserOptions.plugins` array in your `.importsortrc` or `package.json` configuration, matching the features used in your codebase. Refer to `@babel/parser` documentation for available plugins.
• gotcha Conflicting import sorting rules from other tools like ESLint (`sort-imports`) or Prettier plugins can lead to formatting churn or unexpected behavior.
  Fix: Disable or remove competing import sorting rules in ESLint or Prettier when `import-sort` is active, allowing `import-sort` to be the single source of truth for import ordering.
• gotcha When using `import-sort` within a broader toolchain (e.g., with Prettier v3.x or pnpm), ensure compatibility and correct plugin resolution, as some users have reported issues with specific package managers or tool versions.
  Fix: Verify `import-sort` and its parsers are correctly installed and resolvable by your toolchain. Check for any specific setup instructions or known issues related to your package manager (like pnpm) or other formatting tools in the `import-sort` or `prettier-plugin-sort-imports` repositories.

Install

• npm install import-sort-parser-babylon npm
• yarn add import-sort-parser-babylon yarn
• pnpm add import-sort-parser-babylon pnpm

Imports

• default
  wrong:

  const babylonParser = require('import-sort-parser-babylon');

  correct:

  import babylonParser from 'import-sort-parser-babylon';

  The primary export is typically a default parser configuration or function, consumed by the 'import-sort' core. While modern configurations prefer ESM, CommonJS `require` might still function in older Node.js environments if the package provides dual exports.
• ImportSortParser

  import type { ImportSortParser } from 'import-sort-parser-babylon';

  This package ships TypeScript types. The type definition for the parser interface is useful for custom integrations or understanding the expected structure.

Quickstart

This configuration snippet for `.importsortrc` or `package.json` demonstrates how to instruct `import-sort` to use the `babylon` parser for various file types and configure Babel parser options for modern syntax support.

{
  "importSort": {
    "language": "javascript",
    ".js, .jsx, .ts, .tsx": {
      "parser": "babylon",
      "style": "eslint",
      "options": {
        "parserOptions": {
          "ecmaVersion": "latest",
          "sourceType": "module",
          "plugins": [
            "jsx",
            "typescript",
            "classProperties",
            "decorators-legacy",
            "dynamicImport"
          ]
        }
      }
    }
  }
}