Allow VS Code Diagnostic Severity level to be configured for markdownlint violation severity error and warning (fixes #241).

Author: DavidAnson

.markdownlint.json

@@ -66,6 +66,8 @@
 			"### markdownlint.configFile",
 			"### markdownlint.focusMode",
 			"### markdownlint.run",
+			"### markdownlint.severityForError",
+			"### markdownlint.severityForWarning",
 			"### markdownlint.customRules",
 			"### markdownlint.lintWorkspaceGlobs",
 			"## Suppress",
@@ -77,6 +79,9 @@
 	"strong-style": {
 		"style": "asterisk"
 	},
+	"table-column-style": {
+		"style": "aligned"
+	},
 	"table-pipe-style": {
 		"style": "leading_and_trailing"
 	},

README.md

@@ -303,6 +303,37 @@ If you find this distracting, linting can be configured to run only when the doc
 
 > **Note**: When configured to run `onSave`, the list of reported issues will become outdated while the document is edited and will update when the document is saved.
 
+### markdownlint.severityForError
+
+By default, the `markdownlint` library reports violations at severity level `error` and they are displayed in VS Code at Diagnostic Severity `Warning`.
+
+If you want to change the Diagnostic Severity shown by VS Code to something else, the `markdownlint.severityForError` configuration property can be set to any of the following values:
+
+| Value         | VS Code Definition                                              |
+| ------------- | --------------------------------------------------------------- |
+| `Error`       | Something not allowed by the rules of a language or other means |
+| `Warning`     | Something suspicious but allowed                                |
+| `Information` | Something to inform about but not a problem                     |
+| `Hint`        | Something to hint to a better way of doing it                   |
+| `Ignore`      | *Ignore the violation and do not report it*                     |
+
+For example:
+
+```json
+{
+    "editor.someSetting": true,
+    "markdownlint.severityForError": "Information"
+}
+```
+
+### markdownlint.severityForWarning
+
+This configuration property behaves the same as `markdownlint.severityForError` (see above) and is used for violations reported by the `markdownlint` library at severity level `warning`.
+
+By default, such violations are displayed in VS Code at Diagnostic Severity `Information`.
+
+The value of `severityForWarning` can be the same as the value of `severityForError`.
+
 ### markdownlint.customRules
 
 Custom rules can be specified in VS Code's user/workspace configuration to apply additional linting beyond the default set of rules. Custom rules are specified by the path to a JavaScript file or the name of or path to an [npm](https://www.npmjs.com/) package exporting one rule or an array of rules ([examples of custom rules](https://www.npmjs.com/search?q=keywords:markdownlint-rule)).

extension.mjs

@@ -62,6 +62,18 @@ const codeActionKindSourceFixAllExtension = codeActionKindSourceFixAll.append(ex
 const defaultConfig = {
 	"MD013": false
 };
+const diagnosticSeverityError = "Error";
+const diagnosticSeverityHint = "Hint";
+const diagnosticSeverityIgnore = "Ignore";
+const diagnosticSeverityInformation = "Information";
+const diagnosticSeverityWarning = "Warning";
+const diagnosticSeverities = new Set([
+	diagnosticSeverityError,
+	diagnosticSeverityHint,
+	diagnosticSeverityIgnore,
+	diagnosticSeverityInformation,
+	diagnosticSeverityWarning
+]);
 
 const clickForInfo = "More information about ";
 const clickToFixThis = "Fix this violation of ";
@@ -85,6 +97,8 @@ const sectionCustomRules = "customRules";
 const sectionFocusMode = "focusMode";
 const sectionLintWorkspaceGlobs = "lintWorkspaceGlobs";
 const sectionRun = "run";
+const sectionSeverityForError = "severityForError";
+const sectionSeverityForWarning = "severityForWarning";
 const applicationConfigurationSections = [ sectionFocusMode ];
 const throttleDuration = 500;
 const customRuleExtensionPrefixRe = /^\{([^}]+)\}\/(.*)$/iu;
@@ -328,6 +342,14 @@ function outputLine (message, isError) {
 	}
 }
 
+function getDiagnosticSeverity (configuration, section, fallback) {
+	let value = configuration.get(section);
+	if (!diagnosticSeverities.has(value)) {
+		value = fallback;
+	}
+	return vscode.DiagnosticSeverity[value] ?? null;
+}
+
 // Returns rule configuration from user/workspace configuration
 async function getConfig (fs, configuration, uri) {
 	let userWorkspaceConfig = configuration.get(sectionConfig);
@@ -430,6 +452,8 @@ async function markdownlintWrapper (document) {
 		new FsNull() :
 		new FsWrapper(workspaceFolderUri);
 	const configuration = vscode.workspace.getConfiguration(extensionDisplayName, document.uri);
+	const errorSeverity = getDiagnosticSeverity(configuration, sectionSeverityForError, diagnosticSeverityWarning);
+	const warningSeverity = getDiagnosticSeverity(configuration, sectionSeverityForWarning, diagnosticSeverityInformation);
 	const config = await getConfig(fs, configuration, document.uri);
 	const directory = independentDocument ?
 		null :
@@ -466,7 +490,11 @@ async function markdownlintWrapper (document) {
 		.catch((error) => import("./stringify-error.mjs").then(
 			(stringifyError) => outputLine(errorExceptionPrefix + stringifyError.default(error), true)
 		))
-		.then(() => results);
+		.then(() => ({
+			results,
+			errorSeverity,
+			warningSeverity
+		}));
 	// If necessary some day to filter results by matching file name...
 	// .then(() => results.filter((result) => isSchemeUntitled || (result.fileName === path.posix.relative(directory, name))))
 }
@@ -541,7 +569,7 @@ function lint (document) {
 	const targetGeneration = diagnosticGeneration;
 	// Lint
 	markdownlintWrapper(document)
-		.then((results) => {
+		.then(({ results, errorSeverity, warningSeverity }) => {
 			const { activeTextEditor } = vscode.window;
 			for (const result of results) {
 				// Create Diagnostics
@@ -550,12 +578,15 @@ function lint (document) {
 				const focusModeRange = (!Number.isInteger(focusMode) || (focusMode < 0)) ?
 					0 :
 					focusMode;
+				const severity = (result.severity === "warning") ? warningSeverity : errorSeverity;
 				if (
-					(applicationConfiguration[sectionFocusMode] === false) ||
-					!activeTextEditor ||
-					(activeTextEditor.document !== document) ||
-					(activeTextEditor.selection.active.line < (lineNumber - focusModeRange - 1)) ||
-					(activeTextEditor.selection.active.line > (lineNumber + focusModeRange - 1))
+					(severity !== null) && (
+						(applicationConfiguration[sectionFocusMode] === false) ||
+						!activeTextEditor ||
+						(activeTextEditor.document !== document) ||
+						(activeTextEditor.selection.active.line < (lineNumber - focusModeRange - 1)) ||
+						(activeTextEditor.selection.active.line > (lineNumber + focusModeRange - 1))
+					)
 				) {
 					const ruleName = result.ruleNames[0];
 					const ruleDescription = result.ruleDescription;
@@ -571,9 +602,7 @@ function lint (document) {
 						const end = start + result.errorRange[1];
 						range = range.with(range.start.with(undefined, start), range.end.with(undefined, end));
 					}
-					const severity = (result.severity === "warning") ?
-						vscode.DiagnosticSeverity.Information :
-						vscode.DiagnosticSeverity.Warning;
+					// @ts-ignore
 					const diagnostic = new vscode.Diagnostic(range, message, severity);
 					diagnostic.code = ruleInformationUri ?
 						{
@@ -723,10 +752,10 @@ function fixAll (ruleNameFilter) {
 			const document = editor.document;
 			if (isMarkdownDocument(document)) {
 				return markdownlintWrapper(document)
-					.then((errors) => {
+					.then(({ results }) => {
 						const text = document.getText();
 						const errorsToFix =
-							errors.filter((error) => (!ruleNameFilter || (error.ruleNames[0] === ruleNameFilter)));
+							results.filter((error) => (!ruleNameFilter || (error.ruleNames[0] === ruleNameFilter)));
 						const fixedText = applyFixes(text, errorsToFix);
 						return (text === fixedText) ?
 							null :
@@ -748,8 +777,8 @@ function formatDocument (document, range) {
 	return new Promise((resolve, reject) => {
 		if (isMarkdownDocument(document)) {
 			return markdownlintWrapper(document)
-				.then((errors) => {
-					const rangeErrors = errors.filter((error) => {
+				.then(({ results }) => {
+					const rangeErrors = results.filter((error) => {
 						const { fixInfo } = error;
 						if (fixInfo) {
 							// eslint-disable-next-line unicorn/consistent-destructuring

package.json

@@ -228,6 +228,32 @@
 						"onType"
 					],
 					"default": "onType"
+				},
+				"markdownlint.severityForError": {
+					"description": "VS Code diagnostic level to use for issues with severity \"error\"",
+					"scope": "resource",
+					"type": "string",
+					"enum": [
+						"Error",
+						"Warning",
+						"Information",
+						"Hint",
+						"Ignore"
+					],
+					"default": "Warning"
+				},
+				"markdownlint.severityForWarning": {
+					"description": "VS Code diagnostic level to use for issues with severity \"warning\"",
+					"scope": "resource",
+					"type": "string",
+					"enum": [
+						"Error",
+						"Warning",
+						"Information",
+						"Hint",
+						"Ignore"
+					],
+					"default": "Information"
 				}
 			}
 		}