@bhsd/codemirror-mediawiki 3.1.0 → 3.2.0

package/README.md

@@ -2,10 +2,17 @@
 [![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)
 
+# @bhsd/codemirror-mediawiki
+
+This repository contains a modified version of the frontend scripts and styles from [MediaWiki extension CodeMirror](https://www.mediawiki.org/wiki/Extension:CodeMirror). The goal is to support a standalone integration between [CodeMirror](https://codemimrror.net) and [Wikitext](https://www.mediawiki.org/wiki/Wikitext), without the need for a [MediaWiki environment](https://doc.wikimedia.org/mediawiki-core/master/js/).
+
+Here is a [demo](https://bhsd-harry.github.io/codemirror-mediawiki). To experiment with the RTL (right-to-left) support, you can append `?rtl=1` to the URL.
+
+Nonetheless, this repository also provides a customized version with additional functionality for use on a MediaWiki site. Browser editing tools such as [Wikiplus-highlight](https://www.npmjs.com/package/wikiplus-highlight) and an [InPageEdit plugin](https://github.com/inpageedit/Plugins/blob/master/src/plugins/code-mirror/cm6.js) are built upon it. Please refer to a separate [README](./mw/README.md) file for the information.
+
 <details>
 	<summary>Expand</summary>
 
-- [Description](#description)
 - [Installation](#installation)
 - [Browser Usage](#browser-usage)
 	- [Download JavaScript](#download-javascript)
@@ -68,14 +75,6 @@
 
 </details>
 
-# Description
-
-This repository contains a modified version of the frontend scripts and styles from [MediaWiki extension CodeMirror](https://www.mediawiki.org/wiki/Extension:CodeMirror). The goal is to support a standalone integration between [CodeMirror](https://codemimrror.net) and [Wikitext](https://www.mediawiki.org/wiki/Wikitext), without the need for a [MediaWiki environment](https://doc.wikimedia.org/mediawiki-core/master/js/).
-
-Here is a [demo](https://bhsd-harry.github.io/codemirror-mediawiki). To experiment with the RTL (right-to-left) support, you can append `?rtl=1` to the URL.
-
-Nonetheless, this repository also provides a customized version with additional functionality for use on a MediaWiki site. Browser editing tools such as [Wikiplus-highlight](https://github.com/bhsd-harry/Wikiplus-highlight) and an [InPageEdit plugin](https://github.com/inpageedit/Plugins) are built upon it. Please refer to a separate [README](./mw/README.md) file for the information.
-
 # Installation
 
 You can install the package via npm and import it as a module:
@@ -234,6 +233,17 @@ import {registerHTMLCore} from '@bhsd/codemirror-mediawiki';
 registerHTMLCore();
 ```
 
+In addition to the common [extensions](#extensions), here are some HTML-specific extensions. Note that these extensions may not take effect if the corresponding common extensions are not registered:
+
+```js
+import {
+	registerCloseBracketsForHTML,
+	registerColorPickerForHTML,
+} from '@bhsd/codemirror-mediawiki';
+registerCloseBracketsForHTML();
+registerColorPickerForHTML();
+```
+
 </details>
 
 ## javascript
@@ -542,6 +552,23 @@ const tree = cm.getNodeAt(0);
 
 </details>
 
+## hasPreference
+
+<details>
+	<summary>Expand</summary>
+
+*version added: 3.2.0*
+
+**param**: `string` extension name  
+**returns**: `boolean`  
+Check if the editor enables the given extension.
+
+```js
+const hasAutocompletion = cm.hasPreference('autocompletion');
+```
+
+</details>
+
 ## initialize
 
 <details>
@@ -608,7 +635,7 @@ cm.localize({
 
 *version added: 2.0.9*
 
-**param**: `string[] | Record<string, boolean>` the preferred [CodeMirror extensions](https://codemirror.net/docs/extensions/)  
+**param**: `string[] | Record<string, boolean>` the [extensions](#extensions) to enable  
 Set the preferred CodeMirror extensions. Available extensions are introduced [later](#extensions).
 
 ```js
@@ -1151,6 +1178,9 @@ registerSignatureHelp();
 
 ## Syntax Highlighting
 
+<details>
+	<summary>Expand</summary>
+
 ### Extension
 
 1. [Extension:Translate](https://www.mediawiki.org/wiki/Extension:Translate) is not supported.
@@ -1183,3 +1213,5 @@ registerSignatureHelp();
 ### Language conversion
 
 1. BCP 47 language codes are not supported in language conversion ([Example](https://bhsd-harry.github.io/wikiparser-node/tests.html#Explicit%20definition%20of%20language%20variant%20alternatives%20(BCP%2047%20codes))).
+
+</details>

package/dist/codemirror.d.ts

@@ -4,17 +4,31 @@ import type { Extension } from '@codemirror/state';
 import type { SyntaxNode } from '@lezer/common';
 import type { ConfigData } from 'wikiparser-node';
 import type { MwConfig } from './token';
-import type { DocRange } from './fold';
+import type { DocRange, foldHandler } from './fold';
 import type { Option, LiveOption } from './linter';
 import type { LintSource, LintSourceGetter } from './lintsource';
+import type { detectIndent } from './indent';
+import type statusBar from './statusBar';
 export type AddonMain<T> = (config?: T, cm?: CodeMirror6) => Extension;
 export type Addon<T> = [AddonMain<T>, Record<string, T>?];
 export type Dialect = 'sanitized-css' | undefined;
+export interface MenuItem {
+    name: string;
+    isActionable(this: void, cm: CodeMirror6): boolean;
+    getItems(this: void, cm: CodeMirror6): HTMLDivElement[];
+}
+declare interface OptionalFunctions {
+    statusBar: typeof statusBar;
+    detectIndent: typeof detectIndent;
+    foldHandler: typeof foldHandler;
+}
 export declare const plain: () => Extension;
 export declare const languages: Record<string, (config?: any) => Extension>;
 export declare const avail: Record<string, Addon<any>>;
 export declare const linterRegistry: Record<string, LintSourceGetter>;
+export declare const menuRegistry: MenuItem[];
 export declare const destroyListeners: ((view: EditorView) => void)[];
+export declare const optionalFunctions: OptionalFunctions;
 /** CodeMirror 6 editor */
 export declare class CodeMirror6 {
     #private;
@@ -55,6 +69,11 @@ export declare class CodeMirror6 {
     lint(lintSource?: LintSource): void;
     /** Update syntax checking immediately */
     update(): void;
+    /**
+     * Check if the editor enables a specific extension
+     * @param name extension name
+     */
+    hasPreference(name: string): boolean;
     /**
      * Add extensions
      * @param names extension names
@@ -124,3 +143,4 @@ export declare class CodeMirror6 {
      */
     abstract static getMwConfig(config: ConfigData): MwConfig;
 }
+export {};

package/dist/codemirror.js

@@ -4,16 +4,25 @@ import { syntaxHighlighting, defaultHighlightStyle, indentOnInput, indentUnit, e
 import { defaultKeymap, historyKeymap, history, redo, indentWithTab } from '@codemirror/commands';
 import { searchKeymap } from '@codemirror/search';
 import { linter, lintGutter, lintKeymap } from '@codemirror/lint';
-import { foldHandler } from './fold';
-import statusBar from './statusBar';
-import { detectIndent } from './indent';
 export const plain = () => EditorView.contentAttributes.of({ spellcheck: 'true' });
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const languages = { plain };
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const avail = {};
 export const linterRegistry = {};
+export const menuRegistry = [];
 export const destroyListeners = [];
+export const optionalFunctions = {
+    statusBar() {
+        return [];
+    },
+    detectIndent(_, indent) {
+        return indent;
+    },
+    foldHandler() {
+        return () => { };
+    },
+};
 const editExtensions = new Set(['closeBrackets', 'autocompletion', 'signatureHelp']);
 const linters = {};
 const phrases = {};
@@ -33,6 +42,7 @@ export class CodeMirror6 {
     #visible = false;
     #preferred = new Set();
     #indentStr = '\t';
+    #nestedMWLanguage;
     /** textarea element */
     get textarea() {
         return this.#textarea;
@@ -62,6 +72,15 @@ export class CodeMirror6 {
             this.initialize(config);
         }
     }
+    /**
+     * 获取语言扩展
+     * @param config 语言设置
+     */
+    #getLanguage(config) {
+        const lang = (languages[this.#lang] ?? plain)(config);
+        this.#nestedMWLanguage = lang.nestedMWLanguage;
+        return lang;
+    }
     /**
      * Initialize the editor
      * @param config language configuration
@@ -69,7 +88,7 @@ export class CodeMirror6 {
     initialize(config) {
         let timer;
         const { textarea, lang } = this, { value, dir: d, accessKey, tabIndex, lang: l, readOnly } = textarea, extensions = [
-            this.#language.of(languages[lang](config)),
+            this.#language.of(this.#getLanguage(config)),
             this.#linter.of(linters[lang] ?? []),
             this.#extensions.of([]),
             this.#dir.of(EditorView.editorAttributes.of({ dir: d })),
@@ -126,7 +145,7 @@ export class CodeMirror6 {
                 : [
                     history(),
                     indentOnInput(),
-                    this.#indent.of(indentUnit.of(detectIndent(value, this.#indentStr, lang))),
+                    this.#indent.of(indentUnit.of(optionalFunctions.detectIndent(value, this.#indentStr, lang))),
                     keymap.of([
                         ...historyKeymap,
                         indentWithTab,
@@ -145,7 +164,7 @@ export class CodeMirror6 {
         this.#view.scrollDOM.style.fontSize = fontSize;
         this.#view.scrollDOM.style.lineHeight = lineHeight;
         this.toggle(true);
-        this.#view.dom.addEventListener('click', foldHandler(this.#view));
+        this.#view.dom.addEventListener('click', optionalFunctions.foldHandler(this.#view));
         this.prefer({});
     }
     /**
@@ -175,7 +194,7 @@ export class CodeMirror6 {
     async setLanguage(lang = 'plain', config) {
         this.#lang = lang;
         if (this.#view) {
-            const ext = (languages[lang] ?? plain)(config);
+            const ext = this.#getLanguage(config);
             this.#effects([
                 this.#language.reconfigure(ext),
                 this.#linter.reconfigure(linters[lang] ?? []),
@@ -202,7 +221,7 @@ export class CodeMirror6 {
                 }),
                 lintGutter(),
                 keymap.of(lintKeymap),
-                statusBar(lintSource.fixer),
+                optionalFunctions.statusBar(this, lintSource.fixer),
             ]
             : [];
         if (lintSource) {
@@ -227,6 +246,13 @@ export class CodeMirror6 {
             }
         }
     }
+    /**
+     * Check if the editor enables a specific extension
+     * @param name extension name
+     */
+    hasPreference(name) {
+        return this.#preferred.has(name);
+    }
     /**
      * Add extensions
      * @param names extension names
@@ -259,7 +285,7 @@ export class CodeMirror6 {
      */
     setIndent(indent) {
         if (this.#view) {
-            this.#effects(this.#indent.reconfigure(indentUnit.of(detectIndent(this.#view.state.doc, indent, this.#lang))));
+            this.#effects(this.#indent.reconfigure(indentUnit.of(optionalFunctions.detectIndent(this.#view.state.doc, indent, this.#lang))));
         }
         else {
             this.#indentStr = indent;
@@ -279,7 +305,7 @@ export class CodeMirror6 {
      * @param opt linter options
      */
     async getLinter(opt) {
-        return linterRegistry[this.#lang]?.(opt, this.#view);
+        return linterRegistry[this.#lang]?.(opt, this.#view, this.#nestedMWLanguage);
     }
     /**
      * Set content

package/dist/css.d.ts

@@ -1,4 +1,6 @@
 import { LanguageSupport } from '@codemirror/language';
+import type { Extension } from '@codemirror/state';
 import type { Dialect } from './codemirror';
+export declare const cssCompletion: (dialect?: Dialect) => Extension;
 declare const _default: (dialect: Dialect) => LanguageSupport;
 export default _default;

package/dist/css.js

@@ -1,6 +1,6 @@
 import { cssLanguage, cssCompletionSource } from '@codemirror/lang-css';
 import { LanguageSupport, syntaxTree } from '@codemirror/language';
-export default (dialect) => new LanguageSupport(cssLanguage, cssLanguage.data.of({
+export const cssCompletion = (dialect) => cssLanguage.data.of({
     autocomplete(context) {
         const { state, pos } = context, node = syntaxTree(state).resolveInner(pos, -1), result = cssCompletionSource(context);
         if (result) {
@@ -27,4 +27,5 @@ export default (dialect) => new LanguageSupport(cssLanguage, cssLanguage.data.of
         }
         return result;
     },
-}));
+});
+export default (dialect) => new LanguageSupport(cssLanguage, cssCompletion(dialect));