UNPKG

npm-link-extra

Version:

npm or yarn link common modules between a project and a monorepo/multi-packages dir

github.com/DavideDaniel/npm-link-extra

DavideDaniel/npm-link-extra

115 lines (73 loc) • 4.26 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
### npm-link-extra * * * Some useful things we wish npm/yarn link had. Inspired by fs-extra... One issue currently is the inconsistency between npm's link behavior between the major versions. We have found link to be most stable with version 3.10.10 so that is our recommended npm version. ### Install ```bash $ npm install npm-link-extra --save-dev ``` ### CLI Docs ```bash Usage $ nlx <path> -<cmd> --<options> $ npx nlx <path> -<cmd> --<options> Commands -h, --help show help menu -l, --link link all dirs if present in dependencies -u, --unlink unlink all linked dependencies -s, --show show all shared and/or linked dependencies -v, --version get npm-link-extra package version Options -d, --dir relative path to mononrepo/dir with many modules --linked-only only select currently linked packages --shared-only only select shared dependencies between project and target dir ``` ### Documentation <!-- Generated by documentation.js. Update this documentation by updating the source code. --> ##### Table of Contents - [getDirectories](#getdirectories) - [Parameters](#parameters) - [getPackages](#getpackages) - [Parameters](#parameters-1) - [getSharedDepDirs](#getshareddepdirs) - [Parameters](#parameters-2) - [getSharedLinked](#getsharedlinked) - [Parameters](#parameters-3) - [getSharedDeps](#getshareddeps) - [Parameters](#parameters-4) - [getLinkedDeps](#getlinkeddeps) - [Parameters](#parameters-5) #### getDirectories getDirectories returns all directories in a given path ##### Parameters - `pathTo` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** relative path to monorepo or directory with node modules - `opts` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** options to call the function with Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** array of directories #### getPackages getPackages returs all packages ##### Parameters - `dirs` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** array of directories Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** array of packages & the relative path to them #### getSharedDepDirs getSharedDepDirs selects an array of shared and linked packages ##### Parameters - `pkgs` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** An array of dependencies - `hash` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** A hash map of our deps Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** A filtered list of shared pkg dirs #### getSharedLinked getSharedLinked selects an array of shared and linked packages ##### Parameters - `pkgs` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** An array of dependencies - `hash` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** A hash map of our deps Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** A filtered list of packages #### getSharedDeps getSharedDeps will show any shared dependencies between project & target dir ##### Parameters - `pkgs` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** An array of dependencies - `hash` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** A hash map of our deps Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** Array of shared dep names #### getLinkedDeps getLinkedDeps returns a list of linked dependencies ##### Parameters - `pkgs` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** An array of dependencies Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** Array of linked dep names