Replace `find-pkg` and friends with `empathic` or `fd-package-json`

[43081j]

Packages such as these:

• find-pkg
  • replaced by pkg.up({ cwd })
• find-file-up
  • replaced by find.up(name, { cwd })
• find-up-simple
  • replaced by find.up(name, { cwd })
• find-up
  • replaced by find.up(name, { cwd })
• pkg-dir
  • replaced by dirname(pkg.up({ cwd }))
• find-cache-dir
  • replaced by pkg.cache
• find-cache-directory
  • replaced by pkg.cache
• read-package-up
  • replaced by empathic/package
  • replaced by empathic/package and pkg-types if you need strong types
• read-pkg
  • replaced by pkg-types
• read-pkg-up
  • replaced by empathic/package
  • replaced by empathic/package and pkg-types if you need strong types

and more, can all be replaced by empathic:

https://github.com/lukeed/empathic

this is much faster and usually smaller to install

empathic is ESM only. if that blocks us, we can use fd-package-json to find the closest package.json. but there is no obvious replacement for the generic case. you could use walk-up-path but would need more inline logic

with require(esm) being in all LTS of node now, we may be able to use empathic still if the projects have a high enough engine requirement

[talentlessguy]

find-pkg

#	Downloads	Traffic	Version	Package
1	4.50M	12.33 GB	^0.1.2	cwd
2	3.32M	9.08 GB	2.0.0	@module-federation/managers
3	3.31M	9.08 GB	2.0.0	@module-federation/manifest
4	2.95M	8.10 GB	2.0.0	@module-federation/third-party-dts-extractor
5	131.97k	361.60 MB	^2.0.0	load-pkg

find-file-up's only major dependent is find-pkg

find-up-simple

#	Downloads	Traffic	Version	Package
1	192.34M	500.84 GB	^1.0.0	pkg-dir
2	101.35M	263.91 GB	^1.0.0	read-pkg-up
3	8.02M	20.87 GB	^1.0.0	pkg-conf
4	5.50M	14.32 GB	^1.0.0	preferred-pm
5	3.19M	8.31 GB	^1.0.0	read-package-up
6	2.03M	5.29 GB	^1.0.0	cspell-gitignore
7	291.64k	759.43 MB	^1.0.0	package-config
8	289.38k	753.55 MB	^1.0.0	xo
9	130.27k	339.23 MB	^1.0.0	package-up
10	342	890.57 KB	^1.0.0	@flowr/eslint-config

find-up

#	Downloads	Traffic	Version	Package
1	148.02M	574.78 GB	^5.0.0	eslint
2	78.84M	306.14 GB	^4.1.0	@istanbuljs/load-nyc-config
3	29.83M	115.82 GB	^5.0.0	mocha
4	27.40M	106.40 GB	^6.2.0	pkg-up
5	14.34M	55.70 GB	^5.0.0	react-dev-utils
6	12.78M	49.62 GB	^4.1.0	nyc
7	11.38M	44.19 GB	^7.0.0	@commitlint/top-level
8	8.21M	31.90 GB	^5.0.0	@sentry/bundler-plugin-core
9	8.07M	31.34 GB	^5.0.0	@react-native-community/cli-tools
10	7.67M	29.78 GB	^5.0.0	@storybook/preset-react-webpack
11	6.95M	27.00 GB	^5.0.0	c8
12	6.49M	25.19 GB	^5.0.0	@storybook/cli
13	6.47M	25.13 GB	^5.0.0	@react-native-community/cli
14	5.03M	19.52 GB	^5.0.0	@storybook/react-vite
15	4.94M	19.19 GB	^4.1.0	@storybook/semver
16	3.69M	14.32 GB	^5.0.0	@storybook/nextjs
17	3.63M	14.11 GB	^5.0.0	expo-modules-autolinking
18	3.44M	13.37 GB	^5.0.0	@expo/package-manager
19	3.35M	13.03 GB	^5.0.0	pretty-quick
20	3.33M	12.93 GB	^5.0.0	@storybook/builder-webpack4
21	3.26M	12.65 GB	^5.0.0	@storybook/manager-webpack4
22	2.64M	10.25 GB	^5.0.0	@expo/xcpretty
23	2.49M	9.67 GB	^5.0.0	@expo/fingerprint
24	2.29M	8.88 GB	^5.0.0	@vanilla-extract/integration
25	2.08M	8.09 GB	^5.0.0	@storybook/manager-webpack5
26	1.85M	7.17 GB	^3.0.0	dotgitignore
27	1.77M	6.89 GB	^5.0.0	eslint-plugin-compat
28	1.60M	6.22 GB	^5.0.0	jest-expo
29	1.41M	5.46 GB	^5.0.0	standard-version
30	1.27M	4.93 GB	^5.0.0	@pnpm/find-workspace-dir
31	923.39k	3.59 GB	^5.0.0	@storybook/angular
32	841.06k	3.27 GB	^5.0.0	hardhat blocked by CommonJS
33	820.03k	3.18 GB	^6.0.0	@netlify/zip-it-and-ship-it
34	793.62k	3.08 GB	^5.0.0	prettier-eslint-cli
35	745.83k	2.90 GB	^5.0.0	detox
36	685.30k	2.66 GB	^5.0.0	@embroider/macros
37	657.53k	2.55 GB	6.3.0	@cypress/webpack-dev-server
38	617.81k	2.40 GB	^3.0.0	libnpmconfig
39	605.84k	2.35 GB	^2.1.0	magicli
40	594.29k	2.31 GB	5.0.0	renovate
41	591.82k	2.30 GB	^2.1.0	codeowners
42	583.62k	2.27 GB	5.0.0	orval
43	572.74k	2.22 GB	^6.0.0	@netlify/config
44	526.16k	2.04 GB	^5.0.0	ember-cli
45	501.70k	1.95 GB	5.0.0	@lerna/legacy-package-management
46	500.23k	1.94 GB	^5.0.0	@linaria/utils
47	487.45k	1.89 GB	^7.0.0	@eslint/config-inspector
48	486.24k	1.89 GB	^5.0.0	@electron-forge/core
49	481.10k	1.87 GB	^5.0.0	@electron-forge/core-utils
50	461.08k	1.79 GB	^5.0.0	ember-compatibility-helpers

pkg-dir

#	Downloads	Traffic	Version	Package
1	109.10M	219.72 GB	^7.0.0	find-cache-dir
2	86.81M	174.84 GB	^4.2.0	import-local
3	5.32M	10.72 GB	<6 >=5	find-yarn-workspace-root2
4	2.91M	5.87 GB	^7.0.0	@pulumi/pulumi
5	1.96M	3.94 GB	5.0.0	@appium/support
6	1.46M	2.93 GB	^5.0.0	node-stdlib-browser
7	1.21M	2.44 GB	5.0.0	@appium/docutils
8	958.06k	1.93 GB	^5.0.0	npm-check
9	737.03k	1.48 GB	^3.0.0	hard-source-webpack-plugin
10	723.76k	1.46 GB	^4.2.0	yarn-or-npm

read-package-up

#	Downloads	Traffic	Version	Package
1	9.47M	22.61 GB	^11.0.0	@semantic-release/release-notes-generator
2	8.61M	20.56 GB	^11.0.0	semantic-release
3	5.45M	13.02 GB	^11.0.0	@cucumber/cucumber
4	5.08M	12.13 GB	^11.0.0	@netlify/functions
5	4.11M	9.80 GB	^11.0.0	yeoman-generator
6	3.73M	8.92 GB	^11.0.0	@google-cloud/functions-framework
7	2.19M	5.22 GB	11.0.0	netlify
8	904.88k	2.16 GB	^11.0.0	np
9	843.46k	2.01 GB	^11.0.0	@netlify/build
10	798.92k	1.91 GB	11.0.0	netlify-cli
11	768.95k	1.84 GB	^11.0.0	@ui5/project
12	702.26k	1.68 GB	^11.0.0	@netlify/framework-info
13	364.90k	871.03 MB	^11.0.0	textlint
14	115.35k	275.33 MB	^11.0.0	@google/clasp
15	97.06k	231.68 MB	^11.0.0	storyblok
16	87.44k	208.73 MB	^11.0.0	prisma-lint
17	73.93k	176.47 MB	11.0.0	@guardian/eslint-config
18	70.52k	168.32 MB	^11.0.0	hot-hook
19	63.47k	151.50 MB	^11.0.0	eslint-plugin-fsecond
20	49.26k	117.59 MB	^11.0.0	pastel
21	48.50k	115.78 MB	^11.0.0	@sofie-automation/code-standard-preset

read-pkg

#	Downloads	Traffic	Version	Package
1	163.44M	425.59 GB	^9.0.0	read-pkg-up
2	16.87M	43.94 GB	^3.0.0	npm-run-all
3	10.40M	27.08 GB	^9.0.0	read-package-up
4	9.00M	23.43 GB	^9.0.0	@semantic-release/npm
5	7.20M	18.75 GB	^8.1.0	write-pkg
6	3.56M	9.27 GB	^5.1.1	@vue/cli-shared-utils
7	2.81M	7.32 GB	5.2.0	@appium/support
8	1.55M	4.02 GB	5.2.0	@appium/docutils
9	904.88k	2.36 GB	^9.0.1	np
10	768.95k	2.00 GB	^9.0.1	@ui5/project
11	625.30k	1.63 GB	^9.0.0	@netlify/build-info
12	454.83k	1.18 GB	^8.1.0	secretlint
13	349.28k	909.54 MB	^5.2.0	semantic-release-monorepo
14	305.42k	795.31 MB	^3.0.0	rollup-plugin-auto-external
15	113.89k	296.56 MB	^2.0.0	jest-json-reporter
16	99.22k	258.36 MB	^1.1.0	yarn-run-all
17	87.92k	228.94 MB	*	@types/read-pkg
18	86.52k	225.31 MB	^9.0.1	write-package
19	75.60k	196.85 MB	^5.1.1	pkg-add-deps
20	69.48k	180.92 MB	^5.0.0	can-npm-publish
21	63.63k	165.69 MB	^2.0.0	autodll-webpack-plugin
22	48.65k	126.70 MB	^5.2.0	10up-toolkit
23	48.05k	125.13 MB	^3.0.0	jest-nunit-reporter
24	34.56k	89.99 MB	^9.0.1	list-installed
25	34.26k	89.22 MB	^5.2.0	deps
26	32.51k	84.65 MB	^8.0.0	semantic-release-yarn
27	31.26k	81.40 MB	^3.0.0	find-plugins
28	30.02k	78.17 MB	^5.2.0	ntl
29	29.01k	75.55 MB	^9.0.1	read-workspaces
30	28.21k	73.47 MB	5.x	@openshift-console/dynamic-plugin-sdk-webpack
31	27.91k	72.69 MB	^5.1.1	icon-set-creator
32	25.68k	66.87 MB	^9.0.1	bingo
33	25.60k	66.67 MB	^5.0.0	@colbyfayock/semantic-release-pnpm
34	24.73k	64.41 MB	^5.2.0	react-native-test-runner
35	20.75k	54.05 MB	5.2.0	@snaplet/snapshot
36	19.61k	51.07 MB	^9.0.1	@polkadot-api/cli
37	17.91k	46.65 MB	^5.2.0	ts-node-test-register
38	15.71k	40.91 MB	^9.0.1	opticks-cli
39	12.07k	31.42 MB	^3.0.0	semantic-release-verify-deps
40	11.85k	30.85 MB	^4.0.0	npm-publish-git-tag
41	11.22k	29.21 MB	^3.0.0	@s-ui/mono
42	10.59k	27.57 MB	^2.0.0	bolt

read-pkg-up

#	Downloads	Traffic	Version	Package
1	4.85M	11.48 GB	^7.0.1	@storybook/manager-webpack4
2	3.08M	7.31 GB	^10.0.0	@wdio/cli
3	2.86M	6.78 GB	^7.0.1	@storybook/manager-webpack5
4	1.46M	3.46 GB	^7.0.1	is-file-esm
5	1.14M	2.71 GB	^7.0.1	yo
6	1.07M	2.53 GB	^7.0.0	tsd
7	977.80k	2.32 GB	^7.0.1	@storybook/addon-storyshots
8	953.03k	2.26 GB	^2.0.0	get-package-info
9	829.63k	1.97 GB	^7.0.1	@bugsnag/source-maps
10	805.42k	1.91 GB	7.0.1	@strapi/strapi
11	783.60k	1.86 GB	^7.0.1	sanity
12	567.96k	1.35 GB	7.0.1	@sap-ux/nodejs-utils
13	537.26k	1.27 GB	^7.0.1	bundlewatch
14	534.94k	1.27 GB	^9.1.0	hugo-extended
15	417.89k	990.39 MB	^9.1.0	documentation
16	372.89k	883.75 MB	^7.0.1	@wordpress/scripts
17	328.56k	778.68 MB	^7.0.1	playroom
18	264.66k	627.25 MB	^7.0.1	unimported
19	228.51k	541.57 MB	^7.0.1	cz-emoji
20	168.99k	400.51 MB	7.0.1	koa2-swagger-ui
21	128.56k	304.69 MB	^11.0.0	marked-man
22	126.00k	298.62 MB	^6.0.0	eslint-plugin-monorepo-cop
23	123.07k	291.68 MB	^7.0.1	eslint-config-atomic
24	113.86k	269.85 MB	^10.1.0	gltfjsx
25	112.77k	267.26 MB	7.0.1	@prisma/sdk
26	106.14k	251.54 MB	^7.0.1	eslint-config-kentcdodds

find-cache-dir

#	Downloads	Traffic	Version	Package
1	36.11M	105.79 GB	^2.0.0	@babel/register
2	27.78M	81.39 GB	^3.2.0	nyc
3	16.72M	48.98 GB	^3.3.1	@storybook/react-docgen-typescript-plugin
4	7.78M	22.79 GB	*	@types/find-cache-dir
5	5.08M	14.89 GB	^3.3.2	rollup-plugin-typescript2
6	4.55M	13.32 GB	^3.3.1	eslint-loader
7	3.63M	10.65 GB	^3.0.0	cache-loader
8	3.43M	10.04 GB	^0.1.1	loader-fs-cache
9	3.10M	9.09 GB	^3.3.2	mongodb-memory-server-core
10	2.64M	7.74 GB	^3.3.1	gh-pages
11	2.57M	7.53 GB	^2.1.0	uglifyjs-webpack-plugin
12	1.88M	5.52 GB	^3.3.1	react-docgen-typescript-plugin
13	1.24M	3.63 GB	^3.3.2	gatsby
14	1.06M	3.12 GB	^2.0.0	hard-source-webpack-plugin
15	515.63k	1.51 GB	^5.0.0	xo
16	459.51k	1.35 GB	^3.3.2	@tamagui/static
17	441.20k	1.29 GB	^4.0.0	import-jsx
18	423.28k	1.24 GB	^3.1.0	@bundle-stats/cli-utils
19	412.69k	1.21 GB	^3.2.0	@isaacs/import-jsx
20	324.03k	949.40 MB	^5.0.0	storybook-builder-rsbuild

[rubiesonthesky]

Changing from find-up to find-up-simple halves the size of used library. Of course, if it's only used for finding package.json then changing to fd-package-json or similar could be better.

[talentlessguy]

Also to note, Node.js is shipping findPackageJSON soon

nodejs/node#55412

would be useful for packages targeting node 22.x and higher

[talentlessguy]

Update: findPackageJSON is available since 22.14: nodejs/node#56910 (though the API is unstable)

[43081j]

we can also replace find-cache-dir with pkg.cache from empathic

that should give us a lot of easy replacements to do

[43081j]

ok the big ones seem to be:

• babel-loader uses find-up
• c8 uses find-up
• nyc uses find-cache-dir
• @babel/register uses find-cache-dir
• eslint-loader uses find-cache-dir
• @storybook/react-docgen-typescript-plugin uses find-cache-dir

all of these should be replaceable with empathic

and some more packages to find dependents of:

• find-up-simple
• find-cache-directory

[beeequeue]

c8 has said they're not interested in replacing find-up, but maybe someone else can help convince them

bcoe/c8#559 (comment)

---

Storybook is WIP, but I'm kind of lost on how to debug the current issues in it due to the large codebase

storybookjs/storybook#31338

[43081j]

ah! I didn't realise you already had an open PR for storybook

if we split it up into a PR per monorepo package, it will be a lot easier

maybe we can split your PR up, or use the ones I pushed?

[beeequeue]

i would say split the PR by replaced package, as most other than find-up are only used in one place or so

i organized the commits to be fairly isolated, so cherry picking them should be fairly straight forward

[43081j]

I have opened eslint/eslint#19696

Also mochajs/mocha#5359

[voxpelli]

I did the home work this project should have done before starting to bother projects with minuscule performance gains: mochajs/mocha#5346 (comment)

See my full comparison in that issue.

[43081j]

we did the work 👍 a performance gain is a gain.

your findings show us it is indeed faster. until it ships CJS, it may be slightly larger on disk than some alternatives but that was needed for adoption in some mocha-sized projects which can't yet bump engine constraint.

[voxpelli]

My findings also included vital benchmark inaccuracies (apart from the fact that its benchmarked on Deno, not on Node.js) and functional differences (matching both files and directories to the name, not just files or directories as eg. find-up + some questions on how it handles symlinks):

The find.any is compared to findUpMultipleSync rather than the findUp.sync(exports.CONFIG_FILES, {cwd}) that's actually used: https://github.com/mochajs/mocha/blob/5730dfcf11e4cd48ba2b24601eaadf34a5c9b1a9/lib/cli/config.js#L95

This is a vital difference as findUpMultipleSync by default returns all matched paths whereas findUp.sync only returns the first one matched.

There are also other subtle differences:

• find-up uses fs.statSync / fs.lstatSync whereas empathic uses fs.existsSync
• findUpMultipleSync.sync in the benchmarking is configured to do the non-default allowSymlinks: false even though fs.existsSync does follow symlinks
• find-up as well as locate-path is designed to ensure to only match files or only directories, defaulting to files. empathic seems to do no such checks, creating a regression if there's any directory that has the desired name. Of course its quicker to not check if its a file or directory, but better? I wouldn't argue that.