Merge pull request #135 from zhlint-project/jinjiang/new-ignore-rc

feat: new ignore arguments

README.md

@@ -50,6 +50,10 @@ zhlint --config <filepath>
 
 # .zhlintignore by default
 zhlint --ignore <filepath>
+zhlint --file-ignore <filepath>
+
+# .zhlintcaseignore by default
+zhlint --case-ignore <filepath>
 
 # current directory by default
 zhlint --dir <path>
@@ -68,7 +72,9 @@ In the config file, you can write a JSON like:
 
 For more details, see [supported rules](#supported-rules).
 
-In the ignore file, you can write some lines of ignored cases like:
+In the file-ignore file, you can write some lines to ignore files in [.gitignore syntax](https://git-scm.com/docs/gitignore#_pattern_format):
+
+In the case-ignore file, you can write some lines of ignored cases like:
 
 ```txt
 ( , )
@@ -121,9 +127,10 @@ const value = '自动在中文和English之间加入空格'
 
 const dir = '...' // the target directory path
 const configPath = '...' // the config file path
-const ignorePath = '...' // the ignore file path
+const fileIgnorePath = '...' // the file-ignore file path
+const caseIgnorePath = '...' // the case-ignore file path
 
-const config = readRc(dir, configPath, ignorePath)
+const config = readRc(dir, configPath, fileIgnorePath, caseIgnorePath)
 const output = runWithConfig(value, config)
 
 // ... further actions
@@ -167,15 +174,15 @@ type Options = {
 -   `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).
 -   `ignoredCases`: provide exception cases which you would like to skip.
     -   `IgnoredCase`: `{ prefix?, textStart, textEnd?, suffix? }`
-        -   Just follows a certain format inspired from [W3C Scroll To Text Fragment Proposal](https://github.com/WICG/ScrollToTextFragment).
+        -   Just follows a certain format `[prefix-,]textStart[,textEnd][,-suffix]` inspired from [W3C Scroll To Text Fragment Proposal](https://github.com/WICG/ScrollToTextFragment).
 -   `logger`: same to the parameter in `report(...)`.
 
 ### RC Config
 
 -   `preset`: `string` (optional)
 -   `rules`: `RuleOptions` without the `preset` field. (optional)
 -   `hyperParsers`: `string[]` (optional)
--   `ignores`: `string[]` and the priority is lower than `.zhlintignore`. (optional)
+-   `caseIgnores`: `string[]` and the priority is lower than `.zhlintcaseignore`. (optional)
 
 ### Output
 

bin/index.js

@@ -3,6 +3,7 @@
 const fs = require('fs')
 const minimist = require('minimist')
 const glob = require('glob')
+const gitignore = require('ignore')
 const { readRc, runWithConfig, report } = require('../')
 
 const helpMessage = `
@@ -24,7 +25,11 @@ Config arguments:
     .zhlintrc by default
 
   --ignore <filepath>
+  --file-ignore <filepath>
     .zhlintignore by default
+  
+  --case-ignore <filepath>
+    .zhlintcaseignore by default
 
   --dir    <path>
     current directory by default
@@ -69,11 +74,14 @@ const main = () => {
     const [filePattern] = [...argv._]
     const configDir = argv.dir
     const configPath = argv.config
-    const ignorePath = argv.ignore
-    const config = readRc(configDir, configPath, ignorePath)
+    const fileIgnorePath = argv.ignore || argv['file-ignore']
+    const caseIgnorePath = argv['case-ignore']
+    const config = readRc(configDir, configPath, fileIgnorePath, caseIgnorePath)
+    const fileIgnore = gitignore().add(config.fileIgnores)
+    const fileIgnoreFilter = fileIgnore.createFilter()
     try {
       const files = glob.sync(filePattern)
-      const resultList = files.map((file) => {
+      const resultList = files.filter(fileIgnoreFilter).map((file) => {
         console.log(`[start] ${file}`)
         const origin = fs.readFileSync(file, { encoding: 'utf8' })
         const { result, validations } = runWithConfig(origin, config)

docs/index.md

@@ -56,6 +56,10 @@ zhlint --config <filepath>
 
 # .zhlintignore by default
 zhlint --ignore <filepath>
+zhlint --file-ignore <filepath>
+
+# .zhlintcaseignore by default
+zhlint --case-ignore <filepath>
 
 # current directory by default
 zhlint --dir <path>
@@ -74,7 +78,9 @@ In the config file, you can write a JSON like:
 
 For more details, see [supported rules](#supported-rules).
 
-In the ignore file, you can write some lines of ignored cases like:
+In the file-ignore file, you can write some lines to ignore files in [.gitignore syntax](https://git-scm.com/docs/gitignore#_pattern_format):
+
+In the case-ignore file, you can write some lines of ignored cases like:
 
 ```txt
 ( , )
@@ -131,9 +137,10 @@ const value = '自动在中文和English之间加入空格'
 
 const dir = '...' // the target directory path
 const configPath = '...' // the config file path
-const ignorePath = '...' // the ignore file path
+const fileIgnorePath = '...' // the file-ignore file path
+const caseIgnorePath = '...' // the case-ignore file path
 
-const config = readRc(dir, configPath, ignorePath)
+const config = readRc(dir, configPath, fileIgnorePath, caseIgnorePath)
 const output = runWithConfig(value, config)
 
 // ... further actions
@@ -179,15 +186,15 @@ type Options = {
 - `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).
 - `ignoredCases`: provide exception cases which you would like to skip.
   - `IgnoredCase`: `{ prefix?, textStart, textEnd?, suffix? }`
-    - Just follows a certain format inspired from [W3C Scroll To Text Fragment Proposal](https://github.com/WICG/ScrollToTextFragment).
+    - Just follows a certain format `[prefix-,]textStart[,textEnd][,-suffix]` inspired from [W3C Scroll To Text Fragment Proposal](https://github.com/WICG/ScrollToTextFragment).
 - `logger`: same to the parameter in `report(...)`.
 
 ### RC Config
 
 - `preset`: `string` (optional)
 - `rules`: `RuleOptions` without the `preset` field. (optional)
 - `hyperParsers`: `string[]` (optional)
-- `ignores`: `string[]` and the priority is lower than `.zhlintignore`. (optional)
+- `caseIgnores`: `string[]` and the priority is lower than `.zhlintcaseignore`. (optional)
 
 ### Output
 

package.json

@@ -79,6 +79,7 @@
   "dependencies": {
     "chalk": "^4.0.0",
     "glob": "^7.1.6",
+    "ignore": "^5.3.0",
     "minimist": "^1.2.0",
     "node-stdlib-browser": "^1.2.0",
     "remark-frontmatter": "^1.3.2",

src/options.ts

@@ -157,8 +157,8 @@ export const normalizeConfig = (
   })
 
   // ignored cases
-  if (config.ignores) {
-    config.ignores.forEach((x) => {
+  if (config.caseIgnores) {
+    config.caseIgnores.forEach((x) => {
       const ignoredCase = parseIngoredCase(x)
       if (ignoredCase) {
         options.ignoredCases.push(ignoredCase)