Skip to content

Commit 02d1d0b

Browse files
committedJun 9, 2020
Update docs for --ignore-pattern, --silently-ignore
1 parent 4078172 commit 02d1d0b

File tree

1 file changed

+54
-22
lines changed

1 file changed

+54
-22
lines changed
 

‎readme.md

+54-22
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ start({
6767
* [`--rc-path <path>`](#--rc-path-path)
6868
* [`--ignore-path <path>`](#--ignore-path-path)
6969
* [`--ignore-path-resolve-from dir|cwd`](#--ignore-path-resolve-from-dircwd)
70+
* [`--ignore-pattern <globs>`](#--ignore-pattern-globs)
71+
* [`--silently-ignore`](#--silently-ignore)
7072
* [`--setting <settings>`](#--setting-settings)
7173
* [`--report <reporter>`](#--report-reporter)
7274
* [`--use <plugin>`](#--use-plugin)
@@ -137,28 +139,31 @@ Usage: remark [options] [path | glob ...]
137139
138140
Options:
139141
140-
-h --help output usage information
141-
-v --version output version number
142-
-o --output [path] specify output location
143-
-r --rc-path <path> specify configuration file
144-
-i --ignore-path <path> specify ignore file
145-
-s --setting <settings> specify settings
146-
-e --ext <extensions> specify extensions
147-
-u --use <plugins> use plugins
148-
-w --watch watch for changes and reprocess
149-
-q --quiet output only warnings and errors
150-
-S --silent output only errors
151-
-f --frail exit with 1 on warnings
152-
-t --tree specify input and output as syntax tree
153-
--report <reporter> specify reporter
154-
--file-path <path> specify path to process as
155-
--tree-in specify input as syntax tree
156-
--tree-out output syntax tree
157-
--inspect output formatted syntax tree
158-
--[no-]stdout specify writing to stdout (on by default)
159-
--[no-]color specify color in report (on by default)
160-
--[no-]config search for configuration files (on by default)
161-
--[no-]ignore search for ignore files (on by default)
142+
-h --help output usage information
143+
-v --version output version number
144+
-o --output [path] specify output location
145+
-r --rc-path <path> specify configuration file
146+
-i --ignore-path <path> specify ignore file
147+
-s --setting <settings> specify settings
148+
-e --ext <extensions> specify extensions
149+
-u --use <plugins> use plugins
150+
-w --watch watch for changes and reprocess
151+
-q --quiet output only warnings and errors
152+
-S --silent output only errors
153+
-f --frail exit with 1 on warnings
154+
-t --tree specify input and output as syntax tree
155+
--report <reporter> specify reporter
156+
--file-path <path> specify path to process as
157+
--ignore-path-resolve-from dir|cwd resolve patterns in `ignore-path` from its directory or cwd
158+
--ignore-pattern <globs> specify ignore patterns
159+
--silently-ignore do not fail when given ignored files
160+
--tree-in specify input as syntax tree
161+
--tree-out output syntax tree
162+
--inspect output formatted syntax tree
163+
--[no-]stdout specify writing to stdout (on by default)
164+
--[no-]color specify color in report (on by default)
165+
--[no-]config search for configuration files (on by default)
166+
--[no-]ignore search for ignore files (on by default)
162167
163168
Examples:
164169
@@ -275,6 +280,29 @@ current working directory (`cwd`).
275280
* **Default**: `dir`
276281
* **Engine**: [`ignorePathResolveFrom`][engine-ignore-path-resolve-from]
277282

283+
### `--ignore-pattern <globs>`
284+
285+
```sh
286+
cli . --ignore-pattern docs/*.md
287+
```
288+
289+
Additional patterns to use to ignore files.
290+
291+
* **Default**: none
292+
* **Engine**: [`ignorePatterns`][engine-ignore-patterns]
293+
294+
### `--silently-ignore`
295+
296+
```sh
297+
cli **/*.md --silently-ignore
298+
```
299+
300+
Skip given files which are ignored by ignore files, instead of warning about
301+
them.
302+
303+
* **Default**: off
304+
* **Engine**: [`silentlyIgnore`][engine-silently-ignore]
305+
278306
### `--setting <settings>`
279307

280308
```sh
@@ -663,6 +691,10 @@ abide by its terms.
663691

664692
[engine-ignore-path-resolve-from]: https://github.com/unifiedjs/unified-engine/blob/master/doc/options.md#optionsignorepathresolvefrom
665693

694+
[engine-ignore-patterns]: https://github.com/unifiedjs/unified-engine/blob/master/doc/options.md#optionsignorepatterns
695+
696+
[engine-silently-ignore]: https://github.com/unifiedjs/unified-engine/blob/master/doc/options.md#optionssilentlyignore
697+
666698
[engine-reporter]: https://github.com/unifiedjs/unified-engine/blob/master/doc/options.md#optionsreporter
667699

668700
[engine-reporter-options]: https://github.com/unifiedjs/unified-engine/blob/master/doc/options.md#optionsreporteroptions

0 commit comments

Comments
 (0)
Please sign in to comment.