@bhsd/codemirror-mediawiki 2.16.0 → 2.17.0

package/README.md

@@ -39,10 +39,11 @@
 	- [highlightWhitespace](#highlightwhitespace)
 	- [highlightTrailingWhitespace](#highlighttrailingwhitespace)
 	- [highlightSelectionMatches](#highlightselectionmatches)
-	- [escape](#escape)
 	- [codeFolding](#codefolding)
 	- [scrollPastEnd](#scrollpastend)
+	- [escape](#escape)
 	- [tagMatching](#tagmatching)
+	- [refHover](#refhover)
 
 </details>
 
@@ -279,32 +280,39 @@ Set the preferred CodeMirror extensions. Available extensions are introduced [la
 ```js
 cm.prefer([
 	'allowMultipleSelections',
+	'autocompletion',
 	'bracketMatching',
 	'closeBrackets',
 	'highlightActiveLine',
 	'highlightSpecialChars',
 	'highlightWhitespace',
 	'highlightTrailingWhitespace',
+	'highlightSelectionMatches',
+	'codeFolding',
+	'scrollPastEnd',
 
 	// only available in MediaWiki mode
 	'escape',
-	'codeFolding',
 	'tagMatching',
+	'refHover',
 ]);
 cm.prefer({
 	allowMultipleSelections: false,
 	autocompletion: false,
 	bracketMatching: false,
 	closeBrackets: false,
-	codeFolding: false,
 	highlightActiveLine: false,
 	highlightSpecialChars: false,
 	highlightWhitespace: false,
 	highlightTrailingWhitespace: false,
+	highlightSelectionMatches: false,
+	codeFolding: false,
+	scrollPastEnd: false,
 
 	// only available in MediaWiki mode
 	escape: false,
 	tagMatching: false,
+	refHover: false,
 });
 ```
 
@@ -494,15 +502,6 @@ Highlight trailing whitespace in a red-orange color.
 
 Highlight texts that match the selection in light green.
 
-## escape
-
-*version added: 2.2.2*
-
-Key bindings:
-
-- `Ctrl`/`Cmd` + `[`: Escape the selected text with HTML entities
-- `Ctrl`/`Cmd` + `]`: Escape the selected text with URL encoding
-
 ## codeFolding
 
 *version added: 2.3.0*
@@ -522,8 +521,23 @@ Key bindings:
 
 Allow the editor to be scrolled down past the end of the document.
 
+## escape
+
+*version added: 2.2.2*
+
+Key bindings:
+
+- `Ctrl`/`Cmd` + `[`: Escape the selected text with HTML entities
+- `Ctrl`/`Cmd` + `]`: Escape the selected text with URL encoding
+
 ## tagMatching
 
 *version added: 2.4.1*
 
 Matched or unmatched tags are highlighted in cyan or dark red when the cursor is inside.
+
+## refHover
+
+*version added: 2.17.0*
+
+Show the content of the `<ref>` tag defined elsewhere when hovering.

package/dist/config.d.ts

@@ -1,133 +1,130 @@
 /**
+ * @file Configuration for the MediaWiki highlighting mode for CodeMirror.
  * @author MusikAnimal and others
  * @license GPL-2.0-or-later
  * @see https://gerrit.wikimedia.org/g/mediawiki/extensions/CodeMirror
  */
 import { Tag } from '@lezer/highlight';
 /**
- * Configuration for the MediaWiki highlighting mode for CodeMirror.
+ * All HTML/XML tags permitted in MediaWiki Core.
+ *
+ * @see https://www.mediawiki.org/wiki/Extension:CodeMirror#Extension_integration
  */
-declare const modeConfig: {
-    /**
-     * All HTML/XML tags permitted in MediaWiki Core.
-     *
-     * @see https://www.mediawiki.org/wiki/Extension:CodeMirror#Extension_integration
-     */
-    htmlTags: string[];
-    /**
-     * HTML tags that are only self-closing.
-     */
-    voidHtmlTags: string[];
-    selfClosingTags: string[];
-    /**
-     * Mapping of MediaWiki-esque token identifiers to a standardized lezer highlighting tag.
-     * Values are one of the default highlighting tags.
-     *
-     * Once we allow use of other themes, we may want to tweak these values for aesthetic reasons.
-     *
-     * @see https://lezer.codemirror.net/docs/ref/#highlight.tags
-     * @internal
-     */
-    tokens: {
-        apostrophes: string;
-        comment: string;
-        convertBracket: string;
-        convertDelimiter: string;
-        convertFlag: string;
-        convertLang: string;
-        doubleUnderscore: string;
-        em: string;
-        error: string;
-        extLink: string;
-        extLinkBracket: string;
-        extLinkProtocol: string;
-        extLinkText: string;
-        extTag: string;
-        extTagAttribute: string;
-        extTagAttributeValue: string;
-        extTagBracket: string;
-        extTagName: string;
-        fileText: string;
-        freeExtLink: string;
-        freeExtLinkProtocol: string;
-        hr: string;
-        htmlEntity: string;
-        htmlTagAttribute: string;
-        htmlTagAttributeValue: string;
-        htmlTagBracket: string;
-        htmlTagName: string;
-        imageParameter: string;
-        linkBracket: string;
-        linkDelimiter: string;
-        linkPageName: string;
-        linkText: string;
-        linkToSection: string;
-        list: string;
-        magicLink: string;
-        pageName: string;
-        parserFunction: string;
-        parserFunctionBracket: string;
-        parserFunctionDelimiter: string;
-        parserFunctionName: string;
-        redirect: string;
-        section: string;
-        sectionHeader: string;
-        signature: string;
-        skipFormatting: string;
-        strong: string;
-        tableBracket: string;
-        tableCaption: string;
-        tableDefinition: string;
-        tableDefinitionValue: string;
-        tableDelimiter: string;
-        tableDelimiter2: string;
-        tableTd: string;
-        tableTh: string;
-        template: string;
-        templateArgumentName: string;
-        templateBracket: string;
-        templateDelimiter: string;
-        templateName: string;
-        templateVariable: string;
-        templateVariableBracket: string;
-        templateVariableDelimiter: string;
-        templateVariableName: string;
-    };
-    /**
-     * These are custom tokens (a.k.a. tags) that aren't mapped to any of the standardized tags.
-     *
-     * @todo pass parent Tags in Tag.define() where appropriate for better theming.
-     * @see https://codemirror.net/docs/ref/#language.StreamParser.tokenTable
-     * @see https://lezer.codemirror.net/docs/ref/#highlight.Tag%5Edefine
-     */
-    readonly tokenTable: Record<string, Tag>;
-    htmlAttrs: string[];
-    elementAttrs: {
-        table: string[];
-        td: string[];
-        th: string[];
-        blockquote: string[];
-        q: string[];
-        ins: string[];
-        del: string[];
-        time: string[];
-        ol: string[];
-        li: string[];
-        img: string[];
-        rt: string[];
-        data: string[];
-        meta: string[];
-        link: string[];
-        gallery: string[];
-        poem: string[];
-    };
-    extAttrs: {
-        indicator: string[];
-        langconvert: string[];
-        ref: string[];
-        references: string[];
-        charinsert: string[];
-        templatestyles: string[];
-    };
+export declare const htmlTags: string[], 
+/** HTML tags that are only self-closing. */
+voidHtmlTags: string[], 
+/** HTML tags that can be self-closing. */
+selfClosingTags: string[], 
+/**
+ * Mapping of MediaWiki-esque token identifiers to a standardized lezer highlighting tag.
+ * Values are one of the default highlighting tags.
+ *
+ * Once we allow use of other themes, we may want to tweak these values for aesthetic reasons.
+ *
+ * @see https://lezer.codemirror.net/docs/ref/#highlight.tags
+ * @internal
+ */
+tokens: {
+    apostrophes: string;
+    comment: string;
+    convertBracket: string;
+    convertDelimiter: string;
+    convertFlag: string;
+    convertLang: string;
+    doubleUnderscore: string;
+    em: string;
+    error: string;
+    extLink: string;
+    extLinkBracket: string;
+    extLinkProtocol: string;
+    extLinkText: string;
+    extTag: string;
+    extTagAttribute: string;
+    extTagAttributeValue: string;
+    extTagBracket: string;
+    extTagName: string;
+    fileText: string;
+    freeExtLink: string;
+    freeExtLinkProtocol: string;
+    hr: string;
+    htmlEntity: string;
+    htmlTagAttribute: string;
+    htmlTagAttributeValue: string;
+    htmlTagBracket: string;
+    htmlTagName: string;
+    imageParameter: string;
+    linkBracket: string;
+    linkDelimiter: string;
+    linkPageName: string;
+    linkText: string;
+    linkToSection: string;
+    list: string;
+    magicLink: string;
+    pageName: string;
+    parserFunction: string;
+    parserFunctionBracket: string;
+    parserFunctionDelimiter: string;
+    parserFunctionName: string;
+    redirect: string;
+    section: string;
+    sectionHeader: string;
+    signature: string;
+    skipFormatting: string;
+    strong: string;
+    tableBracket: string;
+    tableCaption: string;
+    tableDefinition: string;
+    tableDefinitionValue: string;
+    tableDelimiter: string;
+    tableDelimiter2: string;
+    tableTd: string;
+    tableTh: string;
+    template: string;
+    templateArgumentName: string;
+    templateBracket: string;
+    templateDelimiter: string;
+    templateName: string;
+    templateVariable: string;
+    templateVariableBracket: string;
+    templateVariableDelimiter: string;
+    templateVariableName: string;
+}, 
+/**
+ * These are custom tokens (a.k.a. tags) that aren't mapped to any of the standardized tags.
+ *
+ * @todo pass parent Tags in Tag.define() where appropriate for better theming.
+ * @see https://codemirror.net/docs/ref/#language.StreamParser.tokenTable
+ * @see https://lezer.codemirror.net/docs/ref/#highlight.Tag%5Edefine
+ */
+tokenTable: Record<string, Tag>, 
+/** Common HTML attributes permitted in MediaWiki Core. */
+htmlAttrs: string[], 
+/** HTML attributes that are only permitted on certain HTML tags. */
+elementAttrs: {
+    table: string[];
+    td: string[];
+    th: string[];
+    blockquote: string[];
+    q: string[];
+    ins: string[];
+    del: string[];
+    time: string[];
+    ol: string[];
+    li: string[];
+    img: string[];
+    rt: string[];
+    data: string[];
+    meta: string[];
+    link: string[];
+    gallery: string[];
+    poem: string[];
+}, 
+/** HTML attributes that are only permitted on certain extension tags. */
+extAttrs: {
+    indicator: string[];
+    langconvert: string[];
+    ref: string[];
+    references: string[];
+    charinsert: string[];
+    templatestyles: string[];
 };
-export default modeConfig;