Skip to content

Commit 5e1fed9

Browse files
mbtoolsmbtools
authored
fix(arborist): improve README markdown (#8290)
Format table as markdown for better rendering
1 parent 5b5e886 commit 5e1fed9

File tree

1 file changed

+13
-47
lines changed

1 file changed

+13
-47
lines changed

‎workspaces/arborist/README.md

Lines changed: 13 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -267,53 +267,19 @@ are updated by arborist when necessary whenever the tree is modified in
267267
such a way that the dependency graph can change, and are relevant when
268268
pruning nodes from the tree.
269269

270-
```
271-
| extraneous | peer | dev | optional | devOptional | meaning | prune? |
272-
|------------+------+-----+----------+-------------+---------------------+-------------------|
273-
| | | | | | production dep | never |
274-
|------------+------+-----+----------+-------------+---------------------+-------------------|
275-
| X | N/A | N/A | N/A | N/A | nothing depends on | always |
276-
| | | | | | this, it is trash | |
277-
|------------+------+-----+----------+-------------+---------------------+-------------------|
278-
| | | X | | X | devDependency, or | if pruning dev |
279-
| | | | | not in lock | only depended upon | |
280-
| | | | | | by devDependencies | |
281-
|------------+------+-----+----------+-------------+---------------------+-------------------|
282-
| | | | X | X | optionalDependency, | if pruning |
283-
| | | | | not in lock | or only depended on | optional |
284-
| | | | | | by optionalDeps | |
285-
|------------+------+-----+----------+-------------+---------------------+-------------------|
286-
| | | X | X | X | Optional dependency | if pruning EITHER |
287-
| | | | | not in lock | of dep(s) in the | dev OR optional |
288-
| | | | | | dev hierarchy | |
289-
|------------+------+-----+----------+-------------+---------------------+-------------------|
290-
| | | | | X | BOTH a non-optional | if pruning BOTH |
291-
| | | | | in lock | dep within the dev | dev AND optional |
292-
| | | | | | hierarchy, AND a | |
293-
| | | | | | dep within the | |
294-
| | | | | | optional hierarchy | |
295-
|------------+------+-----+----------+-------------+---------------------+-------------------|
296-
| | X | | | | peer dependency, or | if pruning peers |
297-
| | | | | | only depended on by | |
298-
| | | | | | peer dependencies | |
299-
|------------+------+-----+----------+-------------+---------------------+-------------------|
300-
| | X | X | | X | peer dependency of | if pruning peer |
301-
| | | | | not in lock | dev node hierarchy | OR dev deps |
302-
|------------+------+-----+----------+-------------+---------------------+-------------------|
303-
| | X | | X | X | peer dependency of | if pruning peer |
304-
| | | | | not in lock | optional nodes, or | OR optional deps |
305-
| | | | | | peerOptional dep | |
306-
|------------+------+-----+----------+-------------+---------------------+-------------------|
307-
| | X | X | X | X | peer optional deps | if pruning peer |
308-
| | | | | not in lock | of the dev dep | OR optional OR |
309-
| | | | | | hierarchy | dev |
310-
|------------+------+-----+----------+-------------+---------------------+-------------------|
311-
| | X | | | X | BOTH a non-optional | if pruning peers |
312-
| | | | | in lock | peer dep within the | OR: |
313-
| | | | | | dev hierarchy, AND | BOTH optional |
314-
| | | | | | a peer optional dep | AND dev deps |
315-
+------------+------+-----+----------+-------------+---------------------+-------------------+
316-
```
270+
| extraneous | peer | dev | optional | devOptional | meaning | prune? |
271+
|:----------:|:----:|:---:|:--------:|:----------------:|:-------------------------------------------------------------------------------------------------|:-------------------------------------------------------|
272+
| | | | | | production dep | never |
273+
| X | N/A | N/A | N/A | N/A | nothing depends on this, it is trash | always |
274+
| | | X | | X<br>not in lock | devDependency, or only depended<br>on by devDependencies | if pruning dev |
275+
| | | | X | X<br>not in lock | optionalDependency, or only depended<br>on by optionalDeps | if pruning optional |
276+
| | | X | X | X<br>not in lock | Optional dependency of dep(s) in the<br>dev hierarchy | if pruning EITHER<br>dev OR optional |
277+
| | | | | X<br>in lock | BOTH a non-optional dep within the<br>dev hierarchy, AND a dep within<br>the optional hierarchy | if pruning BOTH<br>dev AND optional |
278+
| | X | | | | peer dependency, or only depended<br>on by peer dependencies | if pruning peers |
279+
| | X | X | | X<br>not in lock | peer dependency of dev node hierarchy | if pruning peer OR<br>dev deps |
280+
| | X | | X | X<br>not in lock | peer dependency of optional nodes, or<br>peerOptional dep | if pruning peer OR<br>optional deps |
281+
| | X | X | X | X<br>not in lock | peer optional deps of the dev dep hierarchy | if pruning peer OR<br>optional OR dev |
282+
| | X | | | X<br>in lock | BOTH a non-optional peer dep within the<br>dev hierarchy, AND a peer optional dep | if pruning peer deps OR:<br>BOTH optional AND dev deps |
317283

318284
* If none of these flags are set, then the node is required by the
319285
dependency and/or peerDependency hierarchy. It should not be pruned.

0 commit comments

Comments
 (0)