@bhsd/codemirror-mediawiki 2.1.1 → 2.1.3

package/README.md

@@ -10,11 +10,13 @@
 	- [textarea](#textarea)
 	- [lang](#lang)
 	- [view](#view)
+	- [visible](#visible)
 	- [getLinter](#getlinter)
 	- [lint](#lint)
 	- [prefer](#prefer)
 	- [setIndent](#setindent)
 	- [setLanguage](#setlanguage)
+	- [toggle](#toggle)
 	- [update](#update)
 
 </details>
@@ -31,14 +33,14 @@ You can download the code via CDN, for example:
 
 ```js
 // static import
-import { CodeMirror6 } from 'https://cdn.jsdelivr.net/npm/@bhsd/codemirror-mediawiki@2.0.8/dist/main.min.js';
+import {CodeMirror6} from 'https://cdn.jsdelivr.net/npm/@bhsd/codemirror-mediawiki/dist/main.min.js';
 ```
 
 or
 
 ```js
 // dynamic import
-const { CodeMirror6 } = await import( 'https://cdn.jsdelivr.net/npm/@bhsd/codemirror-mediawiki@2.0.8/dist/main.min.js' );
+const {CodeMirror6} = await import('https://cdn.jsdelivr.net/npm/@bhsd/codemirror-mediawiki/dist/main.min.js');
 ```
 
 ## constructor
@@ -51,7 +53,13 @@ const { CodeMirror6 } = await import( 'https://cdn.jsdelivr.net/npm/@bhsd/codemi
 **param**: `unknown` the optional language configuration  
 
 ```js
-const cm = new CodeMirror6( textarea, 'css' );
+const cm = new CodeMirror6(textarea); // plain text
+const cm = new CodeMirror6(textarea, 'mediawiki', mwConfig);
+const cm = new CodeMirror6(textarea, 'html', mwConfig); // mixed MediaWiki-HTML
+const cm = new CodeMirror6(textarea, 'css');
+const cm = new CodeMirror6(textarea, 'javascript');
+const cm = new CodeMirror6(textarea, 'json');
+const cm = new CodeMirror6(textarea, 'lua');
 ```
 
 </details>
@@ -62,7 +70,7 @@ const cm = new CodeMirror6( textarea, 'css' );
 	<summary>Expand</summary>
 
 **type**: `HTMLTextAreaElement`  
-The textarea element replaced by CodeMirror.
+The textarea element replaced by CodeMirror, read-only.
 
 </details>
 
@@ -74,7 +82,7 @@ The textarea element replaced by CodeMirror.
 *version added: 2.0.13*
 
 **type**: `string`  
-The current language mode.
+The current language mode, read-only.
 
 </details>
 
@@ -84,7 +92,19 @@ The current language mode.
 	<summary>Expand</summary>
 
 **type**: [`EditorView`](https://codemirror.net/6/docs/ref/#view.EditorView)  
-The CodeMirror EditorView instance.
+The CodeMirror EditorView instance, read-only.
+
+</details>
+
+## visible
+
+<details>
+	<summary>Expand</summary>
+
+*version added: 2.1.3*
+
+**type**: `boolean`  
+Whether the editor is visible, read-only.
 
 </details>
 
@@ -93,11 +113,19 @@ The CodeMirror EditorView instance.
 <details>
 	<summary>Expand</summary>
 
-*version added: 2.0.13*
+*version added: 2.1.3*
 
+**param**: `Record<string, any>` the optional linter configuration
 **returns**: `Promise<(doc: Text) => Diagnostic[] | Promise<Diagnostic[]>>`  
 Get the default linting function, which can be used as the argument of [`lint`](#lint).
 
+```js
+const linter = await cm.getLinter(); // default linter configuration
+const linterMediawiki = await cm.getLinter({include}); // wikilint configuration
+const linterJavaScript = await cm.getLinter({env, parserOptions, rules}); // ESLint configuration
+const linterCSS = await cm.getLinter({rules}); // Stylelint configuration
+```
+
 </details>
 
 ## lint
@@ -109,7 +137,7 @@ Get the default linting function, which can be used as the argument of [`lint`](
 Set the linting function.
 
 ```js
-cm.lint( ( doc ) => [
+cm.lint(doc => [
 	/**
 	 * @type {Diagnostic}
 	 * @see https://codemirror.net/docs/ref/#lint.Diagnostic
@@ -120,7 +148,7 @@ cm.lint( ( doc ) => [
 		message: 'error message',
 		severity: 'error',
 	},
-] );
+]);
 ```
 
 </details>
@@ -136,14 +164,14 @@ cm.lint( ( doc ) => [
 Set the preferred CodeMirror extensions.
 
 ```js
-cm.prefer( [
+cm.prefer([
 	'bracketMatching',
 	'closeBrackets',
 	'highlightActiveLine',
 	'highlightSpecialChars',
 	'highlightWhitespace',
 	'highlightTrailingWhitespace',
-] );
+]);
 ```
 
 </details>
@@ -159,7 +187,8 @@ cm.prefer( [
 Set the indentation string.
 
 ```js
-cm.setIndent( ' '.repeat( 2 ) );
+cm.setIndent(' '.repeat(2));
+cm.setIndent('\t');
 ```
 
 </details>
@@ -174,20 +203,39 @@ cm.setIndent( ' '.repeat( 2 ) );
 Set the language mode.
 
 ```js
-cm.setLanguage( 'css' );
+cm.setLanguage('mediawiki', mwConfig);
+cm.setLanguage('html', mwConfig); // mixed MediaWiki-HTML
+cm.setLanguage('css');
+cm.setLanguage('javascript');
+cm.setLanguage('json');
+cm.setLanguage('lua');
 ```
 
 </details>
 
-## update
+## toggle
 
 <details>
 	<summary>Expand</summary>
 
-Refresh linting immediately.
+*version added: 2.1.3*
+
+**param**: `boolean` whether to show the editor, optional  
+Switch between the CodeMirror editor and the native textarea.
 
 ```js
-cm.update();
+cm.toggle();
+cm.toggle(true); // show CodeMirror
+cm.toggle(false); // hide CodeMirror
 ```
 
 </details>
+
+## update
+
+<details>
+	<summary>Expand</summary>
+
+Refresh linting immediately.
+
+</details>

package/dist/codemirror.d.ts

@@ -5,9 +5,10 @@ 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;
+    get lang(): string;
+    get visible(): boolean;
     /**
      * @param textarea 文本框
      * @param lang 语言
@@ -27,10 +28,21 @@ export declare class CodeMirror6 {
     lint(lintSource?: LintSource): void;
     /** 立即更新语法检查 */
     update(): void;
-    /** 添加扩展 */
+    /**
+     * 添加扩展
+     * @param names 扩展名
+     */
     prefer(names: readonly string[]): void;
-    /** 设置缩进 */
+    /**
+     * 设置缩进
+     * @param indent 缩进字符串
+     */
     setIndent(indent: string): void;
     /** 获取默认linter */
-    getLinter(): Promise<LintSource>;
+    getLinter(opt?: Record<string, unknown>): Promise<LintSource | undefined>;
+    /**
+     * 在编辑器和文本框之间切换
+     * @param show 是否显示编辑器
+     */
+    toggle(show?: boolean): void;
 }

package/dist/config.d.ts

@@ -6,16 +6,11 @@
 import { Tag } from '@lezer/highlight';
 /**
  * Configuration for the MediaWiki highlighting mode for CodeMirror.
- * This is a separate class mainly to keep static configuration out of
- * the logic in CodeMirrorModeMediaWiki.
  */
 export declare const modeConfig: {
     /**
      * All HTML/XML tags permitted in MediaWiki Core.
      *
-     * Extensions should use the CodeMirrorTagModes extension attribute to register tags
-     * instead of adding them here.
-     *
      * @see https://www.mediawiki.org/wiki/Extension:CodeMirror#Extension_integration
      */
     permittedHtmlTags: Set<string>;
@@ -25,14 +20,9 @@ export declare const modeConfig: {
     implicitlyClosedHtmlTags: Set<string>;
     /**
      * Mapping of MediaWiki-esque token identifiers to a standardized lezer highlighting tag.
-     * Values are one of the default highlighting tags. The idea is to use as many default tags as
-     * possible so that theming (such as dark mode) can be applied with minimal effort. The
-     * semantic meaning of the tag may not really match how it is used, but as per CodeMirror docs,
-     * this is fine. It's still better to make use of the standard tags in some way.
+     * 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.
-     * The values here can freely be changed. The actual CSS class used is defined further down
-     * in highlightStyle().
      *
      * @see https://lezer.codemirror.net/docs/ref/#highlight.tags
      * @internal
@@ -130,7 +120,6 @@ export declare const modeConfig: {
     };
     /**
      * These are custom tokens (a.k.a. tags) that aren't mapped to any of the standardized tags.
-     * Make sure these are also defined in tags() above.
      *
      * TODO: pass parent Tags in Tag.define() where appropriate for better theming.
      *