Skip to content

Commit 268e4f8

Browse files
authored
docs: rewrap markdown (#8642)
1 parent 1fde042 commit 268e4f8

File tree

2 files changed

+28
-20
lines changed

2 files changed

+28
-20
lines changed

workspaces/libnpmdiff/CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,8 @@
409409

410410
### ⚠️ BREAKING CHANGES
411411

412-
* `npm pack` now follows a strict order of operations when applying ignore rules. If a files array is present in the package.json, then rules in .gitignore and .npmignore files from the root will be ignored.
412+
* `npm pack` now follows a strict order of operations when applying ignore rules.
413+
If a files array is present in the package.json, then rules in .gitignore and .npmignore files from the root will be ignored.
413414

414415
### Features
415416

workspaces/libnpmdiff/README.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,11 @@ index v1.1.0..v1.1.1 100644
5252
### Contributing
5353

5454
The npm team enthusiastically welcomes contributions and project participation!
55-
There's a bunch of things you can do if you want to contribute! The
56-
[Contributor Guide](https://github.com/npm/cli/blob/latest/CONTRIBUTING.md)
57-
outlines the process for community interaction and contribution. Please don't
58-
hesitate to jump in if you'd like to, or even ask us questions if something
59-
isn't clear.
55+
There's a bunch of things you can do if you want to contribute!
56+
The [Contributor Guide](https://github.com/npm/cli/blob/latest/CONTRIBUTING.md) outlines the process for community interaction and contribution.
57+
Please don't hesitate to jump in if you'd like to, or even ask us questions if something isn't clear.
6058

61-
All participants and maintainers in this project are expected to follow the
62-
[npm Code of Conduct](https://docs.npmjs.com/policies/conduct), and just
63-
generally be excellent to each other.
59+
All participants and maintainers in this project are expected to follow the [npm Code of Conduct](https://docs.npmjs.com/policies/conduct), and just generally be excellent to each other.
6460

6561
Please refer to the [Changelog](CHANGELOG.md) for project history details, too.
6662

@@ -70,20 +66,31 @@ Happy hacking!
7066

7167
#### `> libnpmdif([ a, b ], [opts]) -> Promise<String>`
7268

73-
Fetches the registry tarballs and compare files between a spec `a` and spec `b`. **npm** spec types are usually described in `<pkg-name>@<version>` form but multiple other types are also supported, for more info on valid specs take a look at [`npm-package-arg`](https://github.com/npm/npm-package-arg).
69+
Fetches the registry tarballs and compare files between a spec `a` and spec `b`.
70+
**npm** spec types are usually described in `<pkg-name>@<version>` form but multiple other types are also supported, for more info on valid specs take a look at [`npm-package-arg`](https://github.com/npm/npm-package-arg).
7471

7572
**Options**:
7673

77-
- `color <Boolean>`: Should add ANSI colors to string output? Defaults to `false`.
78-
- `tagVersionPrefix <String>`: What prefix should be used to define version numbers. Defaults to `v`
79-
- `diffUnified <Number>`: How many lines of code to print before/after each diff. Defaults to `3`.
80-
- `diffFiles <Array<String>>`: If set only prints patches for the files listed in this array (also accepts globs). Defaults to `undefined`.
81-
- `diffIgnoreAllSpace <Boolean>`: Whether or not should ignore changes in whitespace (very useful to avoid indentation changes extra diff lines). Defaults to `false`.
82-
- `diffNameOnly <Boolean>`: Prints only file names and no patch diffs. Defaults to `false`.
83-
- `diffNoPrefix <Boolean>`: If true then skips printing any prefixes in filenames. Defaults to `false`.
84-
- `diffSrcPrefix <String>`: Prefix to be used in the filenames from `a`. Defaults to `a/`.
85-
- `diffDstPrefix <String>`: Prefix to be used in the filenames from `b`. Defaults to `b/`.
86-
- `diffText <Boolean>`: Should treat all files as text and try to print diff for binary files. Defaults to `false`.
74+
- `color <Boolean>`: Should add ANSI colors to string output?
75+
Defaults to `false`.
76+
- `tagVersionPrefix <String>`: What prefix should be used to define version numbers.
77+
Defaults to `v`
78+
- `diffUnified <Number>`: How many lines of code to print before/after each diff.
79+
Defaults to `3`.
80+
- `diffFiles <Array<String>>`: If set only prints patches for the files listed in this array (also accepts globs).
81+
Defaults to `undefined`.
82+
- `diffIgnoreAllSpace <Boolean>`: Whether or not should ignore changes in whitespace (very useful to avoid indentation changes extra diff lines).
83+
Defaults to `false`.
84+
- `diffNameOnly <Boolean>`: Prints only file names and no patch diffs.
85+
Defaults to `false`.
86+
- `diffNoPrefix <Boolean>`: If true then skips printing any prefixes in filenames.
87+
Defaults to `false`.
88+
- `diffSrcPrefix <String>`: Prefix to be used in the filenames from `a`.
89+
Defaults to `a/`.
90+
- `diffDstPrefix <String>`: Prefix to be used in the filenames from `b`.
91+
Defaults to `b/`.
92+
- `diffText <Boolean>`: Should treat all files as text and try to print diff for binary files.
93+
Defaults to `false`.
8794
- ...`cache`, `registry`, `where` and other common options accepted by [pacote](https://github.com/npm/pacote#options)
8895

8996
Returns a `Promise` that fulfills with a `String` containing the resulting patch diffs.

0 commit comments

Comments
 (0)