Skip to content

Commit b365cf8

Browse files
committed
chore: compatible diff
1 parent 57804a2 commit b365cf8

File tree

6 files changed

+146
-177
lines changed

6 files changed

+146
-177
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,23 @@ Currently,only `.md` files are supported。If you want to support other file t
3232
}
3333
```
3434

35+
## config
36+
37+
this extension will use `readRc` and `runWithConfig` if there has `.zhlintr{c, c.json}``.zhlintignore``.zhlintcaseignore`,or it will use `run()` with `zhlint.options` in `.vscode/settings.json`
38+
3539
## Experimental Feature
3640

3741
these feature maybe remove in the future
3842

39-
- support `.zhlintr{c, c.json}` and `.zhlintignore` (**if one of them exist,this extension will use `readRc` and `runWithConfig`,otherwise use `run()` with `zhlint.options` from `settings.json`**)
40-
- rule diff viewer
41-
- ignore files or directories with `.experimental-zhlintignore`,checkout [ignore](https://www.npmjs.com/package/ignore)
43+
### diff viewer
44+
45+
1. set `zhlint.experimental.diff` to `true`
46+
2. Keep Open for your markdown file(which you want to see the diff),checkout [How do I make VS Code open files in a new tab?](https://vscode.one/new-tab-vscode/)
47+
48+
![diff viewer](./screenshot/preview.png)
49+
50+
![handle hyper space option](./screenshot/see-rule-diff.png)
51+
4252

4353
## options
4454

@@ -48,8 +58,6 @@ these feature maybe remove in the future
4858
|`zhlint.debug`|print extra message when run zhlint|`false`|
4959
|`zhlint.enable`|Controls whether zhlint is enabled or not|`true`|
5060
|`zhlint.experimental.diff` |enable rule diff viewer in explorer |`false`|
51-
|`zhlint.experimental.config`|enable use `.zhlintrc` and `.zhlintignore` to config in workspace |`false`|
52-
|`zhlint.experimental.ignore`|enable use `.experimental-zhlintignore` to ignore files or directories while linting by specifying one or more glob patterns|`false`|
5361

5462
## Dev
5563

client/src/RuleView.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export class RuleNodeProvider implements vscode.TreeDataProvider<RuleNode> {
2727
'vscode.diff',
2828
this.createZhlintUri(this.activeEditorUri || '', diff.diff, true),
2929
this.createZhlintUri(this.activeEditorUri || '', diff.diff, false),
30-
`parse: ${diff.diff.ruleName}`,
30+
`parse: ${diff.diff.ruleName}`,
3131
)
3232
}))
3333
this.handleChangeActiveEditor(vscode.window.activeTextEditor)

screenshot/preview.png

136 KB
Loading

screenshot/see-rule-diff.png

149 KB
Loading

0 commit comments

Comments
 (0)