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

webpack-path-resolve

v0.0.3

Published

A replacement for path.resolve that works with a mono-repo.

Downloads

104

Readme

webpack-path-resolve

Install

Install with npm: npm install --save-dev webpack-path-resolve

Install with yarn: yarn add webpack-path-resolve --dev

TL/DR

In a mono-repo, if some of your dependencies are hoisted, use this utility in your webpack.config.js.

//webpack.config.js
const path = require("path");
const webpackPath = require("webpack-path-resolve");
const resolve = webpackPath.resolve(require.resolve.paths);

//If "lodash" is hoisted...
resolve("lodash"); // returns the correct path
path.resolve("./node_modules/lodash"); // returns an incorrect path

Why do you need this?

If you do not use a monorepo, and if you do not use the yarn workspaces, you do not need this utility.

The Problem If however, you use a mono-repo with a yarn workspace (or pnpm), then yarn may hoist some of your dependencies to the root. Whether yarn will hoist a dependency such as lodash to the root of the mono-repo depends on whether a different version of that dependency is used by another package within the mono-repo. It is slightly unpredictable.

my-monorepo/
	node_modules/
		lodash@v1
	packages/
		package-a/
			node_modules/
				lodash@v2
			package.json
			webpack.config.js
		package-b/
			node_modules/
			package.json
			webpack.config.js
package.json
lerna.json
yarn.lock

This causes some issues with the webpack.config.js files. It is common practice to use in a webpack.config.js the notation path.resolve("./node_modules/lodash") when configuring a loader or an alias. But this notation will only work if the package is NOT hoisted.

The Solution

//webpack.config.js
import * as path from "path";
import * as webpackPath from "webpack-path-resolve";
const resolve = webpackPath.resolve(require.resolve.paths);

module.exports = {
  module: {
    rules: [
      {
        test: /\.js$/,
        include: [
          //path.resolve("./node_modules/lodash"); // INCORRECT: ./my-monorepo/packages/package-a/node_modules/lodash
          resolve("lodash"); // CORRECT: ./my-monorepo/node_modules/lodash
        ],
        use: ["source-map-loader"]
      }
    ],
    ...
  },
  ...
}

The utility webpack-path-resolve followed the typical nodejs module resolution process. It will scan recursively the following folders to find the dependency.

const resolve = webpackPath.resolve(require.resolve.paths);
resolve("lodash");
// This will scan the following folders for the lodash dependency.
// ./my-monorepo/packages/package-a/node_modules/lodash
// ./my-monorepo/packages/node_modules/lodash
// ./my-monorepo/node_modules/lodash
// ${HOME}/node_modules/lodash