@bhsd/codemirror-mediawiki 2.4.5 → 2.5.0

package/README.md

@@ -25,6 +25,7 @@
 	- [toggle](#toggle)
 	- [update](#update)
 - [Static methods](#static-methods)
+	- [getMwConfig](#getmwconfig)
 	- [replaceSelections](#replaceselections)
 - [Extensions](#extensions)
 	- [allowMultipleSelections](#allowmultipleselections)
@@ -46,20 +47,34 @@ This repository contains a modified version of the frontend scripts and styles f
 
 Here is a [demo](https://bhsd-harry.github.io/codemirror-mediawiki).
 
+Nonetheless, this repository also provides a customized version with additional functionality for use in 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.
+
 # Usage
 
 You can download the code via CDN, for example:
 
 ```js
 // static import
-import {CodeMirror6} from 'https://cdn.jsdelivr.net/npm/@bhsd/codemirror-mediawiki/dist/main.min.js';
+import {CodeMirror6} from 'https://cdn.jsdelivr.net/npm/@bhsd/codemirror-mediawiki';
+```
+
+or
+
+```js
+import {CodeMirror6} from 'https://unpkg.com/@bhsd/codemirror-mediawiki';
 ```
 
 or
 
 ```js
 // dynamic import
-const {CodeMirror6} = await import('https://cdn.jsdelivr.net/npm/@bhsd/codemirror-mediawiki/dist/main.min.js');
+const {CodeMirror6} = await import('https://cdn.jsdelivr.net/npm/@bhsd/codemirror-mediawiki');
+```
+
+or
+
+```js
+const {CodeMirror6} = await import('https://unpkg.com/@bhsd/codemirror-mediawiki');
 ```
 
 # Constructor
@@ -354,6 +369,23 @@ Refresh linting immediately.
 
 # Static methods
 
+## getMwConfig
+
+<details>
+	<summary>Expand</summary>
+
+*version added: 2.4.7*
+
+**param**: [`Config`](https://github.com/bhsd-harry/wikiparser-node/wiki/types#config) the [WikiLint](https://npmjs.com/package/wikilint) configuration  
+**returns**: `MwConfig`  
+Derive the configuration for the MediaWiki mode from WikiLint configuration.
+
+```js
+const mwConfig = CodeMirror6.getMwConfig(config);
+```
+
+</details>
+
 ## replaceSelections
 
 <details>
@@ -361,7 +393,7 @@ Refresh linting immediately.
 
 *version added: 2.2.2*
 
-**param**: [`EditorView`](https://codemirror.net/6/docs/ref/#view.EditorView) the CodeMirror EditorView instance
+**param**: [`EditorView`](https://codemirror.net/6/docs/ref/#view.EditorView) the CodeMirror EditorView instance  
 **param**: `(str: string) => string` the replacement function  
 Replace the selected text with the return value of the replacement function.
 
@@ -379,6 +411,12 @@ CodeMirror6.replaceSelections(cm.view, str => str.toUpperCase());
 
 Allow multiple selections.
 
+## autocompletion
+
+*version added: 2.5.0*
+
+Provide autocompletion for the MediaWiki mode.
+
 ## bracketMatching
 
 *version added: 2.0.9*

package/dist/codemirror.d.ts

@@ -3,7 +3,9 @@ import type { KeyBinding } from '@codemirror/view';
 import type { Text } from '@codemirror/state';
 import type { SyntaxNode } from '@lezer/common';
 import type { Diagnostic } from '@codemirror/lint';
-export type { MwConfig } from './mediawiki';
+import type { Config } from 'wikilint';
+import type { MwConfig } from './mediawiki';
+export type { MwConfig };
 export type LintSource = (doc: Text) => Diagnostic[] | Promise<Diagnostic[]>;
 export declare const CDN = "https://testingcf.jsdelivr.net";
 export declare class CodeMirror6 {
@@ -77,4 +79,9 @@ export declare class CodeMirror6 {
      * @param func 替换函数
      */
     static replaceSelections(view: EditorView, func: (str: string) => string): void;
+    /**
+     * 将wikiparser-node设置转换为codemirror-mediawiki设置
+     * @param config
+     */
+    static getMwConfig(config: Config): MwConfig;
 }