VS Code zhlint Extension

VS Code Extension for zhlint

Feature

lint
format

use zhlint as your default formatter for markdown

{
  "[markdown]": {
    "editor.defaultFormatter": "kkopite.zhlint",
    "editor.formatOnSave": true
  }
}

you can use Shift + Alt + F or save to format your markdown with zhlint

Currently，only .md files are supported。If you want to support other file types，such as .txt

{
  "files.associations": {
    "*.txt": "markdown"
  }
}

config

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

Experimental Feature

these feature maybe remove in the future

diff viewer

set zhlint.experimental.diff to true
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？

diff viewer

handle hyper space option

options

`key`	`description`	`default`
`zhlint.options`	see zhlint options, `logger` is exclude	`{}`
`zhlint.debug`	print extra message when run zhlint	`false`
`zhlint.enable`	Controls whether zhlint is enabled or not	`true`
`zhlint.experimental.diff`	enable rule diff viewer in explorer	`false`

Dev

Run npm install in this folder。This installs all necessary npm modules in both the client and server folder
Open VS Code on this folder。
Press Ctrl+Shift+B to start compiling the client and server in watch mode。
Switch to the Run and Debug View in the Sidebar (Ctrl+Shift+D)。
Select Launch Client from the drop down (if it is not already)。
Press ▷ to run the launch config (F5)。
Select Attach to Server from the drop down，press F5 to attach the debugger to the server