symlinked
Node utility to list symlinks made by npm link, yarn link, or fs.link
Install
``` npm install symlinked ``` Local install as above is best practice if you are using in a shared codebase because then all developers will use the same version. CLI can be used locally via npx or via npm scripts.npm install has a --global flag you can add if you prefer global use. Yarn can be used via yarn add and yarn global add respectively if you prefer yarn.
CLI
``` Usage: symlinked Finds all linked package names of an npm package. Commands: names Get linked package names paths Get linked package paths roots Get linked package roots links Get linked package links Options: -h, --help Display this usage info ```API
require
```js
var symlinked = require("symlinked")
```
Methods
symlinked.names(dir: ".")get array of linked package names
symlinked.paths(dir: ".")get array of linked package paths
symlinked.roots(dir: ".")get array of linked package roots
symlinked.links(dir: ".")get array of linked package links
symlinked.is(path)test if path exists and is linked
symlinked.read(path)read link
Examples
Ran in package directory with said dependency linked on both ends
```js
symlinked.names()
// 'said'
```
```js
symlinked.paths()
// '/Users/jdoe/symlinked/nodemodules/said'
```
```js
symlinked.roots()
// '/Users/jdoe/symlinked/nodemodules/said/nodemodules'
```
```js
symlinked.links()
// '/Users/said'
```
Webpack resolve.modules configuration to resolve dependencies of linked dependencies
```js
module.exports = {
resolve: {
modules: ["node_modules"].concat(symlinked.roots())