@markuplint/language-server 5.4.0 → 5.6.0

package/lib/const.d.ts

@@ -39,3 +39,13 @@ export declare const BUNDLED_PARSER_LOAD_ERROR = "The markuplint bundled with th
  * `{2*}` the working directory.
  */
 export declare const BUNDLED_PARSER_LOAD_COMPAT_ERROR = "The markuplint bundled with the language server (v{0}) cannot load {1*} from {2*} because the markuplint installed there is incompatible with Node.js 22+. Upgrade it to markuplint@4.10.0 or later, then restart the language server.";
+/**
+ * Error message shown when the configuration needs `@markuplint/pretenders` (`pretenders.scan`, `pretenders.auto`,
+ * or a pretender that has a `filePath`) and the markuplint bundled with the language server is the one in use.
+ * markuplint does not install `@markuplint/pretenders` and the extension does not bundle it, and the bundled
+ * `@markuplint/file-resolver` imports it relative to itself, so installing it in the workspace is not enough
+ * until markuplint itself is installed there. The message of the error that markuplint raises tells to install
+ * it in the project, which does not fix this case.
+ * Displayed as a popup via `errorToPopup`. `{0}` is the bundled version, `{1*}` the working directory.
+ */
+export declare const BUNDLED_PRETENDERS_NOT_FOUND_ERROR = "The markuplint bundled with the language server (v{0}) does not include @markuplint/pretenders, which your configuration needs. Install markuplint and @markuplint/pretenders in {1*}, then restart the language server so that it can use the local installation.";

package/lib/const.js

@@ -42,3 +42,13 @@ export const BUNDLED_PARSER_LOAD_ERROR = 'The markuplint bundled with the langua
  * `{2*}` the working directory.
  */
 export const BUNDLED_PARSER_LOAD_COMPAT_ERROR = 'The markuplint bundled with the language server (v{0}) cannot load {1*} from {2*} because the markuplint installed there is incompatible with Node.js 22+. Upgrade it to markuplint@4.10.0 or later, then restart the language server.';
+/**
+ * Error message shown when the configuration needs `@markuplint/pretenders` (`pretenders.scan`, `pretenders.auto`,
+ * or a pretender that has a `filePath`) and the markuplint bundled with the language server is the one in use.
+ * markuplint does not install `@markuplint/pretenders` and the extension does not bundle it, and the bundled
+ * `@markuplint/file-resolver` imports it relative to itself, so installing it in the workspace is not enough
+ * until markuplint itself is installed there. The message of the error that markuplint raises tells to install
+ * it in the project, which does not fix this case.
+ * Displayed as a popup via `errorToPopup`. `{0}` is the bundled version, `{1*}` the working directory.
+ */
+export const BUNDLED_PRETENDERS_NOT_FOUND_ERROR = 'The markuplint bundled with the language server (v{0}) does not include @markuplint/pretenders, which your configuration needs. Install markuplint and @markuplint/pretenders in {1*}, then restart the language server so that it can use the local installation.';

package/lib/server/get-accessibility-by-location.js

@@ -1,3 +1,4 @@
+import { searchNodeAtLocation } from '@markuplint/ml-core';
 export async function getAccessibilityByLocation(
 // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
 engine, line, col, ariaVersion) {
@@ -7,7 +8,10 @@ engine, line, col, ariaVersion) {
     if (!engine?.document) {
         return null;
     }
-    const node = engine.document.searchNodeByLocation(line, col);
+    // The engine is the markuplint the user installed, whose `searchNodeByLocation` may be of an older
+    // version (one that compared the line and the column apart and took the end of a range in), so the
+    // node list is searched here, by the rule of this version.
+    const node = searchNodeAtLocation(engine.document.nodeList, line, col);
     if (!node || !node.is(node.ELEMENT_NODE)) {
         return null;
     }

package/lib/server/parser-load-failure.d.ts

@@ -18,10 +18,20 @@ export type ParserLoadFailureContext = {
  * @returns The package name (scoped when applicable), or `null` if the message is not a parser load failure
  */
 export declare function extractMissingParserName(message: string): string | null;
+/**
+ * Whether an error is what markuplint raises for a configuration that needs `@markuplint/pretenders` when it
+ * is not installed: an error that says how to install it, with the `ERR_MODULE_NOT_FOUND` of the import as its
+ * `cause`. It is reported as a `config-error` of the file (the `lint-error` event of `MLEngine`) rather than
+ * as a rejection of `exec()`, so it is told by its cause.
+ *
+ * @param error - The error of the `lint-error` event, or of a rejection
+ * @returns `true` when the cause is the missing `@markuplint/pretenders`
+ */
+export declare function isPretendersNotInstalled(error: unknown): boolean;
 /**
  * Builds the user-facing explanation for a parser load failure.
  *
- * @param error - The rejection from `MLEngine#exec()`
+ * @param error - The rejection from `MLEngine#exec()`, or the error of its `lint-error` event
  * @param context - Which markuplint module linted the document
  * @returns The message to show, or `null` if the error is not a parser load failure
  */

package/lib/server/parser-load-failure.js

@@ -1,6 +1,7 @@
 import { isFatalError } from 'markuplint/suppressions';
-import { BUNDLED_PARSER_LOAD_COMPAT_ERROR, BUNDLED_PARSER_LOAD_ERROR, PARSER_NOT_FOUND_ERROR } from '../const.js';
+import { BUNDLED_PARSER_LOAD_COMPAT_ERROR, BUNDLED_PARSER_LOAD_ERROR, BUNDLED_PRETENDERS_NOT_FOUND_ERROR, PARSER_NOT_FOUND_ERROR, } from '../const.js';
 import { t } from '../i18n.js';
+const PRETENDERS_PACKAGE = '@markuplint/pretenders';
 // `@markuplint/file-resolver` (v3+) rewrites a bare parser specifier that is not importable into an
 // absolute path under the config's directory before giving up, so the reported specifier is
 // usually `<configDir>/@markuplint/xxx-parser`, not the name the user wrote.
@@ -39,10 +40,24 @@ function packageNameOf(spec) {
     }
     return segments.length === 1 ? name : null;
 }
+/**
+ * Whether an error is what markuplint raises for a configuration that needs `@markuplint/pretenders` when it
+ * is not installed: an error that says how to install it, with the `ERR_MODULE_NOT_FOUND` of the import as its
+ * `cause`. It is reported as a `config-error` of the file (the `lint-error` event of `MLEngine`) rather than
+ * as a rejection of `exec()`, so it is told by its cause.
+ *
+ * @param error - The error of the `lint-error` event, or of a rejection
+ * @returns `true` when the cause is the missing `@markuplint/pretenders`
+ */
+export function isPretendersNotInstalled(error) {
+    return (error instanceof Error &&
+        error.cause instanceof Error &&
+        extractMissingParserName(error.cause.message) === PRETENDERS_PACKAGE);
+}
 /**
  * Builds the user-facing explanation for a parser load failure.
  *
- * @param error - The rejection from `MLEngine#exec()`
+ * @param error - The rejection from `MLEngine#exec()`, or the error of its `lint-error` event
  * @param context - Which markuplint module linted the document
  * @returns The message to show, or `null` if the error is not a parser load failure
  */
@@ -50,6 +65,16 @@ export function describeParserLoadFailure(error, context) {
     if (!(error instanceof Error)) {
         return null;
     }
+    if (isPretendersNotInstalled(error)) {
+        if (context.isLocalModule) {
+            // The message of the error says how to install it, which is the fix for a local markuplint.
+            return error.message;
+        }
+        if (context.fallbackReason === 'import-assertion-compat') {
+            return t(BUNDLED_PARSER_LOAD_COMPAT_ERROR, context.version, PRETENDERS_PACKAGE, context.workspace);
+        }
+        return t(BUNDLED_PRETENDERS_NOT_FOUND_ERROR, context.version, context.workspace);
+    }
     const parser = extractMissingParserName(error.message);
     if (!parser) {
         return null;

package/lib/server/v3.js

@@ -1,4 +1,5 @@
 import path from 'node:path';
+import { searchNodeAtLocation } from '@markuplint/ml-core';
 import { getFilePath } from '../utils/get-file-path.js';
 import { convertDiagnostics } from './convert-diagnostics.js';
 const engines = new Map();
@@ -163,7 +164,10 @@ position, ariaVersion) {
     if (!engine || !engine.document) {
         return null;
     }
-    const node = engine.document.searchNodeByLocation(position.line + 1, position.character);
+    // LSP counts the character from 0, the node list the column from 1. The engine is the user's
+    // markuplint v3, whose `searchNodeByLocation` takes the end of a range in and compares the line
+    // and the column apart, so the node list is searched by the rule of this version.
+    const node = searchNodeAtLocation(engine.document.nodeList, position.line + 1, position.character + 1);
     if (!node || !node.is(node.ELEMENT_NODE)) {
         return null;
     }

package/lib/server/v4.js

@@ -224,7 +224,8 @@ position, ariaVersion) {
     if (!engine) {
         return null;
     }
-    const a11y = await getAccessibilityByLocation(engine, position.line + 1, position.character, ariaVersion);
+    // LSP counts the character from 0, the node list the column from 1.
+    const a11y = await getAccessibilityByLocation(engine, position.line + 1, position.character + 1, ariaVersion);
     if (!a11y) {
         return null;
     }

package/lib/server/v5.js

@@ -5,6 +5,7 @@ import { getFilePath } from '../utils/get-file-path.js';
 import { createQuickFixActions, createFixAllAction } from './code-actions.js';
 import { convertDiagnostics } from './convert-diagnostics.js';
 import { getAccessibilityByLocation } from './get-accessibility-by-location.js';
+import { isPretendersNotInstalled } from './parser-load-failure.js';
 import { applySuppressionsToViolations, loadSuppressions } from './suppression-support.js';
 const engines = new Map();
 const fixStates = new Map();
@@ -78,8 +79,18 @@ config, locale, log, diagnosticsLog, sendDiagnostics, notFoundParserError, works
     engine.on('log', (phase, message) => {
         log(`[${phase}]: ${message}`, 'trace');
     });
+    // The lint fails again on every edit of the document, with the same cause until the package is installed
+    // and the server restarted (which the popup says), so the popup is shown once per document.
+    let pretendersPopupShown = false;
     engine.on('lint-error', (_filePath, _sourceCode, error) => {
         diagnosticsLog(error.message, 'error');
+        // A configuration that needs `@markuplint/pretenders` is a `config-error` diagnostic, not a rejection of
+        // `exec()`, so the popup that a missing parser gets has to be asked for here: the diagnostic tells to
+        // install it in the project, which does not fix it for the markuplint bundled with the language server.
+        if (!pretendersPopupShown && isPretendersNotInstalled(error)) {
+            pretendersPopupShown = true;
+            notFoundParserError(error);
+        }
     });
     engine.on('config-errors', (_filePath, errors) => {
         for (const error of errors) {
@@ -251,7 +262,8 @@ position, ariaVersion) {
     if (!engine) {
         return null;
     }
-    const a11y = await getAccessibilityByLocation(engine, position.line + 1, position.character, ariaVersion);
+    // LSP counts the character from 0, the node list the column from 1.
+    const a11y = await getAccessibilityByLocation(engine, position.line + 1, position.character + 1, ariaVersion);
     if (!a11y) {
         return null;
     }

package/locales/ja.json

@@ -1,5 +1,6 @@
 {
 	"keywords": {
+		". ": "。",
 		"computed accessibility properties": "計算済みアクセシビリティプロパティ",
 		"hidden element": "非表示要素",
 		"no corresponding role": "対応するロールなし",
@@ -16,6 +17,7 @@
 		"[suppressed] this warning is suppressed but should be fixed:": "[抑制中] この警告は抑制されていますが、本来は修正すべき問題です:",
 		"parser not found. you probably need to install {0} for documents of language {1}.": "パーサーが見つかりません。言語 {1} の文書には {0} をインストールする必要があります。",
 		"the markuplint bundled with the language server (v{0}) cannot load parsers installed in your workspace. install markuplint and {1} in {2}, then restart the language server so that it can use the local installation.": "言語サーバーにバンドルされたmarkuplint(v{0})はワークスペースにインストールされたパーサーを読み込めません。ローカル版を使えるように、{2} にmarkuplintと{1}をインストールしてから言語サーバーを再起動してください。",
-		"the markuplint bundled with the language server (v{0}) cannot load {1} from {2} because the markuplint installed there is incompatible with node.js 22+. upgrade it to markuplint@4.10.0 or later, then restart the language server.": "言語サーバーにバンドルされたmarkuplint(v{0})は {2} の{1}を読み込めません。そこにインストールされたmarkuplintがNode.js 22+と互換性がないためです。markuplint@4.10.0以降にアップグレードしてから言語サーバーを再起動してください。"
+		"the markuplint bundled with the language server (v{0}) cannot load {1} from {2} because the markuplint installed there is incompatible with node.js 22+. upgrade it to markuplint@4.10.0 or later, then restart the language server.": "言語サーバーにバンドルされたmarkuplint(v{0})は {2} の{1}を読み込めません。そこにインストールされたmarkuplintがNode.js 22+と互換性がないためです。markuplint@4.10.0以降にアップグレードしてから言語サーバーを再起動してください。",
+		"the markuplint bundled with the language server (v{0}) does not include @markuplint/pretenders, which your configuration needs. install markuplint and @markuplint/pretenders in {1}, then restart the language server so that it can use the local installation.": "言語サーバーにバンドルされたmarkuplint(v{0})には、設定が必要とする@markuplint/pretendersが含まれていません。ローカル版を使えるように、{1} にmarkuplintと@markuplint/pretendersをインストールしてから言語サーバーを再起動してください。"
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/language-server",
-	"version": "5.4.0",
+	"version": "5.6.0",
 	"description": "Language Server Protocol server for markuplint",
 	"repository": {
 		"type": "git",
@@ -41,20 +41,22 @@
 		"clean": "tsc --build --clean tsconfig.build.json"
 	},
 	"dependencies": {
-		"@markuplint/file-resolver": "5.4.0",
-		"@markuplint/i18n": "5.3.0",
-		"@markuplint/ml-config": "5.4.0",
-		"@markuplint/ml-spec": "5.4.0",
+		"@markuplint/file-resolver": "5.6.0",
+		"@markuplint/i18n": "5.6.0",
+		"@markuplint/ml-config": "5.6.0",
+		"@markuplint/ml-core": "5.6.0",
+		"@markuplint/ml-spec": "5.6.0",
 		"debug": "^4.4.3",
-		"markuplint": "5.4.0",
-		"semver": "^7.8.5",
+		"markuplint": "5.6.0",
+		"semver": "^7.8.6",
 		"vscode-languageserver": "^9.0.1",
-		"vscode-languageserver-textdocument": "^1.0.15"
+		"vscode-languageserver-textdocument": "^1.0.16"
 	},
 	"devDependencies": {
+		"@markuplint/test-tools": "5.6.0",
 		"@types/debug": "4.1.13",
 		"@types/semver": "7.8.0",
 		"vscode-jsonrpc": "8.2.1"
 	},
-	"gitHead": "647f6fb5d5743f060678599c97e9c84b58970747"
+	"gitHead": "eade3d7202682e567f3c1b6985478f1d4b5c5481"
 }