@bhsd/codemirror-mediawiki 3.9.2 → 3.10.1

package/dist/matchBrackets.d.ts

@@ -5,9 +5,25 @@ export interface Selection {
     anchor: number;
     head: number;
 }
+/**
+ * @ignore
+ * @test
+ */
 export declare const findEnclosingBrackets: (node: SyntaxNode, pos: number, brackets: string) => MatchResult | undefined;
+/**
+ * @ignore
+ * @test
+ */
 export declare const findEnclosingPlainBrackets: (state: EditorState, pos: number, config: Required<Config>) => MatchResult | null;
+/**
+ * @ignore
+ * @test
+ */
 export declare const trySelectMatchingBrackets: (state: EditorState, pos: number, dir: 1 | -1, config?: Config, inside?: boolean) => Selection | false;
+/**
+ * @ignore
+ * @test
+ */
 export declare const selectMatchingBrackets: (state: EditorState, pos: number, config?: Config) => Selection | false;
 declare const _default: (configs?: Config) => Extension;
 export default _default;

package/dist/matchBrackets.js

@@ -1,5 +1,9 @@
 import { Decoration, EditorView } from '@codemirror/view';
 import { bracketMatching, matchBrackets, syntaxTree } from '@codemirror/language';
+/**
+ * @ignore
+ * @test
+ */
 export const findEnclosingBrackets = (node, pos, brackets) => {
     let parent = node;
     while (parent) {
@@ -14,6 +18,10 @@ export const findEnclosingBrackets = (node, pos, brackets) => {
     }
     return undefined;
 };
+/**
+ * @ignore
+ * @test
+ */
 export const findEnclosingPlainBrackets = (state, pos, config) => {
     const { brackets, maxScanDistance } = config, re = new RegExp(`[${[...brackets].filter((_, i) => i % 2).map(c => c === ']' ? String.raw `\]` : c).join('')}]`, 'gu'), str = state.sliceDoc(pos, pos + maxScanDistance);
     let mt = re.exec(str);
@@ -26,6 +34,10 @@ export const findEnclosingPlainBrackets = (state, pos, config) => {
     }
     return null;
 };
+/**
+ * @ignore
+ * @test
+ */
 export const trySelectMatchingBrackets = (state, pos, dir, config, inside = false) => {
     if (pos < 0) {
         return false;
@@ -36,6 +48,10 @@ export const trySelectMatchingBrackets = (state, pos, dir, config, inside = fals
         head: match.end[rightInside ? 'from' : 'to'],
     };
 };
+/**
+ * @ignore
+ * @test
+ */
 export const selectMatchingBrackets = (state, pos, config) => trySelectMatchingBrackets(state, pos, -1, config)
     || trySelectMatchingBrackets(state, pos, 1, config)
     || trySelectMatchingBrackets(state, pos + 1, -1, config, true)

package/dist/matchTag.d.ts

@@ -4,11 +4,12 @@ import type { EditorState } from '@codemirror/state';
 import type { MatchResult } from '@codemirror/language';
 import type { SyntaxNode } from '@lezer/common';
 declare type TagType = 'ext' | 'html';
-declare interface TagMatchResult extends MatchResult {
+export interface TagMatchResult extends MatchResult {
     start: Tag;
     end?: Tag;
 }
-declare class Tag {
+/** @test */
+export declare class Tag {
     readonly type: TagType;
     readonly name: string;
     readonly first: SyntaxNode;
@@ -24,12 +25,14 @@ declare class Tag {
  * 获取标签信息，破损的HTML标签会返回`null`
  * @param state
  * @param node 语法树节点
+ * @test
  */
 export declare const getTag: (state: EditorState, node: SyntaxNode) => Tag | null;
 /**
  * 匹配标签
  * @param state
  * @param pos 位置
+ * @test
  */
 export declare const matchTag: (state: EditorState, pos: number) => TagMatchResult | null;
 declare const _default: StateField<DecorationSet>;

package/dist/matchTag.js

@@ -3,7 +3,9 @@ import { StateField } from '@codemirror/state';
 import { ensureSyntaxTree } from '@codemirror/language';
 import { voidHtmlTags, selfClosingTags } from './config.js';
 import { matchingCls, nonmatchingCls } from './constants.js';
-class Tag {
+import { sliceDoc } from './util.js';
+/** @test */
+export class Tag {
     get closing() {
         return isClosing(this.first, this.type, this.state, true);
     }
@@ -32,13 +34,17 @@ const isTag = ({ name }) => /-(?:ext|html)tag-(?!bracket)/u.test(name), isTagCom
     const reHtml = new RegExp(`-htmltag-${s}`, 'u'), reExt = new RegExp(`-exttag-${s}`, 'u');
     return ({ name }, type) => (type === 'ext' ? reExt : reHtml).test(name);
 }, isBracket = isTagComponent('bracket'), isName = isTagComponent('name'), isClosing = (node, type, state, first) => isBracket(node, type)
-    && state.sliceDoc(node.from, node.to)[first ? 'endsWith' : 'startsWith']('/'), getName = (state, { from, to }) => state.sliceDoc(from, to).trim().toLowerCase();
+    && sliceDoc(state, node)[first ? 'endsWith' : 'startsWith']('/'), getName = (state, node) => sliceDoc(state, node).trim().toLowerCase();
 /**
  * 获取标签信息，破损的HTML标签会返回`null`
  * @param state
  * @param node 语法树节点
+ * @test
  */
 export const getTag = (state, node) => {
+    if (!isTag(node)) {
+        return null;
+    }
     const type = node.name.includes('exttag') ? 'ext' : 'html';
     let { nextSibling, prevSibling } = node, nameNode = isName(node, type) ? node : null;
     while (nextSibling && !isBracket(nextSibling, type)) {
@@ -87,18 +93,16 @@ const searchTag = (state, origin) => {
  * 匹配标签
  * @param state
  * @param pos 位置
+ * @test
  */
 export const matchTag = (state, pos) => {
     const tree = ensureSyntaxTree(state, pos);
     if (!tree) {
         return null;
     }
-    let node = tree.resolve(pos, -1);
+    let node = tree.resolveInner(pos, -1);
     if (!isTag(node)) {
-        node = tree.resolve(pos, 1);
-        if (!isTag(node)) {
-            return null;
-        }
+        node = tree.resolveInner(pos, 1);
     }
     const start = getTag(state, node);
     if (!start) {

package/dist/mediawiki.d.ts

@@ -4,6 +4,7 @@
  * @see https://gerrit.wikimedia.org/g/mediawiki/extensions/CodeMirror
  */
 import { LanguageSupport } from '@codemirror/language';
+import { EditorView } from '@codemirror/view';
 import { MediaWiki } from './token.js';
 import type { StreamParser, TagStyle } from '@codemirror/language';
 import type { CompletionSource, Completion } from '@codemirror/autocomplete';
@@ -13,8 +14,19 @@ import type { MwConfig } from './token';
  * @param name 节点名称
  */
 export declare const isWikiLink: (name: string) => boolean;
+/**
+ * 检查首字母大小写并插入正确的自动填充内容
+ * @param view
+ * @param completion 自动填充内容
+ * @param from 起始位置
+ * @param to 结束位置
+ * @test
+ */
+export declare const apply: (view: EditorView, completion: Completion, from: number, to: number) => void;
+/** @test */
 export declare class FullMediaWiki extends MediaWiki {
     #private;
+    readonly templatedata: boolean;
     readonly nsRegex: RegExp;
     readonly functionSynonyms: Completion[];
     readonly doubleUnderscore: Completion[];
@@ -25,7 +37,7 @@ export declare class FullMediaWiki extends MediaWiki {
     readonly htmlAttrs: Completion[];
     readonly elementAttrs: Map<string | undefined, Completion[]>;
     readonly extAttrs: Map<string, Completion[]>;
-    constructor(config: MwConfig);
+    constructor(config: MwConfig, templatedata?: boolean);
     /**
      * This defines the actual CSS class assigned to each tag/token.
      *
@@ -39,5 +51,6 @@ export declare class FullMediaWiki extends MediaWiki {
 /**
  * Get a LanguageSupport instance for the MediaWiki mode.
  * @param config Configuration for the MediaWiki mode
+ * @param templatedata Whether to enable template parameter autocompletion
  */
-export declare const mediawikiBase: (config: MwConfig) => LanguageSupport;
+export declare const mediawikiBase: (config: MwConfig, templatedata?: boolean) => LanguageSupport;

package/dist/mediawiki.js

@@ -9,9 +9,10 @@ import { insertCompletionText, pickedCompletion } from '@codemirror/autocomplete
 import { isUnderscore } from '@bhsd/cm-util';
 import { commonHtmlAttrs, htmlAttrs, extAttrs } from 'wikiparser-node/dist/util/sharable.mjs';
 import { htmlTags, tokens } from './config.js';
-import { isWMF, isolateSelector, ltrSelector } from './constants.js';
+import { hoverSelector, isWMF, } from './constants.js';
 import { MediaWiki } from './token.js';
-import { hasTag, braceStackUpdate, leadingSpaces, } from './util.js';
+import { hasTag, leadingSpaces, findTemplateName, } from './util.js';
+const ranks = { Required: 1, Suggested: 2, Optional: 3, Deprecated: 4 };
 /**
  * 是否是普通维基链接
  * @param name 节点名称
@@ -23,8 +24,9 @@ export const isWikiLink = (name) => /mw-[\w-]*link-ground/u.test(name);
  * @param completion 自动填充内容
  * @param from 起始位置
  * @param to 结束位置
+ * @test
  */
-const apply = (view, completion, from, to) => {
+export const apply = (view, completion, from, to) => {
     let { label } = completion, selection;
     const initial = label.charAt(0).toLowerCase(), { state } = view, after = state.sliceDoc(to);
     if (state.sliceDoc(from, from + 1) === initial) {
@@ -40,10 +42,12 @@ const apply = (view, completion, from, to) => {
         selection,
     });
 };
+/** @test */
 export class FullMediaWiki extends MediaWiki {
-    constructor(config) {
+    constructor(config, templatedata = false) {
         super(config);
         const { urlProtocols, nsid, functionSynonyms, doubleUnderscore, } = config;
+        this.templatedata = templatedata;
         this.nsRegex = new RegExp(String.raw `^(${Object.keys(nsid).filter(ns => ns !== '').join('|')
             .replace(/_/gu, ' ')})\s*:\s*`, 'iu');
         this.functionSynonyms = functionSynonyms.flatMap((obj, i) => Object.keys(obj).map((label) => ({
@@ -95,7 +99,6 @@ export class FullMediaWiki extends MediaWiki {
         const parser = super.mediawiki(tags);
         parser.languageData = {
             closeBrackets: { brackets: ['(', '[', '{', '"'], before: ')]}>' },
-            autocomplete: this.completionSource,
         };
         return parser;
     }
@@ -155,22 +158,29 @@ export class FullMediaWiki extends MediaWiki {
         return result?.length
             ? {
                 offset: leadingSpaces(search).length,
-                options: result.map(([key, detail]) => ({ type: 'variable', label: key + equal, detail })),
+                options: result.flatMap(([keys, detail, info, name]) => keys.map((key) => ({
+                    type: 'variable',
+                    label: key + equal,
+                    section: { name: name, rank: ranks[name] },
+                    ...detail && { detail },
+                    ...info && { info },
+                }))),
             }
             : undefined;
     }
     /** 自动补全魔术字和标签名 */
     get completionSource() {
         return async (context) => {
-            const { state, pos, explicit } = context, node = syntaxTree(state).resolve(pos, -1), { name: n, from: f, to: t, } = node, types = new Set(n.split('_')), isParserFunction = hasTag(types, 'parserFunctionName'), 
+            const { state, pos, explicit } = context, node = syntaxTree(state).resolveInner(pos, -1), { name: n, prevSibling, from: f, to: t, } = node, types = new Set(n.split('_')), isParserFunction = hasTag(types, 'parserFunctionName'), 
             /** 开头不包含` `，但可能包含`_` */ search = state.sliceDoc(f, pos).trimStart(), start = pos - search.length;
-            let { prevSibling } = node;
-            if (explicit || isParserFunction && search.includes('#') || isWMF) {
+            // 需要opensearch API的建议，只在显式触发时或WMF网站上提供
+            if (explicit || isWMF || isParserFunction && search.includes('#')) {
                 const obj = isWMF
                     ? null
                     : {
                         validFor: /^[^|{}<>[\]#]*$/u,
                     };
+                // 模板名
                 if (isParserFunction || hasTag(types, 'templateName')) {
                     const options = search.includes(':') ? [] : [...this.functionSynonyms], suggestions = await this.#linkSuggest(search, 10) ?? { offset: 0, options: [] };
                     options.push(...suggestions.options);
@@ -189,8 +199,12 @@ export class FullMediaWiki extends MediaWiki {
                         ...obj,
                     };
                 }
+                // 页面名
                 const isPage = hasTag(types, 'pageName') && hasTag(types, 'parserFunction') || 0;
                 if (isPage && search.trim() || hasTag(types, 'linkPageName')) {
+                    if (!this.config.linkSuggest) {
+                        return null;
+                    }
                     const isLink = isWikiLink(n);
                     let prefix = '', ns = 0;
                     if (isPage) {
@@ -218,34 +232,18 @@ export class FullMediaWiki extends MediaWiki {
                         ...obj,
                     };
                 }
+            }
+            // 需要TemplateData API的建议，只在显式触发时提供
+            if (this.config.paramSuggest
+                && (explicit || this.templatedata)
+                && this.tags.includes('templatedata')) {
                 const isArgument = hasTag(types, 'templateArgumentName'), prevIsDelimiter = prevSibling?.name.includes(tokens.templateDelimiter), isDelimiter = hasTag(types, 'templateDelimiter')
                     || hasTag(types, 'templateBracket') && prevIsDelimiter;
-                if (this.tags.includes('templatedata')
-                    && (isDelimiter
-                        || isArgument && !search.includes('=')
-                        || hasTag(types, 'template') && prevIsDelimiter)) {
-                    let stack = -1, 
-                    /** 可包含`_`、`:`等 */ page = '';
-                    while (prevSibling) {
-                        const { name, from, to } = prevSibling;
-                        if (name.includes(tokens.templateBracket)) {
-                            const [lbrace, rbrace] = braceStackUpdate(state, prevSibling);
-                            stack += lbrace;
-                            if (stack >= 0) {
-                                break;
-                            }
-                            stack += rbrace;
-                        }
-                        else if (stack === -1 && name.includes(tokens.templateName)) {
-                            page = state.sliceDoc(from, to) + page;
-                        }
-                        else if (page && !name.includes(tokens.comment)) {
-                            prevSibling = null;
-                            break;
-                        }
-                        ({ prevSibling } = prevSibling);
-                    }
-                    if (prevSibling && page) {
+                if (isDelimiter
+                    || isArgument && !search.includes('=')
+                    || hasTag(types, 'template') && prevIsDelimiter) {
+                    const page = findTemplateName(state, node);
+                    if (page) {
                         const equal = isArgument && state.sliceDoc(pos, t).trim() === '=' ? '' : '=', suggestions = await this.#paramSuggest(isDelimiter ? '' : search, page, equal);
                         if (suggestions && suggestions.options.length > 0) {
                             return {
@@ -293,10 +291,12 @@ export class FullMediaWiki extends MediaWiki {
                 'comment',
                 'templateVariableName',
                 'templateName',
+                'parserFunctionName',
                 'linkPageName',
                 'linkToSection',
                 'extLink',
             ])) {
+                // 不可能是状态开关、标签、协议或图片参数名
                 return null;
             }
             let mt = context.matchBefore(/__(?:(?!__)[\p{L}\p{N}_])*$/u);
@@ -374,7 +374,7 @@ const getSelector = (cls, prefix = '') => typeof prefix === 'string'
     : prefix.map(p => getSelector(cls, p)).join();
 const getGround = (type, ground) => ground ? `${type}${ground === 1 ? '' : ground}-` : '';
 const getGrounds = (grounds, r, g, b, a) => ({
-    [grounds.map(([template, ext, link]) => `.cm-mw-${getGround('template', template)}${getGround('exttag', ext)}${getGround('link', link)}ground`).join()]: {
+    [grounds.map(([template, ext, link]) => `.cm-mw-${getGround('template', template)}${getGround('ext', ext)}${getGround('link', link)}ground`).join()]: {
         backgroundColor: `rgb(${r},${g},${b},${a})`,
     },
 });
@@ -429,7 +429,7 @@ const theme = /* @__PURE__ */ EditorView.theme({
         color: 'var(--cm-tpl)',
         fontWeight: 'bold',
     },
-    '.cm-mw-template-argument-name': {
+    [getSelector(['-argument-name'], ['template', 'parserfunction'])]: {
         color: 'var(--cm-arg)',
         fontWeight: 'normal',
     },
@@ -507,19 +507,33 @@ const theme = /* @__PURE__ */ EditorView.theme({
     '.cm-mw-tag-ref': {
         backgroundColor: 'var(--cm-ref)',
     },
-    [`${isolateSelector}, &[dir="rtl"] .cm-mw-template-name`]: {
-        unicodeBidi: 'isolate',
+    // hover tooltip and signature tooltip
+    [hoverSelector]: {
+        padding: '2px 5px',
+        width: 'max-content',
+        maxWidth: '60vw',
+        maxHeight: '60vh',
+        overflowY: 'auto',
+    },
+    [`${hoverSelector} *`]: {
+        marginTop: '0!important',
+        marginBottom: '0!important',
     },
-    [ltrSelector]: {
-        direction: 'ltr',
-        display: 'inline-block',
+    [`${hoverSelector}>div`]: {
+        fontSize: '90%',
+        lineHeight: 1.4,
     },
 });
 /**
  * Get a LanguageSupport instance for the MediaWiki mode.
  * @param config Configuration for the MediaWiki mode
+ * @param templatedata Whether to enable template parameter autocompletion
  */
-export const mediawikiBase = (config) => {
-    const mode = new FullMediaWiki(config), lang = StreamLanguage.define(mode.mediawiki());
-    return new LanguageSupport(lang, [syntaxHighlighting(HighlightStyle.define(mode.getTagStyles())), theme]);
+export const mediawikiBase = (config, templatedata) => {
+    const mode = new FullMediaWiki(config, templatedata), lang = StreamLanguage.define(mode.mediawiki());
+    return new LanguageSupport(lang, [
+        syntaxHighlighting(HighlightStyle.define(mode.getTagStyles())),
+        theme,
+        lang.data.of({ autocomplete: mode.completionSource }),
+    ]);
 };