resolve-tspaths
Advanced tools
If you use Typescript's
path mapping
feature to avoid ../../../../../ in your imports, you may have found that
compiling with tsc doesn't convert your aliases to proper relative paths. This
causes problems as the compiled JavaScript code can't actually run with those
path aliases - you'll get a "module not found" error. If your project exports
type definitions, your .d.ts files will also be broken if they are shipped
with path aliases.
Use this package after tsc builds your code to replace any path aliases with
relative paths - this means that you can develop using path aliases whilst still
being able to ship working JavaScript code.
Sample tsconfig.json:
{
"compilerOptions": {
"paths": {
"~/*": ["./src/*"]
}
},
}
The following types of paths are currently supported:
CommonJS imports
const { ... } = require("~/some/path");
ESM imports
import * as stuff from "~/some/path";
import stuff from "~/some/path";
import { stuff } from "~/some/path.js";
import { stuff as myStuff } from "~/some/path.mjs";
import data from "~/some/data/path.json";
NOTE: When importing JSON files, ensure that you use the .json extension. See
issue #253.
ESM dynamic imports
const stuff = await import("~/some/path");
ESM exports
export * from "~/some/path";
export * as stuff from "~/some/path";
export { stuff } from "~/some/path.js";
export { stuff as myStuff } from "~/some/path.mjs";
Node.JS require.resolve
const path = require.resolve("~/some/path");
Install as a dev dependency using npm or yarn, along with Typescript 3.x or later.
yarn add -D resolve-tspaths typescript
npm install --save-dev resolve-tspaths typescript
Add it as a part of your build script in package.json after tsc.
{
"scripts": {
"build": "tsc && resolve-tspaths"
}
}
Install as a dev dependency using npm or yarn, along with Typescript 3.x or later.
yarn add -D resolve-tspaths typescript
npm install --save-dev resolve-tspaths typescript
Import the resolveTsPaths function and call it with the appropriate
options.
import { resolveTsPaths } from "resolve-tspaths";
resolve-tspaths uses some reasonable defaults. For most cases, you probably
won't need to specify any options.
--project <path>, -p <path>Specify the path to the tsconfig file that the program should use. Defaults to "tsconfig.json" if not provided.
--src <path>, -s <path>Specify the source directory. Defaults to compilerOptions.rootDir from your
tsconfig if not provided. If rootDir is not defined in your tsconfig, it will
default to "src".
--out <path>, -o <path>Specify the output directory of the compiled code where resolve-tspaths should
perform its changes. Defaults to compilerOptions.outDir from your tsconfig if
not provided.
--ext <extension...>Provide a space-delimited list of file extensions in the output directory that the program should process. Defaults to the following extensions:
jsmjscjsd.tsd.mtsd.cts--verboseUse this flag to print verbose logs to the console.
This option is only available when using the CLI.
--noEmitUse this flag to not emit any changes to your files. Recommended to be used with
--verbose for debugging which files the program will change if you don't use
--noEmit.
This option is only available when using the CLI.
tsconfig-paths is a runtime dependency. resolve-tspaths is used at build
time, which means your shipped code doesn't need to have this package
included, and can run natively using Node or in the browser.
Performs the same function as tscpaths - but that project is no longer
maintained. A pain point with that package was also that it no control over the
logging which was extremely verbose. resolve-tspaths provides several more
options for better control, and it's also well tested.
This project was heavily inspired by
tscpaths by joonhocho, but it is sadly
no longer maintained. My first attempt at building this library was based on a
fork of tscpaths. Since the project has matured, it was moved out to its own
repository.
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome! Please follow the contributing guidelines.
See LICENSE.
<small>0.8.23 (2024-11-28)</small>
FAQs
Transform path mappings in your compiled Typescript code
The npm package resolve-tspaths receives a total of 25,095 weekly downloads. As such, resolve-tspaths popularity was classified as popular.
We found that resolve-tspaths demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
