tsconfig-paths
Advanced tools
Package description
The tsconfig-paths npm package is used to map module paths based on the paths defined in the tsconfig.json file. This allows TypeScript developers to use custom path mappings to simplify imports in their projects. It is particularly useful for avoiding relative path hell and for making the codebase cleaner and more maintainable.
Custom Path Mapping
This feature allows you to map paths in your TypeScript project so that you can import modules using aliases instead of relative paths. The code sample demonstrates how to register custom path mappings using the tsconfig-paths package.
require('tsconfig-paths').register({ baseUrl: './', paths: { '@app/*': ['./src/app/*'] } });Integration with Node.js
This feature enables you to integrate tsconfig-paths with Node.js so that when you run your TypeScript-compiled JavaScript files, the custom paths are resolved correctly. The code sample shows how to run a Node.js application with tsconfig-paths support using the -r (require) flag.
node -r tsconfig-paths/register src/server.tsCommand Line Interface
tsconfig-paths provides a CLI tool called tsconfig-paths-bootstrap that can be used to bootstrap the path mappings before running your application. This is useful when you want to ensure that the path mappings are applied before any module resolution takes place.
tsconfig-paths-bootstrapmodule-alias is a package that allows you to create aliases for directories and register custom module paths. It is similar to tsconfig-paths but does not rely on the tsconfig.json file for configuration. Instead, you define aliases directly in your package.json or through API calls.
babel-plugin-module-resolver is a Babel plugin that allows you to add custom path resolutions to your project. It is similar to tsconfig-paths in that it helps you avoid relative paths, but it is configured through Babel's configuration file and is typically used in conjunction with Babel's transpilation process.
webpack-alias is a package that provides similar functionality to tsconfig-paths but is specifically designed for use with Webpack. It allows you to define aliases and custom paths in your Webpack configuration, which can simplify imports and make them more readable.
Changelog
[0.4.0] - 2016-12-30
tsocnfig-paths.Readme
Use this to load modules whose location is specified in the paths section of tsconfig.json. Both loading at run-time and via API are supported.
yarn add --dev tsconfig-paths
or
npm install --save-dev tsconfig-paths
node -r tsconfig-paths/register main.js
ts-node -r tsconfig-paths/register main.ts
mocha --compilers ts:ts-node/register -r tsconfig-paths/register
The API consists of these functions:
createMatchPath(tsConfigPath, baseUrl, paths)This function will create a function that can match paths. It accepts baseUrl and paths directly as they are specified in tsconfig and will handle resolving paths to absolute form. The created function has this signature: matchPath(absoluteSourceFileName: string, requestedModule: string)
matchFromAbsolutePaths(absolutePaths, absoluteSourceFileName, requestedModule)This function is lower level and requries that the paths as already been resolved to absolute form.
FAQs
Load node modules according to tsconfig paths, in run-time or via API.
We found that tsconfig-paths demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 14 open source maintainers 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
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.