forked from lerna/website
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
293 lines (253 loc) · 13.3 KB
/
index.html
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Lerna · A tool for managing JavaScript projects with multiple packages.</title>
<link rel="stylesheet" href="styles.css">
</head>
<body>
<header class="hero">
<img src="images/lerna-hero.svg" alt="Lerna logo" width="500px">
<p class="hero__lead">A tool for managing JavaScript projects with multiple packages.</p>
<p class="hero__buttons">
<iframe src="https://ghbtns.com/github-btn.html?user=lerna&repo=lerna&type=star&count=true&size=large" frameborder="0" scrolling="0" width="160px" height="30px"></iframe>
<script async defer src="https://slack.lernajs.io/slackin.js?large"></script>
</p>
<p class="hero__follow">
<a href="https://twitter.com/lernajs" target="_blank">Follow Lerna on Twitter</a>
</p>
</header>
<article class="content">
<section class="content__section" id="about">
<h2>
<a href="#about">About</a>
</h2>
<p>
Splitting up large codebases into separate independently versioned
packages is extremely useful for code sharing. However, making changes
across many repositories is <em>messy</em> and difficult to track, and
testing across repositories gets complicated really fast.
</p>
<p>
To solve these (and many other) problems, some projects will organize
their codebases into multi-package repositories. Projects like Babel,
React, Angular, Ember, Meteor, Jest, and many others develop all of
their packages within a single repository.
</p>
<p class="text__important">
Lerna is a tool that optimizes the workflow around managing
multi-package repositories with git and npm.
</p>
</section>
<hr class="hr--large">
<section class="content__section" id="getting-started">
<h2>
<a href="#getting-started">Getting Started</a>
</h2>
<p>
Let's start by installing Lerna globally with
<a href="https://www.npmjs.com">npm</a>:
</p>
<p>Lerna 2.x is the recommended version to start with.</p>
<pre class="pre--command pre--centered"><code>npm install --global lerna</code></pre>
<p>
Next we'll create a new git repository:
</p>
<pre class="pre--command pre--centered"><code>git init lerna-repo && cd lerna-repo</code></pre>
<p>
And now let's turn it into a Lerna repo:
</p>
<pre class="pre--command pre--centered"><code>lerna init</code></pre>
<p>
Your repository should now look like this:
</p>
<pre class="pre--files"><code>lerna-repo/
packages/
package.json
lerna.json</code></pre>
</section>
<hr class="hr--large">
<section class="content__section" id="commands">
<h2>
<a href="#commands">Commands</a>
</h2>
<p>
Here is a brief introduction for each command.
Please visit the <a href="https://github.com/lerna/lerna#readme">README</a>
for more detailed informations.
</p>
<section class="command" id="command-init">
<h3><a href="#command-init">
<code>lerna init</code>
</a></h3>
<p>
Create a new lerna repo or upgrade an existing repo to the current
version of Lerna.
</p>
<h4>Options</h4>
<p>
<code>--independent</code>/<code>-i</code> – Use independent
versioning mode.
</p>
</section>
<section class="command" id="command-bootstrap">
<h3><a href="#command-bootstrap">
<code>lerna bootstrap</code>
</a></h3>
<p>
Bootstrap the packages in the current Lerna repo. Installing all their
dependencies and linking any cross-dependencies.
</p>
<p>
<strong>
This command is crucial, as it allows you to use your package
names in <code>require()</code> as if the packages were already existing
and available in your <code>node_modules</code> folder.
</strong>
</p>
</section>
<section class="command" id="command-publish">
<h3><a href="#command-publish">
<code>lerna publish</code>
</a></h3>
<p>
Create a new release of the packages that have been updated. Prompts
for a new version and updates all the packages on git and npm.
</p>
<h4>Options</h4>
<p>
<code>--npm-tag [tagname]</code> — Publish to npm with the given
npm dist-tag (Defaults to latest).
</p>
<p>
<code>--canary</code>/<code>-c</code> – Create a canary release.
</p>
<p>
<code>--skip-git</code> – Don't run any git commands.
</p>
<p>
<code>--force-publish [packages]</code> — Force publish for the
specified packages (comma-separated) or all packages using
<code>*</code> (skips the git diff check for changed packages).
</p>
</section>
<section class="command" id="command-updated">
<h3><a href="#command-updated">
<code>lerna updated</code>
</a></h3>
<p>
Check which packages have changed since the last release.
</p>
</section>
<section class="command" id="command-diff">
<h3><a href="#command-diff">
<code>lerna diff [package?]</code>
</a></h3>
<p>
Diff all packages or a single package since the last release.
</p>
</section>
<section class="command" id="command-run">
<h3><a href="#command-run">
<code>lerna run [script]</code>
</a></h3>
<p>
Run an <a href="https://docs.npmjs.com/misc/scripts">npm script</a>
in each package that contains that script.
</p>
</section>
<section class="command" id="command-ls">
<h3><a href="#command-ls">
<code>lerna ls</code>
</a></h3>
<p>
List all of the public packages in the current Lerna repo.
</p>
</section>
</section>
<section class="content__section" id="users">
<h2>
<a href="#users">Who's using Lerna?</a>
</h2>
<ul>
<li><a href="https://github.com/primer/primer">primer/primer</a></li>
<li><a href="https://github.com/babel/babel">babel/babel</a></li>
<li><a href="https://github.com/facebook/create-react-app">facebook/create-react-app</a></li>
<li><a href="https://github.com/ReactTraining/react-router">ReactTraining/react-router</a></li>
<li><a href="https://github.com/pugjs/pug">pugjs/pug</a></li>
<li><a href="https://github.com/facebook/jest">facebook/jest</a></li>
<li><a href="https://github.com/palantir/blueprint">palantir/blueprint</a></li>
<li><a href="https://github.com/reactotron/reactotron">reactotron/reactotron</a></li>
<li><a href="https://github.com/ElemeFE/mint-ui">ElemeFE/mint-ui</a></li>
<li><a href="https://github.com/devtools-html/debugger.html">devtools-html/debugger.html</a></li>
<li><a href="https://github.com/alibaba/rax">alibaba/rax</a></li>
<li><a href="https://github.com/Turfjs/turf">Turfjs/turf</a></li>
<li><a href="https://github.com/babel/babili">babel/babili</a></li>
<li><a href="https://github.com/storybooks/storybook">storybooks/storybook</a></li>
<li><a href="https://github.com/xmppjs/xmpp.js">xmppjs/xmpp.js</a></li>
<li><a href="https://github.com/wooorm/retext">wooorm/retext</a></li>
<li><a href="https://github.com/jumpsuit/jumpsuit">jumpsuit/jumpsuit</a></li>
<li><a href="https://github.com/strapi/strapi">strapi/strapi</a></li>
<li><a href="https://github.com/cloudflare/cf-ui">cloudflare/cf-ui</a></li>
<li><a href="https://github.com/colmena/colmena">colmena/colmena</a></li>
<li><a href="https://github.com/angus-c/just">angus-c/just</a></li>
<li><a href="https://github.com/cerebral/cerebral">cerebral/cerebral</a></li>
<li><a href="https://github.com/nteract/nteract">nteract/nteract</a></li>
<li><a href="https://github.com/wooorm/remark">wooorm/remark</a></li>
<li><a href="https://github.com/rofrischmann/fela">rofrischmann/fela</a></li>
<li><a href="https://github.com/tbranyen/diffhtml">tbranyen/diffhtml</a></li>
<li><a href="https://github.com/ElemeFE/cooking">ElemeFE/cooking</a></li>
<li><a href="https://github.com/antwarjs/antwar">antwarjs/antwar</a></li>
<li><a href="https://github.com/apollostack/graphql-server">apollostack/graphql-server</a></li>
<li><a href="https://github.com/jimpick/lambda-comments">jimpick/lambda-comments</a></li>
<li><a href="https://github.com/lystable/recon">lystable/recon</a></li>
<li><a href="https://github.com/marudor/flowInterfaces">marudor/flowInterfaces</a></li>
<li><a href="https://github.com/GoogleChrome/sw-helpers">GoogleChrome/sw-helpers</a></li>
<li><a href="https://github.com/webpack-preset/webpack-preset">webpack-preset/webpack-preset</a></li>
<li><a href="https://github.com/vazco/uniforms">vazco/uniforms</a></li>
<li><a href="https://github.com/metal/metal.js">metal/metal.js</a></li>
<li><a href="https://github.com/steelbrain/pundle">steelbrain/pundle</a></li>
<li><a href="https://github.com/neos/neos-ui">neos/neos-ui</a></li>
<li><a href="https://github.com/mosjs/mos">mosjs/mos</a></li>
<li><a href="https://github.com/lore/lore">lore/lore</a></li>
<li><a href="https://github.com/act-framework/act">act-framework/act</a></li>
<li><a href="https://github.com/yvele/poosh">yvele/poosh</a></li>
<li><a href="https://github.com/noderaider/gridiron">noderaider/gridiron</a></li>
<li><a href="https://github.com/superawesomelabs/leo">superawesomelabs/leo</a></li>
<li><a href="https://github.com/tocco/tocco-client">tocco/tocco-client</a></li>
<li><a href="https://github.com/zalando-incubator/tessellate">zalando-incubator/tessellate</a></li>
<li><a href="https://github.com/sencha/extjs-reactor">sencha/extjs-reactor</a></li>
<li><a href="https://github.com/DigitalRiver/react-atlas">DigitalRiver/react-atlas</a></li>
<li><a href="https://github.com/forivall/tacoscript">forivall/tacoscript</a></li>
<li><a href="https://github.com/Boxable/box-ui">Boxable/box-ui</a></li>
<li><a href="https://github.com/flux-capacitor/flux-capacitor">flux-capacitor/flux-capacitor</a></li>
<li><a href="https://github.com/trepo/trepo-js">trepo/trepo-js</a></li>
<li><a href="https://github.com/spacedoc/spacedoc">spacedoc/spacedoc</a></li>
<li><a href="https://github.com/oknosoft/metadata.js">oknosoft/metadata.js</a></li>
<li><a href="https://github.com/uber-web/uber-eslint">uber-web/uber-eslint</a></li>
<li><a href="https://github.com/brittanica/brittanica">brittanica/brittanica</a></li>
<li><a href="https://github.com/openzipkin/zipkin-js">openzipkin/zipkin-js</a></li>
<li><a href="https://github.com/vudash/vudash">vudash/vudash</a></li>
<li><a href="https://github.com/nteract/commuter">nteract/commuter</a></li>
<li><a href="https://github.com/frintjs/frint">frintjs/frint</a></li>
<li><a href="https://github.com/fyndiq/fyndiq-ui">fyndiq/fyndiq-ui</a></li>
<li><a href="https://github.com/azu/immutable-array-prototype">azu/immutable-array-prototype</a></li>
<li><a href="https://github.com/TrueCar/gluestick">TrueCar/gluestick</a></li>
<li><a href="https://github.com/KELiON/create-cerebro-plugin">KELiON/create-cerebro-plugin</a></li>
<li><a href="https://github.com/phenomic/phenomic">phenomic/phenomic</a></li>
<li><a href="https://github.com/sterjakovigor/vqua">sterjakovigor/vqua</a></li>
<li><a href="https://github.com/wireapp/wire-web-packages">wireapp/wire-web-packages</a></li>
<li><a href="https://github.com/klis87/redux-saga-requests">klis87/redux-saga-requests</a></li>
<li><a href="https://github.com/WordPress/packages">WordPress/packages</a></li>
<li><a href="https://github.com/react-cosmos/react-cosmos">react-cosmos/react-cosmos</a></li>
<li><a href="https://github.com/jsbites/jedifocus-monorepo">jsbites/jedifocus-monorepo</a></li>
<li><a href="https://github.com/FoalTS/foal">FoalTS/foal</a></li>
<li><a href="https://github.com/emotion-js/emotion">emotion-js/emotion</a></li>
<li><a href="https://github.com/Bamieh/reflow/">Bamieh/reflow</a></li>
</ul>
</section>
</article>
</body>
</html>