Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(rule): add dotInIgnore option #153

Merged
merged 3 commits into from
Aug 6, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
docs: add dotInIgnore option
kangetsu121 committed Aug 5, 2024
commit 28707851eb13205ee7c7bc1c956ea7931f3cd13e
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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,
@@ -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.