Skip to content

Commit 157ba5e

Browse files
committed
fix: ignore config error
1 parent 6ba7bca commit 157ba5e

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ type Options = {
174174
- `hyperParse`: customize the hyper parser by their names. It could be `undefined` which means just use default [ignored cases parser](https://github.com/zhlint-project/zhlint/tree/master/src/hypers/ignore.js), [Markdown parser](https://github.com/zhlint-project/zhlint/tree/master/src/hypers/md.js) and the [Hexo tags parser](https://github.com/zhlint-project/zhlint/tree/master/src/hypers/hexo.js).
175175
- `ignoredCases`: provide exception cases which you would like to skip.
176176
- `IgnoredCase`: `{ prefix?, textStart, textEnd?, suffix? }`
177-
- Just follows a certain format inspired from [W3C Scroll To Text Fragment Proposal](https://github.com/WICG/ScrollToTextFragment).
177+
- Just follows a certain format `[prefix-,]textStart[,textEnd][,-suffix]` inspired from [W3C Scroll To Text Fragment Proposal](https://github.com/WICG/ScrollToTextFragment).
178178
- `logger`: same to the parameter in `report(...)`.
179179
180180
### RC Config

bin/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
const fs = require('fs')
44
const minimist = require('minimist')
55
const glob = require('glob')
6-
const gitignore = require('./ignore')
6+
const gitignore = require('ignore')
77
const { readRc, runWithConfig, report } = require('../')
88

99
const helpMessage = `

docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ type Options = {
186186
- `hyperParse`: customize the hyper parser by their names. It could be `undefined` which means just use default [ignored cases parser](https://github.com/zhlint-project/zhlint/tree/master/src/hypers/ignore.js), [Markdown parser](https://github.com/zhlint-project/zhlint/tree/master/src/hypers/md.js) and the [Hexo tags parser](https://github.com/zhlint-project/zhlint/tree/master/src/hypers/hexo.js).
187187
- `ignoredCases`: provide exception cases which you would like to skip.
188188
- `IgnoredCase`: `{ prefix?, textStart, textEnd?, suffix? }`
189-
- Just follows a certain format inspired from [W3C Scroll To Text Fragment Proposal](https://github.com/WICG/ScrollToTextFragment).
189+
- Just follows a certain format `[prefix-,]textStart[,textEnd][,-suffix]` inspired from [W3C Scroll To Text Fragment Proposal](https://github.com/WICG/ScrollToTextFragment).
190190
- `logger`: same to the parameter in `report(...)`.
191191
192192
### RC Config

src/rc/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ type PathResult = {
1313

1414
const DEFAULT_CONFIG_PATH = '.zhlintrc'
1515
const DEFAULT_FILE_IGNORE_PATH = '.zhlintignore'
16-
const DEFAULT_CASE_IGNORE_PATH = '.zhlintignore'
16+
const DEFAULT_CASE_IGNORE_PATH = '.zhlintcaseignore'
1717

1818
const resolvePath = (
1919
dir: string,

0 commit comments

Comments
 (0)