ts-paths-resolver

Translates typescript paths aliases into relative paths.

      

⚡ Usage

🔶 Install

1bun i -D ts-paths-resolver
2pnpm i -D ts-paths-resolver
3yarn add -D ts-paths-resolver
4npm i -D ts-paths-resolver

🔶 cli

1resolve-ts-paths -d [distPath] -tsc [tsconfigPath] -pj [packageJsonPath]
2
3Options:
4      --help     Show help                                             [boolean]
5      --version  Show version number                                   [boolean]
6  -d             The path to the repo                        [default: "./dist"]
7      --tsc      The height                         [default: "./tsconfig.json"]
8      --pj       The height                          [default: "./package.json"]
9
10Examples:
11  resolve-ts-paths -d ./dist -tsc ./tsconfig.json -pj ./package.json

🧿 cjs

1bun resolve-ts-paths -d ./dist -tsc ./tsconfig.json -pj ./package.json

🧿 esm

1bun resolve-ts-paths-esm -d ./dist -tsc ./tsconfig.json -pj ./package.json

🔶 node

1import { resolveTsPaths } from 'ts-paths-resolver';
2
3const distPath = './dist';
4const tsconfigPath = './tsconfig.json';
5const packageJsonPath = './package.json';
6
7await resolveTsPaths({
8  distPath,
9  tsconfigPath,
10  packageJsonPath,
11});

You can also import the effect:

1import { NodeFileSystem } from '@effect/platform-node';
2import { Effect, pipe } from 'effect';
3import { runPromise } from 'effect-errors';
4import { resolveTsPathsEffect } from 'ts-paths-resolver';
5
6await runPromise(
7  pipe(
8    resolveTsPathsEffect({
9      distPath: 'dist',
10      tsconfigPath: './tsconfig.json',
11      packageJsonPath: './package.json',
12    }),
13    Effect.provide(NodeFileSystem.layer)
14  )
15);

⚡ Required inputs

This module takes the following input to translate paths aliases import/require statements into relative paths within a folder.

🧿 dist folder

The transpiled code location.

🧿 tsconfig.json

• rootDir: Root folder within your source files.
• paths: 1 set of entries that re-map imports to additional lookup locations.

1{
2  "compilerOptions": {
3    // ...
4    "rootDir": "./src",
5    "paths": {
6      "@dependencies/*": ["./src/dependencies/*"],
7      "@regex": ["./src/util/regex/regex.ts"]
8    }
9  }
10}

🧿 package.json

• main: cjs entry point.
• module: esm entry point.
• types: declaration files entry point.

1{
2  "main": "./cjs/index.js",
3  "module": "./esm/index.js",
4  "types": "./dts/index.d.ts"
5  // ...
6}