JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 23182
  • Score
    100M100P100Q143632F
  • License MIT

Rollup plugin to automatically resolve TypeScript path aliases.

Package Exports

  • rollup-plugin-typescript-paths
  • rollup-plugin-typescript-paths/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (rollup-plugin-typescript-paths) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

rollup-plugin-typescript-paths

GitHub Workflow Status

Rollup Plugin to automatically resolve path aliases set in the compilerOptions section of tsconfig.json.

Don't use it if you're already using rollup-plugin-typescript. This plugin is only for use cases where your TypeScript code has already been transpiled before rollup runs.

For example, if you have

// tsconfig.json
{
  "compilerOptions": {
    // ...
    "baseUrl": ".",
    "paths": {
      "@utils": ["src/helpers/utils"]
    }
  }
}
import { something } from '@utils';

Then this plugin will make sure that rollup knows how to resolve @utils.

Features

  • No config required. 😎
  • Wildcards are supported. 💪
  • Uses nodeModuleNameResolver from the Typescript API. 🤓

Installation

npm install --save-dev rollup-plugin-typescript-paths

Usage

import { typescriptPaths } from 'rollup-plugin-typescript-paths';

export default {
  // ...
  plugins: [typescriptPaths()],
};

Options

  • absolute: Whether to resolve to absolute paths; defaults to true.
  • nonRelative: Whether to resolve non-relative paths based on tsconfig's baseUrl, even if none of the paths are matched; defaults to false.
  • preserveExtensions: Whether to preserve .ts and .tsx file extensions instead of having them changed to .js; defaults to false.
  • tsConfigPath: Custom path to your tsconfig.json. Use this if the plugin can't seem to find the correct one by itself.
  • transform: If the plugin successfully resolves a path, this function allows you to hook into the process and transform that path before it is returned.

License

MIT.