feat: add enable option

Author: action-hong

.vscode/settings.json

@@ -3,7 +3,7 @@
 	"typescript.tsc.autoDetect": "off",
 	"typescript.preferences.quoteStyle": "single",
 	"editor.codeActionsOnSave": {
-		"source.fixAll.eslint": true
+		"source.fixAll.eslint": "explicit"
 	},
 	"terminal.integrated.defaultProfile.windows": "Command Prompt",
 	"eslint.validate": [

README.md

@@ -48,6 +48,7 @@ these feature maybe remove in the future
 |:----|:-----------|:-------:|
 |`zhlint.options`|see [zhlint options](https://zhlint-project.github.io/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`|
 |`zhlint.experimental.config`|enable use `.zhlintrc` and `.zhlintignore` to config in workspace |`false`|
 |`zhlint.experimental.ignore`|enable use `.experimental-zhlintignore` to ignore files or directories while linting by specifying one or more glob patterns|`false`|

package.json

@@ -40,6 +40,12 @@
 					"default": "off",
 					"description": "Traces the communication between VS Code and the language server."
 				},
+				"zhlint.enable": {
+					"type": "boolean",
+					"default": true,
+					"title": "Enable zhlint",
+					"description": "Controls whether zhlint is enabled or not."
+				},
 				"zhlint.experimental.diff": {
 					"type": "boolean",
 					"title": "show rule diff in explorer",

server/src/server.ts

@@ -104,6 +104,7 @@ const defaultSettings: ZhlintSettings = {
 		}
 	},
 	debug: false,
+	enable: true,
 	experimental: {
 		diff: false,
 		config: false,
@@ -114,6 +115,7 @@ const defaultSettings: ZhlintSettings = {
 interface ZhlintSettings {
 	options: Options;
 	debug: boolean;
+	enable: boolean;
 	experimental: {
 		diff: boolean
 		config: boolean
@@ -213,6 +215,7 @@ async function lintMD(textDocument: TextDocument, range?: Range) {
 	const uri = textDocument.uri;
 
 	const settings = await getDocumentSettings(textDocument);
+	if (!settings.enable) return;
 	if (settings.experimental.ignore && fileFilter.ignores(uri)) return;
 
 	const res = getZhlintConfig(textDocument, settings);