https://github.com/simonhaenisch/rollup-plugin-typescript-paths

Rollup Plugin to automatically resolve path aliases set in the compilerOptions section of tsconfig.json.
https://github.com/simonhaenisch/rollup-plugin-typescript-paths

rollup-plugin typescript typescript-paths

Last synced: 28 minutes ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/simonhaenisch/rollup-plugin-typescript-paths
• Owner: simonhaenisch
• License: mit
• Created: 2019-05-21T10:01:49.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-02-24T23:03:30.000Z (10 months ago)
• Last Synced: 2024-05-01T22:40:34.866Z (8 months ago)
• Topics: rollup-plugin, typescript, typescript-paths
• Language: TypeScript
• Homepage: https://npmjs.com/rollup-plugin-typescript-paths
• Size: 47.9 KB
• Stars: 44
• Watchers: 3
• Forks: 12
• Open Issues: 5
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# rollup-plugin-typescript-paths

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/simonhaenisch/rollup-plugin-typescript-paths/main.yml)](https://github.com/simonhaenisch/rollup-plugin-typescript-paths/actions?query=branch%3Amaster)

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](https://github.com/rollup/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

```js

// tsconfig.json

{

  "compilerOptions": {

    // ...

    "baseUrl": ".",

    "paths": {

      "@utils": ["src/helpers/utils"]

    }

  }

}

```

```js

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

```js

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](https://www.typescriptlang.org/docs/handbook/module-resolution.html#relative-vs-non-relative-module-imports) 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](/license).