{"id":19972613,"url":"https://github.com/jpb06/ts-paths-transform","last_synced_at":"2025-05-04T01:30:51.761Z","repository":{"id":38390564,"uuid":"499268925","full_name":"jpb06/ts-paths-transform","owner":"jpb06","description":"Transforming tsconfig paths for jest","archived":false,"fork":false,"pushed_at":"2024-10-10T16:45:46.000Z","size":218,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-23T03:46:13.919Z","etag":null,"topics":["jest","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jpb06.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-06-02T19:45:50.000Z","updated_at":"2024-10-10T16:45:49.000Z","dependencies_parsed_at":"2023-02-14T15:20:43.997Z","dependency_job_id":null,"html_url":"https://github.com/jpb06/ts-paths-transform","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpb06%2Fts-paths-transform","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpb06%2Fts-paths-transform/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpb06%2Fts-paths-transform/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpb06%2Fts-paths-transform/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jpb06","download_url":"https://codeload.github.com/jpb06/ts-paths-transform/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252276955,"owners_count":21722447,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jest","typescript"],"created_at":"2024-11-13T03:08:43.407Z","updated_at":"2025-05-04T01:30:51.265Z","avatar_url":"https://github.com/jpb06.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ts-paths-transform\n\n[![Open in Visual Studio Code](https://img.shields.io/static/v1?logo=visualstudiocode\u0026label=\u0026message=Open%20in%20Visual%20Studio%20Code\u0026labelColor=2c2c32\u0026color=007acc\u0026logoColor=007acc)](https://github.dev/jpb06/ts-paths-transform)\n![npm bundle size](https://img.shields.io/bundlephobia/min/ts-paths-transform)\n![Github workflow](https://img.shields.io/github/actions/workflow/status/jpb06/ts-paths-transform/tests-scan.yml?branch=main\u0026logo=github-actions\u0026label=last%20workflow)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=jpb06_ts-paths-transform)\n[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform\u0026metric=sqale_rating)](https://sonarcloud.io/dashboard?id=jpb06_ts-paths-transform)\n[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform\u0026metric=security_rating)](https://sonarcloud.io/dashboard?id=jpb06_ts-paths-transform)\n[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform\u0026metric=reliability_rating)](https://sonarcloud.io/dashboard?id=jpb06_ts-paths-transform)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform\u0026metric=coverage)](https://sonarcloud.io/dashboard?id=jpb06_ts-paths-transform)\n[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform\u0026metric=ncloc)](https://sonarcloud.io/summary/new_code?id=jpb06_ts-paths-transform)\n[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform\u0026metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=jpb06_ts-paths-transform)\n[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform\u0026metric=code_smells)](https://sonarcloud.io/dashboard?id=jpb06_ts-paths-transform)\n[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform\u0026metric=bugs)](https://sonarcloud.io/summary/new_code?id=jpb06_ts-paths-transform)\n[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform\u0026metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=jpb06_ts-paths-transform)\n![Snyk Vulnerabilities for npm package](https://img.shields.io/snyk/vulnerabilities/npm/ts-paths-transform?label=snyk%20vulnerabilities)\n[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=jpb06_ts-paths-transform\u0026metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=jpb06_ts-paths-transform)\n![Last commit](https://img.shields.io/github/last-commit/jpb06/ts-paths-transform?logo=git)\n\nA little helper transforming tsconfig paths to make jest config easier.\n\n\u003c!-- readme-package-icons start --\u003e\n\n\u003cp align=\"left\"\u003e\u003ca href=\"https://docs.github.com/en/actions\" target=\"_blank\"\u003e\u003cimg height=\"50\" src=\"https://raw.githubusercontent.com/jpb06/jpb06/master/icons/GithubActions-Dark.svg\" /\u003e\u003c/a\u003e\u0026nbsp;\u003ca href=\"https://www.typescriptlang.org/docs/\" target=\"_blank\"\u003e\u003cimg height=\"50\" src=\"https://raw.githubusercontent.com/jpb06/jpb06/master/icons/TypeScript.svg\" /\u003e\u003c/a\u003e\u0026nbsp;\u003ca href=\"https://nodejs.org/en/docs/\" target=\"_blank\"\u003e\u003cimg height=\"50\" src=\"https://raw.githubusercontent.com/jpb06/jpb06/master/icons/NodeJS-Dark.svg\" /\u003e\u003c/a\u003e\u0026nbsp;\u003ca href=\"https://bun.sh/docs\" target=\"_blank\"\u003e\u003cimg height=\"50\" src=\"https://raw.githubusercontent.com/jpb06/jpb06/master/icons/Bun-Dark.svg\" /\u003e\u003c/a\u003e\u0026nbsp;\u003ca href=\"https://biomejs.dev/guides/getting-started/\" target=\"_blank\"\u003e\u003cimg height=\"50\" src=\"https://raw.githubusercontent.com/jpb06/jpb06/master/icons/Biome-Dark.svg\" /\u003e\u003c/a\u003e\u0026nbsp;\u003ca href=\"https://github.com/conventional-changelog\" target=\"_blank\"\u003e\u003cimg height=\"50\" src=\"https://raw.githubusercontent.com/jpb06/jpb06/master/icons/CommitLint.Dark.svg\" /\u003e\u003c/a\u003e\u0026nbsp;\u003ca href=\"https://vitest.dev/guide/\" target=\"_blank\"\u003e\u003cimg height=\"50\" src=\"https://raw.githubusercontent.com/jpb06/jpb06/master/icons/Vitest-Dark.svg\" /\u003e\u003c/a\u003e\u003c/p\u003e\n\n\u003c!-- readme-package-icons end --\u003e\n\n## ⚡ Install\n\n```bash\nyarn add -D ts-paths-transform\n```\n\n## ⚡ But why?\n\nGrew tired of adding [`ts-jest`](https://github.com/kulshekhar/ts-jest) just to use its `pathsToModuleNameMapper` function.\n\n## ⚡ Scenario\n\nLet's imagine I want to test a Typescript codebase using jest. I'm using paths like so:\n\n👇 tsconfig.json\n\n```json\n{\n  [...]\n  \"compilerOptions\": {\n    \"baseUrl\": \".\",\n    \"paths\": {\n      \"@cool\": [\"src/cool/index.ts\"],\n      \"@api/*\": [\"src/api/*\"]\n    }\n  }\n}\n```\n\nNow in jest config, I could use the aforementioned `pathsToModuleNameMapper` function or set paths manually in `moduleNameMapper`:\n\n👇 jest.config.ts\n\n```typescript\nconst options: Config.InitialOptions = {\n  // [...]\n  moduleNameMapper: {\n    '^@cool$': 'src/cool/index.ts',\n    '^@api/(.*)$': 'src/api/$1',\n  },\n  transform: {\n    '^.+\\\\.[tj]sx?$': ['@swc/jest', {}],\n  },\n};\n```\n\nAnnoying 🥲\n\n## ⚡ Using `transformTsPaths` function\n\nLet's use the function this library exposes:\n\n👇 jest.config.ts\n\n```typescript\nimport { transformTsPaths } from `ts-paths-transform`;\n\nimport { compilerOptions } from './tsconfig.json';\n\nconst options: Config.InitialOptions = {\n  // [...]\n  moduleNameMapper: {\n    // [...]\n    ...transformTsPaths(compilerOptions.paths)\n  },\n  transform: {\n    '^.+\\\\.[tj]sx?$': ['@swc/jest', {}],\n  },\n};\n```\n\n### 🔶 Options\n\n`transformTsPaths` accepts a second argument for options:\n\n```typescript\nconst paths = transformTsPaths(compilerOptions.paths, {\n  prefix: 'blabla',\n  verbose: true,\n});\n```\n\n#### 🧿 `prefix` - string\n\nPrepends each path alias with a prefix:\n\n```typescript\nconst tsConfigPaths = {\n  '@cool': ['src/cool/index.ts'],\n  '@api/*': ['src/api/*'],\n};\nconst paths = transformTsPaths(tsConfigPaths, {\n  prefix: '\u003cRootDir\u003e/',\n});\n\n// Paths =\n//  '^@cool$': '\u003cRootDir\u003e/src/cool/index.ts',\n//  '^@api/(.*)$': '\u003cRootDir\u003e/src/api/$1',\n```\n\n#### 🧿 `verbose` - boolean\n\nDisplays transformed output:\n\n```typescript\nconst tsConfigPaths = {\n  '@cool': ['src/cool/index.ts'],\n  '@api/*': ['src/api/*'],\n};\nconst paths = transformTsPaths(tsConfigPaths, {\n  verbose: true,\n});\n```\n\n👇 output:\n\n```bash\nts-paths-transform 🚀 - 2 paths were found and transformed ✨\n  ^@cool$:                      src/cool/index.ts\n  ^@api/(.*)$:                  src/api/$1\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpb06%2Fts-paths-transform","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjpb06%2Fts-paths-transform","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpb06%2Fts-paths-transform/lists"}