npx link
A safer version of npm link.
Why is npm link unsafe? Read the blog post.
Features
-
🔗 Link dependencies without removing previous links -
🛡 Only resolves to local paths -
🔥 Config file quickly linking multiple packages -
💫 Deep linking for quickling linking multilple packages
Usage
npx link simply symlinks the target package as a dependency in the current project.
Unlike npm link, it doesn't install the target package globally or re-install project dependencies.
From the project you want to link a package to:
npx link <package-path>
Configuration file
Create a link.config.json configuration file at the root of your npm project to automatically setup links to multiple packages.
Example link.config.json:
{
"packages": [
"/path/to/package-path-a",
"../package-path-b"
]
}
The configuration has the following type schema:
type LinkConfig = {
// Whether to run link on linked packages with link.config.json
deepLink?: boolean
// List of packages to link
packages?: string[]
}
Note: It's not recommended to commit this file to source control since this is for local development with local paths.
To link the dependencies defined in link.config.json, run:
npx link
Deep linking
By default, npx link only links packages in the current project. However, there are cases where the linked packages also needs linking setup.
Deep linking recursively runs link on every linked package that has a link.config.json file.
Enable with the --deep flag or deepLink property in link.config.json.
npx link --deep
FAQ
Why should I use this over npm link?
Because npm link has footguns that make it dangerous to use.
Why does npx link point to ln?
You must use npx v7 or higher. Check the version with npx -v.
In the obsolete npx v6, local binaries take precedence over npm modules so npx link can point to the native link/ln command:
$ npx link
usage: ln [-s [-F] | -L | -P] [-f | -i] [-hnv] source_file [target_file]
ln [-s [-F] | -L | -P] [-f | -i] [-hnv] source_file ... target_dir
link source_file target_file
To work around this, install link globally first:
$ npm i -g link
$ npx link
Related
npx ci- A betternpm ci.
7 Nov 20, 2022
28 Oct 31, 2022
25 Dec 21, 2022
49 Dec 29, 2022
4 Feb 24, 2022
3 Apr 1, 2022
8 Sep 27, 2022
2 Feb 16, 2021
51 Dec 12, 2022
44 Oct 29, 2022
35 Sep 20, 2022
13 Jul 19, 2022
4 May 6, 2022
31 Dec 27, 2022
15 May 7, 2022
0 Jun 5, 2022
280 Jan 8, 2023
14 Dec 12, 2022
144 Dec 27, 2022