@bhsd/codemirror-mediawiki 2.28.0 → 2.28.2

package/README.md

@@ -8,6 +8,8 @@
 
 - [Description](#description)
 - [Usage](#usage)
+	- [JavaScript](#javascript)
+	- [CSS](#css)
 - [Constructor](#constructor)
 - [Accessors](#accessors)
 	- [lang](#lang)
@@ -15,6 +17,7 @@
 	- [view](#view)
 	- [visible](#visible)
 - [Methods](#methods)
+	- [destroy](#destroy)
 	- [extraKeys](#extrakeys)
 	- [getLinter](#getlinter)
 	- [getNodeAt](#getnodeat)
@@ -46,9 +49,11 @@
 	- [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)
@@ -67,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';
@@ -91,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>
@@ -161,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>
@@ -561,6 +595,12 @@ Show spaces and tabs as dots and arrows.
 
 Show the help information of a magic word when hovering.
 
+## inlayHints
+
+*version added: 2.22.0*
+
+Show inlay hints for anonymous parameters.
+
 ## openLinks
 
 *version added: 2.19.6*
@@ -579,23 +619,17 @@ Show the content of the `<ref>` tag defined elsewhere when hovering.
 
 Allow the editor to be scrolled down past the end of the document.
 
-## tagMatching
-
-*version added: 2.4.1*
-
-Matched or unmatched tags are highlighted in cyan or dark red when the cursor is inside.
-
 ## signatureHelp
 
 *version added: 2.21.1*
 
 Show the parser function signature when typing.
 
-## inlayHints
+## tagMatching
 
-*version added: 2.22.0*
+*version added: 2.4.1*
 
-Show inlay hints for anonymous parameters.
+Matched or unmatched tags are highlighted in cyan or dark red when the cursor is inside.
 
 # Known issues
 

package/dist/codemirror.d.ts

@@ -78,6 +78,8 @@ export declare class CodeMirror6 {
      * @param show 是否显示编辑器
      */
     toggle(show?: boolean): void;
+    /** 销毁实例 */
+    destroy(): void;
     /**
      * 添加额外快捷键
      * @param keys 快捷键

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/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 {};