npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

multi-tsconfig-paths-webpack-plugin

v1.0.0-alpha.2

Published

Use `paths` in tsconfig.json at each directories to let Webpack resolves files as expected.

Downloads

2

Readme

TSConfig Paths Webpack Plugin

Use paths in tsconfig.json at each directory to let Webpack resolve files as expected. It's like a plugin for aliases, but it's more powerful in the monorepo scenario.

Quick Start

Install the plugin using the package manager.

npm i -D multi-tsconfig-paths-webpack-plugin
yarn add -D multi-tsconfig-paths-webpack-plugin
pnpm i -D multi-tsconfig-paths-webpack-plugin

Add the plugin to your Webpack configuration.

const { MultiTsconfigPathsWebpackPlugin } = require('multi-tsconfig-paths-webpack-plugin');

module.exports = {
  resolve: {
    plugins: [
      new MultiTsconfigPathsWebpackPlugin({
        glob: '../../**/tsconfig.json', // depends on your project structure
      }),
    ],
  },
};

Why Use This Plugin?

In the monorepo scenario, you may have multiple tsconfig.json files in different directories. Each tsconfig.json file may have its own paths configuration. This plugin will help you resolve the files as expected.

For example, here is the project structure:

project
├── packages
│   ├── sub
│   │   ├── src
│   │   │   ├── bar.ts
│   │   │   └── index.ts
│   │   └── tsconfig.json
│   └── main
│       ├── src
│       │   ├── foo.ts
│       │   └── index.ts
│       ├── webpack.config.js
│       └── tsconfig.json
└── tsconfig.json

All tsconfig.jsons have the same baseUrl and paths configuration:

{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@/*": ["src/*"]
    }
  }
}

TypeScript respects the tsconfig.json in all directories. It will resolve the files as expected:

  • In the file /packages/main/src/index.ts, if you write import ... from '@/foo', TypeScript resolves the file to /packages/main/src/foo.ts.
  • In the file /packages/sub/src/index.ts, if you write import ... from '@/bar', TypeScript resolves the file to /packages/sub/src/bar.ts.

But Webpack aliases are globally set. If you set @ to /packages/main/src, it will resolve all @s to /packages/main/src. The @/bar will be resolved to /packages/main/src/bar.ts, not /packages/sub/src/bar.ts. That means even if you can Ctrl/Cmd + Click to jump to the file in your IDE, there are still errors in Webpack.

This plugin will help you resolve the files as expected. If you don't use monorepo, you can still use this plugin as a replacement for setting config.resolve.alias in Webpack config using tsconfig.json manually.

Don't worry, if your import path is not in the paths configuration, it will not be resolved by this plugin.

Development

pnpm i
pnpm start # go to http://localhost:3000 and see the console

License

MIT