# ts-paths-transform

> [![Open in Visual Studio Code](https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20in%20Visual%20Studio%20Code&labelColor=2c2c32&color=007acc&logoColor=007acc)](https://github.dev/jpb06/ts-paths-transform) ![npm bundle size](https

Latest version **2.0.23** (published 2026-01-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install ts-paths-transform
pnpm add ts-paths-transform
yarn add ts-paths-transform
bun add ts-paths-transform
```

## Health

**Score 65/100 (B)** — status: stable.

Positive: has types; no vulnerabilities; has provenance; high maintenance score; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 2.0.23 |
| Published | 2026-01-22 |
| First published | 2022-06-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 14.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 3 |
| Author | jpb06 |
| Maintainers | jpb06 |

## Links

- npm: https://www.npmjs.com/package/ts-paths-transform
- Repository: https://github.com/jpb06/ts-paths-transform
- Homepage: https://github.com/jpb06/ts-paths-transform#readme
- Issues: https://github.com/jpb06/ts-paths-transform/issues
- npm.io page: https://npm.io/package/ts-paths-transform

## Dependencies (2)

- [picocolors](https://npm.io/package/picocolors.md) 1.1.1
- [prettyjson](https://npm.io/package/prettyjson.md) 1.2.5

## Recent versions

- 2.0.23 (latest) — 2026-01-22
- 2.0.10 — 2025-10-31
- 2.0.9 — 2025-10-31
- 2.0.8 — 2025-09-07
- 2.0.7 — 2025-07-05
- 2.0.6 — 2025-06-21
- 2.0.5 — 2024-10-10
- 2.0.4 — 2024-05-24
- 2.0.3 — 2023-01-26
- 2.0.2 — 2022-11-13
- 2.0.1 — 2022-11-13
- 2.0.0 — 2022-08-30
- 1.0.6 — 2022-07-17
- 1.0.5 — 2022-07-17
- 1.0.4 — 2022-06-05
- … 3 more at https://npm.io/package/ts-paths-transform/versions

## README

# ts-paths-transform

[![Open in Visual Studio Code](https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20in%20Visual%20Studio%20Code&labelColor=2c2c32&color=007acc&logoColor=007acc)](https://github.dev/jpb06/ts-paths-transform)
![npm bundle size](https://img.shields.io/bundlephobia/min/ts-paths-transform)
![Github workflow](https://img.shields.io/github/actions/workflow/status/jpb06/ts-paths-transform/tests-scan.yml?branch=main&logo=github-actions&label=last%20workflow)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=jpb06_ts-paths-transform)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=jpb06_ts-paths-transform)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform&metric=security_rating)](https://sonarcloud.io/dashboard?id=jpb06_ts-paths-transform)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=jpb06_ts-paths-transform)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform&metric=coverage)](https://sonarcloud.io/dashboard?id=jpb06_ts-paths-transform)
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=jpb06_ts-paths-transform)
[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=jpb06_ts-paths-transform)
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform&metric=code_smells)](https://sonarcloud.io/dashboard?id=jpb06_ts-paths-transform)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform&metric=bugs)](https://sonarcloud.io/summary/new_code?id=jpb06_ts-paths-transform)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=jpb06_ts-paths-transform)
![Snyk Vulnerabilities for npm package](https://img.shields.io/snyk/vulnerabilities/npm/ts-paths-transform?label=snyk%20vulnerabilities)
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=jpb06_ts-paths-transform)
![Last commit](https://img.shields.io/github/last-commit/jpb06/ts-paths-transform?logo=git)

A little helper transforming tsconfig paths to make jest config easier.

<!-- readme-package-icons start -->

<p align="left"><a href="https://docs.github.com/en/actions" target="_blank"><img height="50" width="50" src="https://raw.githubusercontent.com/jpb06/jpb06/master/icons/GithubActions-Dark.svg" /></a>&nbsp;<a href="https://www.typescriptlang.org/docs/" target="_blank"><img height="50" width="50" src="https://raw.githubusercontent.com/jpb06/jpb06/master/icons/TypeScript.svg" /></a>&nbsp;<a href="https://nodejs.org/en/docs/" target="_blank"><img height="50" width="50" src="https://raw.githubusercontent.com/jpb06/jpb06/master/icons/NodeJS-Dark.svg" /></a>&nbsp;<a href="https://bun.sh/docs" target="_blank"><img height="50" width="50" src="https://raw.githubusercontent.com/jpb06/jpb06/master/icons/Bun-Dark.svg" /></a>&nbsp;<a href="https://biomejs.dev/guides/getting-started/" target="_blank"><img height="50" width="50" src="https://raw.githubusercontent.com/jpb06/jpb06/master/icons/Biome-Dark.svg" /></a>&nbsp;<a href="https://github.com/conventional-changelog" target="_blank"><img height="50" width="50" src="https://raw.githubusercontent.com/jpb06/jpb06/master/icons/CommitLint.Dark.svg" /></a>&nbsp;<a href="https://vitest.dev/guide/" target="_blank"><img height="50" width="50" src="https://raw.githubusercontent.com/jpb06/jpb06/master/icons/Vitest-Dark.svg" /></a></p>

<!-- readme-package-icons end -->

## ⚡ Install

```bash
yarn add -D ts-paths-transform
```

## ⚡ But why?

Grew tired of adding [`ts-jest`](https://github.com/kulshekhar/ts-jest) just to use its `pathsToModuleNameMapper` function.

## ⚡ Scenario

Let's imagine I want to test a Typescript codebase using jest. I'm using paths like so:

👇 tsconfig.json

```json
{
  [...]
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@cool": ["src/cool/index.ts"],
      "@api/*": ["src/api/*"]
    }
  }
}
```

Now in jest config, I could use the aforementioned `pathsToModuleNameMapper` function or set paths manually in `moduleNameMapper`:

👇 jest.config.ts

```typescript
const options: Config.InitialOptions = {
  // [...]
  moduleNameMapper: {
    '^@cool$': 'src/cool/index.ts',
    '^@api/(.*)$': 'src/api/$1',
  },
  transform: {
    '^.+\\.[tj]sx?$': ['@swc/jest', {}],
  },
};
```

Annoying 🥲

## ⚡ Using `transformTsPaths` function

Let's use the function this library exposes:

👇 jest.config.ts

```typescript
import { transformTsPaths } from `ts-paths-transform`;

import { compilerOptions } from './tsconfig.json';

const options: Config.InitialOptions = {
  // [...]
  moduleNameMapper: {
    // [...]
    ...transformTsPaths(compilerOptions.paths)
  },
  transform: {
    '^.+\\.[tj]sx?$': ['@swc/jest', {}],
  },
};
```

### 🔶 Options

`transformTsPaths` accepts a second argument for options:

```typescript
const paths = transformTsPaths(compilerOptions.paths, {
  prefix: 'blabla',
  verbose: true,
});
```

#### 🧿 `prefix` - string

Prepends each path alias with a prefix:

```typescript
const tsConfigPaths = {
  '@cool': ['src/cool/index.ts'],
  '@api/*': ['src/api/*'],
};
const paths = transformTsPaths(tsConfigPaths, {
  prefix: '<rootDir>/',
});

// Paths =
//  '^@cool$': '<rootDir>/src/cool/index.ts',
//  '^@api/(.*)$': '<rootDir>/src/api/$1',
```

#### 🧿 `verbose` - boolean

Displays transformed output:

```typescript
const tsConfigPaths = {
  '@cool': ['src/cool/index.ts'],
  '@api/*': ['src/api/*'],
};
const paths = transformTsPaths(tsConfigPaths, {
  verbose: true,
});
```

👇 output:

```bash
ts-paths-transform 🚀 - 2 paths were found and transformed ✨
  ^@cool$:                      src/cool/index.ts
  ^@api/(.*)$:                  src/api/$1
```

---
_Source: https://npm.io/package/ts-paths-transform · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
