Home
Docs
GitHub
Pricing
Blog
Log In

Run Sandworm Audit for your App

Get started
Generated on Jul 10, 2024 via pnpm

tsconfig-paths-webpack-plugin 4.1.0

Load modules according to tsconfig paths in webpack.
Package summary
Share
0
issues
2
licenses
13
MIT
1
ISC
Package created
10 Jul 2017
Version published
11 Jul 2023
Maintainers
14
Total deps
14
Direct deps
3
License
MIT

Issues

0
This package has no issues

Licenses

MIT License

Permissive
OSI Approved
This is a human-readable summary of (and not a substitute for) the license. Disclaimer.
Can
commercial-use
modify
distribute
sublicense
private-use
Cannot
hold-liable
Must
include-copyright
include-license
13 Packages, Including:
ansi-styles@4.3.0
chalk@4.1.2
color-convert@2.0.1
color-name@1.1.4
enhanced-resolve@5.17.0
has-flag@4.0.0
json5@2.2.3
minimist@1.2.8
strip-bom@3.0.0
supports-color@7.2.0
tapable@2.2.1
tsconfig-paths-webpack-plugin@4.1.0
tsconfig-paths@4.2.0

ISC License

Permissive
OSI Approved
This is a human-readable summary of (and not a substitute for) the license. Disclaimer.
Can
commercial-use
modify
distribute
Cannot
hold-liable
Must
include-copyright
include-license
1 Packages, Including:
graceful-fs@4.2.11
Disclaimer

This deed highlights only some of the key features and terms of the actual license. It is not a license and has no legal value. You should carefully review all of the terms and conditions of the actual license before using the licensed material.

Sandworm is not a law firm and does not provide legal services. Distributing, displaying, or linking to this deed or the license that it summarizes does not create a lawyer-client or any other relationship.

Direct Dependencies

3
All Dependencies CSV
β“˜ This is a list of tsconfig-paths-webpack-plugin 's direct dependencies. Data on all dependencies, including transitive ones, is available via CSV download.
NameVersionSizeLicenseTypeVulnerabilities
chalk4.1.211.31 kBMIT
prod
enhanced-resolve5.17.0205.24 kBMIT
prod
tsconfig-paths4.2.041.6 kBMIT
prod

Visualizations

Frequently Asked Questions

What does tsconfig-paths-webpack-plugin do?

The tsconfig-paths-webpack-plugin is a potent tool for developers working with TypeScript and Webpack. Its primary function is to load modules whose location is specified in the paths section of tsconfig.json when using Webpack. In other words, it serves as a Webpack plugin that offers the functionality provided by the tsconfig-paths package. This eliminates the need to add alias entries in the webpack.config.js file that match the paths in your tsconfig.json, as the plugin automatically generates these alias entries for you.

How do you use tsconfig-paths-webpack-plugin?

To utilize the tsconfig-paths-webpack-plugin, developers need to follow specific steps. Initially, it has to be installed. This can be done via yarn using yarn add --dev tsconfig-paths-webpack-plugin or through npm by typing npm install --save-dev tsconfig-paths-webpack-plugin.

Secondly, in the Webpack configuration file, you need to add the plugin:

const TsconfigPathsPlugin = require('tsconfig-paths-webpack-plugin');

module.exports = {
  ...
  resolve: {
    plugins: [new TsconfigPathsPlugin({/* options: see below */})]
  }
  ...
}

Please note that the plugin must be placed in the resolve.plugins section of the configuration. Also, if you're using the allowJs in tsconfig.json or allowing other non-TS extensions in Webpack, ensure you set the extensions option in sync with your Webpack config. Various other options provide customization and better functionality control.

Where are the tsconfig-paths-webpack-plugin docs?

The detailed documentation for the tsconfig-paths-webpack-plugin can be found within its repository on GitHub. The README file from the repo provides comprehensive information about installation steps, usage, options available for configuration, instructions for testing, TypeScript support, and more. The URL is https://github.com/dividab/tsconfig-paths-webpack-plugin. It is worth noting that the package comes with TypeScript typings for added convenience when working with TypeScript within the Webpack config.