Skip to content

Commit

Permalink
docs: add dotInIgnore option
Browse files Browse the repository at this point in the history
  • Loading branch information
kangetsu121 committed Aug 5, 2024
1 parent d163480 commit 2870785
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,9 @@ The default options are:
"checkRelative": true,
"baseURI": null,
"ignore": [],
"preferGET": [],
"dotInIgnore": false,
"ignoreRedirects": false,
"preferGET": [],
"retry": 3,
"userAgent": "textlint-rule-no-dead-link/1.0",
"maxRetryTime": 10,
Expand Down Expand Up @@ -112,6 +113,14 @@ Example:
}
```

### dotInIgnore

This rule allows ignore patterns to match filenames starting with a period.
For example, if the `ignore` option contains `"http://example.com/**"` and the `dotInIgnore` option is set to `true`, paths containing filenames that start with `.` (like `"http://example.com/.hidden/index.html"`) will be ignored.
You can disable this behavior by setting `dotInIgnore` to `false`.

_cf_, <https://github.com/isaacs/minimatch?tab=readme-ov-file#dot>

### preferGET

An array of [origins](https://url.spec.whatwg.org/#origin) to lets the rule connect to the origin's URL by `GET` instead of default `HEAD` request.
Expand Down

0 comments on commit 2870785

Please sign in to comment.