@bhsd/codemirror-mediawiki 2.29.2 → 2.30.0

package/README.md

@@ -1,5 +1,4 @@
 [![npm version](https://badge.fury.io/js/@bhsd%2Fcodemirror-mediawiki.svg)](https://www.npmjs.com/package/@bhsd/codemirror-mediawiki)
-[![CodeQL](https://github.com/bhsd-harry/codemirror-mediawiki/actions/workflows/codeql.yml/badge.svg)](https://github.com/bhsd-harry/codemirror-mediawiki/actions/workflows/codeql.yml)
 [![jsDelivr hits (npm scoped)](https://img.shields.io/jsdelivr/npm/hm/%40bhsd/codemirror-mediawiki)](https://www.npmjs.com/package/@bhsd/codemirror-mediawiki)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/972fd5f6684c4fd8ac2f26e01d349948)](https://app.codacy.com/gh/bhsd-harry/codemirror-mediawiki/dashboard)
 

package/dist/codemirror.js

@@ -89,7 +89,7 @@ const avail = {
     hover: mediawikiOnly(magicWordHover),
     signatureHelp: mediawikiOnly(signatureHelp),
     inlayHints: mediawikiOnly(inlayHints),
-};
+}, editExtensions = new Set(['closeBrackets', 'autocompletion', 'signatureHelp']);
 const linters = {};
 const phrases = {};
 /**
@@ -194,7 +194,13 @@ export class CodeMirror6 {
                 }
             }),
             ...readOnly
-                ? [EditorState.readOnly.of(true)]
+                ? [
+                    EditorState.readOnly.of(true),
+                    EditorState.transactionFilter.of(tr => tr.docChanged ? [] : tr),
+                    EditorView.theme({
+                        'input[type="color"]': { pointerEvents: 'none' },
+                    }),
+                ]
                 : [
                     history(),
                     indentOnInput(),
@@ -261,7 +267,15 @@ export class CodeMirror6 {
     lint(lintSource) {
         const linterExtension = lintSource
             ? [
-                linter(view => lintSource(view.state.doc)),
+                linter(async ({ state: { doc, readOnly } }) => {
+                    const diagnostics = await lintSource(doc);
+                    if (readOnly) {
+                        for (const diagnostic of diagnostics) {
+                            delete diagnostic.actions;
+                        }
+                    }
+                    return diagnostics;
+                }),
                 lintGutter(),
                 keymap.of(lintKeymap),
                 statusBar(lintSource.fixer),
@@ -308,7 +322,8 @@ export class CodeMirror6 {
             }
         }
         if (this.#view) {
-            this.#effects(this.#extensions.reconfigure([...this.#preferred].map(name => {
+            const { readOnly } = this.#view.state;
+            this.#effects(this.#extensions.reconfigure([...this.#preferred].filter(name => !readOnly || !editExtensions.has(name)).map(name => {
                 const [extension, configs] = avail[name];
                 return extension(configs[this.#lang], this);
             })));

package/dist/config.d.ts

@@ -53,6 +53,7 @@ tokens: {
     htmlTagAttributeValue: string;
     htmlTagBracket: string;
     htmlTagName: string;
+    ignored: string;
     imageParameter: string;
     linkBracket: string;
     linkDelimiter: string;

package/dist/config.js

@@ -112,6 +112,7 @@ var tokens = {
   htmlTagAttributeValue: "mw-htmltag-attribute-value",
   htmlTagBracket: "mw-htmltag-bracket",
   htmlTagName: "mw-htmltag-name",
+  ignored: "mw-ignored",
   imageParameter: "mw-image-parameter",
   linkBracket: "mw-link-bracket",
   linkDelimiter: "mw-link-delimiter",

package/dist/fold.d.ts

@@ -1,5 +1,5 @@
 import { StateField } from '@codemirror/state';
-import type { EditorView, Tooltip } from '@codemirror/view';
+import type { EditorView, Tooltip, Command } from '@codemirror/view';
 import type { EditorState, Extension } from '@codemirror/state';
 import type { SyntaxNode, Tree } from '@lezer/common';
 export interface DocRange {
@@ -17,9 +17,11 @@ export declare const braceStackUpdate: (state: EditorState, node: SyntaxNode) =>
  * @param state
  * @param posOrNode 字符位置或语法树节点
  * @param tree 语法树
+ * @param refOnly 是否仅检查`<ref>`标签
  */
-export declare const foldable: (state: EditorState, posOrNode: number | SyntaxNode, tree?: Tree | null) => DocRange | false;
+export declare const foldable: (state: EditorState, posOrNode: number | SyntaxNode, tree?: Tree | null, refOnly?: boolean) => DocRange | false;
 export declare const foldableLine: ({ state, viewport: { to: end }, viewportLineBlocks }: EditorView, { from: f, to: t }: DocRange) => DocRange | false;
+export declare const foldRef: Command;
 declare const _default: [(e?: Extension | undefined) => Extension, {
     mediawiki: (Extension | StateField<Tooltip | null>)[];
 }];

package/dist/fold.js

@@ -3,7 +3,7 @@ import { StateField, RangeSetBuilder, RangeSet } from '@codemirror/state';
 import { syntaxTree, ensureSyntaxTree, foldEffect, unfoldEffect, foldedRanges, unfoldAll, codeFolding, foldGutter, foldKeymap, foldState, language, } from '@codemirror/language';
 import { getRegex } from '@bhsd/common';
 import { tokens } from './config';
-import { matchTag } from './matchTag';
+import { matchTag, getTag } from './matchTag';
 const getExtRegex = getRegex(tag => new RegExp(`mw-tag-${tag}(?![a-z])`, 'u'));
 const updateSelection = (pos, { to }) => Math.max(pos, to), updateAll = (pos, { from, to }) => from <= pos && to > pos ? to : pos;
 /**
@@ -25,8 +25,9 @@ isExtBracket = isComponent(['extTagBracket']),
 /**
  * Check if a SyntaxNode is part of a extension tag
  * @param node 语法树节点
+ * @param refOnly 是否仅检查`<ref>`标签
  */
-isExt = (node) => node.name.includes('mw-tag-');
+isExt = (node, refOnly) => node.name.includes(`mw-tag-${refOnly ? 'ref' : ''}`);
 /**
  * Update the stack of opening (+) or closing (-) brackets
  * @param state
@@ -36,13 +37,15 @@ export const braceStackUpdate = (state, node) => {
     const brackets = state.sliceDoc(node.from, node.to);
     return [brackets.split('{{').length - 1, 1 - brackets.split('}}').length];
 };
+const refNames = new Set(['ref', 'references']);
 /**
  * 寻找可折叠的范围
  * @param state
  * @param posOrNode 字符位置或语法树节点
  * @param tree 语法树
+ * @param refOnly 是否仅检查`<ref>`标签
  */
-export const foldable = (state, posOrNode, tree) => {
+export const foldable = (state, posOrNode, tree, refOnly = false) => {
     if (typeof posOrNode === 'number') {
         tree = ensureSyntaxTree(state, posOrNode); // eslint-disable-line no-param-reassign
     }
@@ -53,12 +56,12 @@ export const foldable = (state, posOrNode, tree) => {
     if (typeof posOrNode === 'number') {
         // Find the initial template node on both sides of the position
         const left = tree.resolve(posOrNode, -1);
-        if (isTemplate(left)) {
+        if (!refOnly && isTemplate(left)) {
             node = left;
         }
         else {
             const right = tree.resolve(posOrNode, 1);
-            node = isExt(left)
+            node = isExt(left, refOnly)
                 && left.name.split('mw-tag-').length > right.name.split('mw-tag-').length
                 ? left
                 : right;
@@ -67,15 +70,17 @@ export const foldable = (state, posOrNode, tree) => {
     else {
         node = posOrNode;
     }
-    if (!isTemplate(node)) {
+    if (refOnly || !isTemplate(node)) {
         // Not a template
-        if (isExt(node)) {
+        if (isExt(node, refOnly)) {
             const { name } = node, [tag] = /^[a-z]+/u.exec(name.slice(name.lastIndexOf('mw-tag-') + 7)), regex = getExtRegex(tag);
             let { nextSibling } = node;
             while (nextSibling && !(isExtBracket(nextSibling) && !regex.test(nextSibling.name))) {
                 ({ nextSibling } = nextSibling);
             }
-            if (nextSibling) { // The closing bracket of the current extension tag
+            const next = nextSibling?.nextSibling;
+            // The closing bracket of the current extension tag
+            if (nextSibling && (!refOnly || next && refNames.has(getTag(state, next)?.name))) {
                 return { from: matchTag(state, nextSibling.to).end.to, to: nextSibling.from };
             }
         }
@@ -189,11 +194,12 @@ const getAnchor = (state) => Math.max(...state.selection.ranges.map(({ to }) =>
  * @param end 终止位置
  * @param anchor 光标位置
  * @param update 更新光标位置
+ * @param refOnly 是否仅检查`<ref>`标签
  */
-const traverse = (state, tree, effects, node, end, anchor, update) => {
+const traverse = (state, tree, effects, node, end, anchor, update, refOnly) => {
     while (node && node.from <= end) {
         /* eslint-disable no-param-reassign */
-        const range = foldable(state, node, tree);
+        const range = foldable(state, node, tree, refOnly);
         if (range) {
             effects.push(foldEffect.of(range));
             node = tree.resolve(range.to, 1);
@@ -311,6 +317,15 @@ const markers = ViewPlugin.fromClass(class {
     }
 });
 const defaultFoldExtension = [foldGutter(), keymap.of(foldKeymap)];
+/**
+ * 生成折叠命令
+ * @param refOnly 是否仅检查`<ref>`标签
+ */
+const foldCommand = (refOnly) => view => {
+    const { state } = view, tree = syntaxTree(state), effects = [], anchor = traverse(state, tree, effects, tree.topNode.firstChild, Infinity, getAnchor(state), updateAll, refOnly);
+    return execute(view, effects, anchor);
+};
+export const foldRef = foldCommand(true);
 export default [
     (e = defaultFoldExtension) => e,
     {
@@ -372,10 +387,12 @@ export default [
                 {
                     // Fold all templates in the document
                     key: 'Ctrl-Alt-[',
-                    run(view) {
-                        const { state } = view, tree = syntaxTree(state), effects = [], anchor = traverse(state, tree, effects, tree.topNode.firstChild, Infinity, getAnchor(state), updateAll);
-                        return execute(view, effects, anchor);
-                    },
+                    run: foldCommand(),
+                },
+                {
+                    // Fold all `<ref>` tags in the document
+                    key: 'Mod-Alt-,',
+                    run: foldRef,
                 },
                 {
                     // Unfold the template at the selection/cursor

package/dist/linter.d.ts

@@ -33,12 +33,21 @@ declare interface JsonError {
  */
 export declare const getWikiLinter: getAsyncLinter<Promise<MixedDiagnostic[]>, Option, object>;
 export declare const jsConfig: Linter.Config<Linter.RulesRecord, Linter.RulesRecord>;
-/** 获取 ESLint */
-export declare const getJsLinter: getAsyncLinter<Linter.LintMessage[]>;
-/** 获取 Stylelint */
-export declare const getCssLinter: getAsyncLinter<Promise<Warning[]>>;
-/** 获取 Luacheck */
-export declare const getLuaLinter: getAsyncLinter<Promise<Diagnostic[]>>;
+/**
+ * 获取 ESLint
+ * @param cdn CDN 地址
+ */
+export declare const getJsLinter: getAsyncLinter<Linter.LintMessage[], string>;
+/**
+ * 获取 Stylelint
+ * @param cdn CDN 地址
+ */
+export declare const getCssLinter: getAsyncLinter<Promise<Warning[]>, string>;
+/**
+ * 获取 Luacheck
+ * @param cdn CDN 地址
+ */
+export declare const getLuaLinter: getAsyncLinter<Promise<Diagnostic[]>, string>;
 /** JSON.parse */
 export declare const getJsonLinter: getLinter<JsonError[]>;
 export {};

package/dist/linter.js

@@ -57,9 +57,12 @@ export const jsConfig = /* #__PURE__ */ (() => ({
         importStylesheetURI: 'readonly',
     },
 }))();
-/** 获取 ESLint */
-export const getJsLinter = async () => {
-    await loadScript('npm/@bhsd/eslint-browserify', 'eslint');
+/**
+ * 获取 ESLint
+ * @param cdn CDN 地址
+ */
+export const getJsLinter = async (cdn = 'npm/@bhsd/eslint-browserify') => {
+    await loadScript(cdn, 'eslint');
     /** @see https://www.npmjs.com/package/@codemirror/lang-javascript */
     const esLinter = new eslint.Linter(), conf = {
         env: { browser: true, es2024: true },
@@ -84,9 +87,12 @@ export const getJsLinter = async () => {
     linter.fixer = (code, rule) => esLinter.verifyAndFix(code, rule ? { ...linter.config, rules: { [rule]: linter.config.rules?.[rule] ?? 2 } } : linter.config).output;
     return linter;
 };
-/** 获取 Stylelint */
-export const getCssLinter = async () => {
-    await loadScript('npm/@bhsd/stylelint-browserify', 'stylelint');
+/**
+ * 获取 Stylelint
+ * @param cdn CDN 地址
+ */
+export const getCssLinter = async (cdn = 'npm/@bhsd/stylelint-browserify') => {
+    await loadScript(cdn, 'stylelint');
     const linter = async (code, opt) => {
         const warnings = await styleLint(stylelint, code, opt);
         if (opt && 'rules' in opt) {
@@ -102,9 +108,12 @@ export const getCssLinter = async () => {
     };
     return linter;
 };
-/** 获取 Luacheck */
-export const getLuaLinter = async () => {
-    await loadScript('npm/luacheck-browserify', 'luacheck');
+/**
+ * 获取 Luacheck
+ * @param cdn CDN 地址
+ */
+export const getLuaLinter = async (cdn = 'npm/luacheck-browserify') => {
+    await loadScript(cdn, 'luacheck');
     // eslint-disable-next-line @typescript-eslint/await-thenable
     const luachecker = await luacheck(undefined);
     return async (text) => (await luachecker.queue(text)).filter(({ severity }) => severity);