ts-transform-paths

Use this to load modules whose location is specified in the paths section of tsconfig.json.

Install

1yarn add ts-transform-paths -D

Requirement

ts-transform-paths^2.0.0 for TypeScript^2.0.0 or TypeScript^3.0.0 ts-transform-paths^3.0.0 for TypeScript^4.0.0

How to use

Unfortunately, TypeScript itself does not currently provide any easy way to use custom transformers (See https://github.com/Microsoft/TypeScript/issues/14419). The followings are the example usage of the custom transformer.

tsconfig.json

1{
2  "compilerOptions": {
3    "paths": {
4      "@schema": ["./src/schema"],
5      "@modules/*": ["./src/modules/*"]
6    }
7  }
8}

webpack (with ts-loader or awesome-typescript-loader)

1// webpack.config.js
2const pathsTransformer = require("ts-transform-paths").default;
3
4module.exports = {
5  // ...
6  module: {
7    rules: [
8      {
9        test: /\.ts$/,
10        loader: "ts-loader", // or 'awesome-typescript-loader'
11        options: {
12          getCustomTransformers: (program) => pathsTransformer()
13        }
14      }
15    ]
16  }
17};

Rollup (with rollup-plugin-typescript2)

1// rollup.config.js
2import typescript from "rollup-plugin-typescript2";
3import pathsTransformer from "ts-transform-paths";
4
5export default {
6  // ...
7  plugins: [
8    typescript({
9      transformers: [
10        (service) => pathsTransformer()
11      ]
12    })
13  ]
14};

ttypescript

See ttypescript's README for how to use this with module bundlers such as webpack or Rollup.

1// tsconfig.json
2{
3  "compilerOptions": {
4    // ...
5    "plugins": [{ "transform": "ts-transform-paths" }]
6  }
7  // ...
8}

ts-node

1// my-ts-script.ts
2import { MyClass } from "@schema";
3
4const myClass = new MyClass("Message");

1// index.js
2const pathsTransformer = require("ts-transform-paths").default;
3
4require("ts-node").register({
5  transformers: pathsTransformer()
6});
7
8require("./my-ts-script");

1yarn node ./index.js

Thanks

• tsconfig-paths
• ts-transform-img
• ts-transformer-keys