@bhsd/codemirror-mediawiki 2.27.2 → 2.28.2

package/README.md

@@ -8,13 +8,16 @@
 
 - [Description](#description)
 - [Usage](#usage)
+	- [JavaScript](#javascript)
+	- [CSS](#css)
 - [Constructor](#constructor)
 - [Accessors](#accessors)
-	- [textarea](#textarea)
 	- [lang](#lang)
+	- [textarea](#textarea)
 	- [view](#view)
 	- [visible](#visible)
 - [Methods](#methods)
+	- [destroy](#destroy)
 	- [extraKeys](#extrakeys)
 	- [getLinter](#getlinter)
 	- [getNodeAt](#getnodeat)
@@ -26,6 +29,7 @@
 	- [setContent](#setcontent)
 	- [setIndent](#setindent)
 	- [setLanguage](#setlanguage)
+	- [setLineWrapping](#setlinewrapping)
 	- [toggle](#toggle)
 	- [update](#update)
 - [Static methods](#static-methods)
@@ -36,19 +40,21 @@
 	- [autocompletion](#autocompletion)
 	- [bracketMatching](#bracketmatching)
 	- [closeBrackets](#closebrackets)
-	- [highlightActiveLine](#highlightactiveline)
-	- [highlightSpecialChars](#highlightspecialchars)
-	- [highlightWhitespace](#highlightwhitespace)
-	- [highlightTrailingWhitespace](#highlighttrailingwhitespace)
-	- [highlightSelectionMatches](#highlightselectionmatches)
 	- [codeFolding](#codefolding)
-	- [scrollPastEnd](#scrollpastend)
 	- [colorPicker](#colorpicker)
 	- [escape](#escape)
-	- [tagMatching](#tagmatching)
-	- [refHover](#refhover)
+	- [highlightActiveLine](#highlightactiveline)
+	- [highlightSelectionMatches](#highlightselectionmatches)
+	- [highlightSpecialChars](#highlightspecialchars)
+	- [highlightTrailingWhitespace](#highlighttrailingwhitespace)
+	- [highlightWhitespace](#highlightwhitespace)
 	- [hover](#hover)
+	- [inlayHints](#inlayhints)
 	- [openLinks](#openlinks)
+	- [refHover](#refhover)
+	- [scrollPastEnd](#scrollpastend)
+	- [signatureHelp](#signaturehelp)
+	- [tagMatching](#tagmatching)
 - [Known issues](#known-issues)
 	- [Syntax Highlighting](#syntax-highlighting)
 
@@ -66,6 +72,8 @@ Nonetheless, this repository also provides a customized version with additional
 
 You can download the code via CDN, for example:
 
+## JavaScript
+
 ```js
 // static import
 import {CodeMirror6} from 'https://cdn.jsdelivr.net/npm/@bhsd/codemirror-mediawiki';
@@ -90,6 +98,18 @@ or
 const {CodeMirror6} = await import('https://unpkg.com/@bhsd/codemirror-mediawiki');
 ```
 
+## CSS
+
+```html
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@bhsd/codemirror-mediawiki/mediawiki.css">
+```
+
+or
+
+```html
+<link rel="stylesheet" href="https://unpkg.com/@bhsd/codemirror-mediawiki/mediawiki.css">
+```
+
 # Constructor
 
 <details>
@@ -114,25 +134,25 @@ const cm = new CodeMirror6(textarea, 'lua');
 
 # Accessors
 
-## textarea
+## lang
 
 <details>
 	<summary>Expand</summary>
 
-**type**: `HTMLTextAreaElement`  
-The textarea element replaced by CodeMirror, read-only.
+*version added: 2.0.14*
+
+**type**: `string`  
+The current language mode, read-only.
 
 </details>
 
-## lang
+## textarea
 
 <details>
 	<summary>Expand</summary>
 
-*version added: 2.0.14*
-
-**type**: `string`  
-The current language mode, read-only.
+**type**: `HTMLTextAreaElement`  
+The textarea element replaced by CodeMirror, read-only.
 
 </details>
 
@@ -160,6 +180,21 @@ Whether the editor is visible, read-only.
 
 # Methods
 
+## destroy
+
+<details>
+	<summary>Expand</summary>
+
+*version added: 2.28.2*
+
+Destroy the instance. This method is irrevocable and not recommended for general use. Instead, you should call the [`toggle`](#toggle) method to hide the editor.
+
+```js
+cm.destroy();
+```
+
+</details>
+
 ## extraKeys
 
 <details>
@@ -394,6 +429,23 @@ cm.setLanguage('lua');
 
 </details>
 
+## setLineWrapping
+
+<details>
+	<summary>Expand</summary>
+
+*version added: 2.28.0*
+
+**param**: `boolean` whether to enable line wrapping  
+Switch between line wrapping and no line wrapping.
+
+```js
+cm.setLineWrapping(false);
+cm.setLineWrapping(true);
+```
+
+</details>
+
 ## toggle
 
 <details>
@@ -483,32 +535,6 @@ Matched or unmatched brackets are highlighted in cyan or dark red when the curso
 
 Automatically close brackets (`{`, `[` and `(`) and quotes (`"`, and `'` except for the MediaWiki mode).
 
-## highlightActiveLine
-
-Highlight the line the cursor is on in light cyan.
-
-## highlightSpecialChars
-
-Show invisible characters as red dots.
-
-## highlightWhitespace
-
-*version added: 2.0.12*
-
-Show spaces and tabs as dots and arrows.
-
-## highlightTrailingWhitespace
-
-*version added: 2.0.9*
-
-Highlight trailing whitespace in a red-orange color.
-
-## highlightSelectionMatches
-
-*version added: 2.15.3*
-
-Highlight texts that match the selection in light green.
-
 ## codeFolding
 
 *version added: 2.3.0*
@@ -522,12 +548,6 @@ Key bindings:
 - `Ctrl` + `Alt` + `[`: Fold all
 - `Ctrl` + `Alt` + `]`: Unfold all
 
-## scrollPastEnd
-
-*version added: 2.15.3*
-
-Allow the editor to be scrolled down past the end of the document.
-
 ## colorPicker
 
 *version added: 2.18.0*
@@ -543,29 +563,37 @@ Key bindings:
 - `Ctrl`/`Cmd` + `[`: Escape the selected text with HTML entities
 - `Ctrl`/`Cmd` + `]`: Escape the selected text with URL encoding
 
-## tagMatching
+## highlightActiveLine
 
-*version added: 2.4.1*
+Highlight the line the cursor is on in light cyan.
 
-Matched or unmatched tags are highlighted in cyan or dark red when the cursor is inside.
+## highlightSelectionMatches
 
-## refHover
+*version added: 2.15.3*
 
-*version added: 2.17.1*
+Highlight texts that match the selection in light green.
 
-Show the content of the `<ref>` tag defined elsewhere when hovering.
+## highlightSpecialChars
 
-## hover
+Show invisible characters as red dots.
 
-*version added: 2.21.1*
+## highlightTrailingWhitespace
 
-Show the help information of a magic word when hovering.
+*version added: 2.0.9*
 
-## signatureHelp
+Highlight trailing whitespace in a red-orange color.
+
+## highlightWhitespace
+
+*version added: 2.0.12*
+
+Show spaces and tabs as dots and arrows.
+
+## hover
 
 *version added: 2.21.1*
 
-Show the parser function signature when typing.
+Show the help information of a magic word when hovering.
 
 ## inlayHints
 
@@ -579,6 +607,30 @@ Show inlay hints for anonymous parameters.
 
 CTRL/CMD-click opens a link in a new tab.
 
+## refHover
+
+*version added: 2.17.1*
+
+Show the content of the `<ref>` tag defined elsewhere when hovering.
+
+## scrollPastEnd
+
+*version added: 2.15.3*
+
+Allow the editor to be scrolled down past the end of the document.
+
+## signatureHelp
+
+*version added: 2.21.1*
+
+Show the parser function signature when typing.
+
+## tagMatching
+
+*version added: 2.4.1*
+
+Matched or unmatched tags are highlighted in cyan or dark red when the cursor is inside.
+
 # Known issues
 
 ## Syntax Highlighting

package/dist/codemirror.d.ts

@@ -12,11 +12,13 @@ export type LintSource = ((doc: Text) => Diagnostic[] | Promise<Diagnostic[]>) &
     fixer?: (doc: Text, rule?: string) => string | Promise<string>;
 };
 export type Addon<T> = [(config?: T, cm?: CodeMirror6) => Extension, Record<string, T>];
+export type Dialect = 'sanitized-css' | undefined;
 /** CodeMirror 6 编辑器 */
 export declare class CodeMirror6 {
     #private;
     getWikiConfig?: () => Promise<ConfigData>;
     langConfig: MwConfig | undefined;
+    dialect: Dialect;
     get textarea(): HTMLTextAreaElement;
     get view(): EditorView | undefined;
     get lang(): string;
@@ -56,6 +58,11 @@ export declare class CodeMirror6 {
      * @param indent 缩进字符串
      */
     setIndent(indent: string): void;
+    /**
+     * 设置文本换行
+     * @param wrapping 是否换行
+     */
+    setLineWrapping(wrapping: boolean): void;
     /**
      * 获取默认linter
      * @param opt 选项
@@ -71,6 +78,8 @@ export declare class CodeMirror6 {
      * @param show 是否显示编辑器
      */
     toggle(show?: boolean): void;
+    /** 销毁实例 */
+    destroy(): void;
     /**
      * 添加额外快捷键
      * @param keys 快捷键

package/dist/css.d.ts

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

package/dist/fold.d.ts

@@ -21,7 +21,6 @@ export declare const braceStackUpdate: (state: EditorState, node: SyntaxNode) =>
 export declare const foldable: (state: EditorState, posOrNode: number | SyntaxNode, tree?: Tree | null) => DocRange | false;
 export declare const foldableLine: ({ state, viewport: { to: end }, viewportLineBlocks }: EditorView, { from: f, to: t }: DocRange) => DocRange | false;
 declare const _default: [(e?: Extension | undefined) => Extension, {
-    lua: Extension[];
     mediawiki: (Extension | StateField<Tooltip | null>)[];
 }];
 export default _default;

package/dist/indent.d.ts

@@ -0,0 +1,8 @@
+export declare const noDetectionLangs: Set<string>;
+/**
+ * 检测文本的缩进方式
+ * @param text 文本内容
+ * @param defaultIndent 默认缩进方式
+ * @param lang 语言
+ */
+export declare const detectIndent: (text: string, defaultIndent: string, lang: string) => string;

package/dist/keybindings.mjs

@@ -24,7 +24,7 @@ const encapsulateLines = (text, pre, post) => {
   const lines = text.split("\n");
   return lines.map((line) => {
     var _a, _b;
-    const str = ((_b = (_a = /^(={1,6})(.+)\1$/u.exec(line)) == null ? void 0 : _a[2]) != null ? _b : line).trim();
+    const str = ((_b = (_a = /^(={1,6})(.+)\1\s*$/u.exec(line)) == null ? void 0 : _a[2]) != null ? _b : line).trim();
     return pre === " " || lines.length === 1 || line.trim() ? pre + str + post : str;
   }).join("\n");
 };

package/dist/linter.d.mts

@@ -3,7 +3,7 @@ import type { Linter } from 'eslint';
 import type { Warning } from 'stylelint';
 import type { Diagnostic } from 'luacheck-browserify';
 export type Option = Record<string, unknown> | null | undefined;
-export type LiveOption = (runtime?: true) => Option;
+export type LiveOption = (runtime?: boolean) => Option;
 declare type getLinter<T> = () => (text: string) => T;
 declare type asyncLinter<T, S = Record<string, unknown>> = ((text: string, config?: Option) => T) & {
     config?: S;
@@ -19,6 +19,13 @@ declare interface MixedDiagnostic extends Omit<DiagnosticBase, 'range'> {
     from?: number;
     to?: number;
 }
+declare interface JsonError {
+    message: string;
+    severity: 'error';
+    line: string | undefined;
+    column: string | undefined;
+    position: string | undefined;
+}
 /**
  * 获取 Wikitext LSP
  * @param opt 选项
@@ -31,13 +38,6 @@ export declare const getJsLinter: getAsyncLinter<Linter.LintMessage[]>;
 export declare const getCssLinter: getAsyncLinter<Promise<Warning[]>>;
 /** 获取 Luacheck */
 export declare const getLuaLinter: getAsyncLinter<Promise<Diagnostic[]>>;
-declare interface JsonError {
-    message: string;
-    severity: 'error';
-    line: string | undefined;
-    column: string | undefined;
-    position: string | undefined;
-}
 /** JSON.parse */
 export declare const getJsonLinter: getLinter<JsonError[]>;
 export {};

package/dist/linter.d.ts

@@ -3,7 +3,7 @@ import type { Linter } from 'eslint';
 import type { Warning } from 'stylelint';
 import type { Diagnostic } from 'luacheck-browserify';
 export type Option = Record<string, unknown> | null | undefined;
-export type LiveOption = (runtime?: true) => Option;
+export type LiveOption = (runtime?: boolean) => Option;
 declare type getLinter<T> = () => (text: string) => T;
 declare type asyncLinter<T, S = Record<string, unknown>> = ((text: string, config?: Option) => T) & {
     config?: S;
@@ -19,6 +19,13 @@ declare interface MixedDiagnostic extends Omit<DiagnosticBase, 'range'> {
     from?: number;
     to?: number;
 }
+declare interface JsonError {
+    message: string;
+    severity: 'error';
+    line: string | undefined;
+    column: string | undefined;
+    position: string | undefined;
+}
 /**
  * 获取 Wikitext LSP
  * @param opt 选项
@@ -31,13 +38,6 @@ export declare const getJsLinter: getAsyncLinter<Linter.LintMessage[]>;
 export declare const getCssLinter: getAsyncLinter<Promise<Warning[]>>;
 /** 获取 Luacheck */
 export declare const getLuaLinter: getAsyncLinter<Promise<Diagnostic[]>>;
-declare interface JsonError {
-    message: string;
-    severity: 'error';
-    line: string | undefined;
-    column: string | undefined;
-    position: string | undefined;
-}
 /** JSON.parse */
 export declare const getJsonLinter: getLinter<JsonError[]>;
 export {};