@bhsd/codemirror-mediawiki 2.0.12 → 2.0.14

package/README.md

@@ -8,7 +8,9 @@
 - [Usage](#usage)
 	- [constructor](#constructor)
 	- [textarea](#textarea)
+	- [lang](#lang)
 	- [view](#view)
+	- [getLinter](#getlinter)
 	- [lint](#lint)
 	- [prefer](#prefer)
 	- [setIndent](#setindent)
@@ -64,6 +66,18 @@ The textarea element replaced by CodeMirror.
 
 </details>
 
+## lang
+
+<details>
+	<summary>Expand</summary>
+
+*version added: 2.0.13*
+
+**type**: `string`  
+The current language mode.
+
+</details>
+
 ## view
 
 <details>
@@ -74,23 +88,35 @@ The CodeMirror EditorView instance.
 
 </details>
 
+## getLinter
+
+<details>
+	<summary>Expand</summary>
+
+*version added: 2.0.13*
+
+**returns**: `Promise<(doc: Text) => Diagnostic[] | Promise<Diagnostic[]>>`  
+Get the default linting function, which can be used as the argument of [`lint`](#lint).
+
+</details>
+
 ## lint
 
 <details>
 	<summary>Expand</summary>
 
-**param**: `(str: string) => Diagnostic[] | Promise<Diagnostic[]>` the linting function  
+**param**: `(doc: Text) => Diagnostic[] | Promise<Diagnostic[]>` the linting function  
 Set the linting function.
 
 ```js
-cm.lint( ( str ) => [
+cm.lint( ( doc ) => [
 	/**
 	 * @type {Diagnostic}
 	 * @see https://codemirror.net/docs/ref/#lint.Diagnostic
 	 */
 	{
 		from: 0,
-		to: str.length,
+		to: doc.toString().length,
 		message: 'error message',
 		severity: 'error',
 	},
@@ -104,6 +130,8 @@ cm.lint( ( str ) => [
 <details>
 	<summary>Expand</summary>
 
+*version added: 2.0.9*
+
 **param**: `string` the preferred [CodeMirror extensions](https://codemirror.net/docs/extensions/)  
 Set the preferred CodeMirror extensions.
 
@@ -125,6 +153,8 @@ cm.prefer( [
 <details>
 	<summary>Expand</summary>
 
+*version added: 2.0.8*
+
 **param**: `string` the indentation string, default as tab  
 Set the indentation string.
 

package/dist/codemirror.d.ts

@@ -1,8 +1,11 @@
 import { EditorView } from '@codemirror/view';
+import type { Text } from '@codemirror/state';
 import type { Diagnostic } from '@codemirror/lint';
 export type { MwConfig } from './mediawiki';
+export type LintSource = (doc: Text) => Diagnostic[] | Promise<Diagnostic[]>;
 export declare class CodeMirror6 {
     #private;
+    lang: string;
     get textarea(): HTMLTextAreaElement;
     get view(): EditorView;
     /**
@@ -21,11 +24,13 @@ export declare class CodeMirror6 {
      * 开始语法检查
      * @param lintSource 语法检查函数
      */
-    lint(lintSource?: (str: string) => Diagnostic[] | Promise<Diagnostic[]>): void;
+    lint(lintSource?: LintSource): void;
     /** 立即更新语法检查 */
     update(): void;
     /** 添加扩展 */
     prefer(names: string[]): void;
     /** 设置缩进 */
     setIndent(indent: string): void;
+    /** 获取默认linter */
+    getLinter(): Promise<LintSource>;
 }