@bhsd/codemirror-mediawiki 3.9.2 → 3.10.1

package/README.md

@@ -1,10 +1,10 @@
+# @bhsd/codemirror-mediawiki
+
 [![npm version](https://badge.fury.io/js/@bhsd%2Fcodemirror-mediawiki.svg)](https://www.npmjs.com/package/@bhsd/codemirror-mediawiki)
 [![CodeQL](https://github.com/bhsd-harry/codemirror-mediawiki/actions/workflows/codeql.yml/badge.svg)](https://github.com/bhsd-harry/codemirror-mediawiki/actions/workflows/codeql.yml)
 [![jsDelivr hits (npm scoped)](https://img.shields.io/jsdelivr/npm/hm/%40bhsd/codemirror-mediawiki)](https://www.npmjs.com/package/@bhsd/codemirror-mediawiki)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/972fd5f6684c4fd8ac2f26e01d349948)](https://app.codacy.com/gh/bhsd-harry/codemirror-mediawiki/dashboard)
 
-# @bhsd/codemirror-mediawiki
-
 This repository contains a modified version of the frontend scripts and styles from [MediaWiki extension CodeMirror](https://www.mediawiki.org/wiki/Extension:CodeMirror). The goal is to support a standalone integration between [CodeMirror](https://codemimrror.net) and [Wikitext](https://www.mediawiki.org/wiki/Wikitext), without the need for a [MediaWiki environment](https://doc.wikimedia.org/mediawiki-core/master/js/).
 
 Here is a [demo](https://bhsd-harry.github.io/codemirror-mediawiki). To experiment with the RTL (right-to-left) support, you can append `?rtl=1` to the URL.
@@ -19,6 +19,7 @@ If you are just looking for a CodeMirror 6 language mode and language support ex
 - [Installation](#installation)
 - [Browser Usage](#browser-usage)
 - [Language modes](#language-modes)
+	- [abusefilter](#abusefilter)
 	- [css](#css)
 	- [html](#html)
 	- [javascript](#javascript)
@@ -64,6 +65,7 @@ If you are just looking for a CodeMirror 6 language mode and language support ex
 - [Extensions](#extensions)
 	- [allowMultipleSelections](#allowmultipleselections)
 	- [autocompletion](#autocompletion)
+	- [bidiIsolates](#bidiisolates)
 	- [bracketMatching](#bracketmatching)
 	- [closeBrackets](#closebrackets)
 	- [codeFolding](#codefolding)
@@ -85,7 +87,7 @@ If you are just looking for a CodeMirror 6 language mode and language support ex
 
 </details>
 
-# Installation
+## Installation
 
 You can install the package via npm and import it as a module:
 
@@ -103,10 +105,11 @@ import {
 	registerJSON,
 	registerLua,
 	registerVue,
+	registerAbuseFilter,
 } from '@bhsd/codemirror-mediawiki';
 ```
 
-# Browser Usage
+## Browser Usage
 
 <details>
 	<summary>Expand</summary>
@@ -124,6 +127,7 @@ import {
 	registerJSON,
 	registerLua,
 	registerVue,
+	registerAbuseFilter,
 } from 'https://cdn.jsdelivr.net/npm/@bhsd/codemirror-mediawiki';
 ```
 
@@ -139,6 +143,7 @@ import {
 	registerJSON,
 	registerLua,
 	registerVue,
+	registerAbuseFilter,
 } from 'https://unpkg.com/@bhsd/codemirror-mediawiki/dist/main.min.js';
 ```
 
@@ -155,6 +160,7 @@ const {
 	registerJSON,
 	registerLua,
 	registerVue,
+	registerAbuseFilter,
 } = await import('https://cdn.jsdelivr.net/npm/@bhsd/codemirror-mediawiki');
 ```
 
@@ -170,14 +176,38 @@ const {
 	registerJSON,
 	registerLua,
 	registerVue,
+	registerAbuseFilter,
 } = await import('https://unpkg.com/@bhsd/codemirror-mediawiki/dist/main.min.js');
 ```
 
 </details>
 
-# Language modes
+## Language modes
+
+### abusefilter
+
+*version added: 3.10.0*
+
+<details>
+	<summary>Expand</summary>
+
+You can bundle the [AbuseFilter](https://www.mediawiki.org/wiki/Extension:AbuseFilter) mode by importing the `registerAbuseFilter` function:
+
+```js
+import {registerAbuseFilter} from '@bhsd/codemirror-mediawiki';
+registerAbuseFilter();
+```
+
+If you want a more granular control over the extensions, you can import the `registerAbuseFilterCore` function and the desired extensions:
+
+```js
+import {registerAbuseFilterCore} from '@bhsd/codemirror-mediawiki';
+registerAbuseFilterCore();
+```
+
+</details>
 
-## css
+### css
 
 <details>
 	<summary>Expand</summary>
@@ -205,7 +235,7 @@ registerColorPickerForCSS();
 
 </details>
 
-## html
+### html
 
 <details>
 	<summary>Expand</summary>
@@ -228,16 +258,18 @@ In addition to the common [extensions](#extensions), here are some HTML-specific
 
 ```js
 import {
+	registerBracketMatchingForHTML,
 	registerCloseBracketsForHTML,
 	registerColorPickerForHTML,
 } from '@bhsd/codemirror-mediawiki';
+registerBracketMatchingForHTML();
 registerCloseBracketsForHTML();
 registerColorPickerForHTML();
 ```
 
 </details>
 
-## javascript
+### javascript
 
 <details>
 	<summary>Expand</summary>
@@ -258,7 +290,7 @@ registerJavaScriptCore();
 
 </details>
 
-## json
+### json
 
 <details>
 	<summary>Expand</summary>
@@ -279,7 +311,7 @@ registerJSONCore();
 
 </details>
 
-## lua
+### lua
 
 <details>
 	<summary>Expand</summary>
@@ -300,7 +332,7 @@ registerLuaCore();
 
 </details>
 
-## mediawiki
+### mediawiki
 
 <details>
 	<summary>Expand</summary>
@@ -309,7 +341,8 @@ You can bundle the MediaWiki mode by importing the `registerMediaWiki` function:
 
 ```js
 import {registerMediaWiki} from '@bhsd/codemirror-mediawiki';
-registerMediaWiki();
+// optionally pass the article path of a MediaWiki site
+registerMediaWiki('https://www.mediawiki.org/wiki/');
 ```
 
 The MediaWiki mode provides the following key bindings for quick formatting:
@@ -333,7 +366,8 @@ If you want a more granular control over the extensions, you can import the `reg
 
 ```js
 import {registerMediaWikiCore} from '@bhsd/codemirror-mediawiki';
-registerMediaWikiCore();
+// optionally pass the article path of a MediaWiki site
+registerMediaWikiCore('https://www.mediawiki.org/wiki/');
 ```
 
 In addition to the common [extensions](#extensions), here are some MediaWiki-specific extensions. Note that these extensions may not take effect if the corresponding common extensions are not registered:
@@ -351,7 +385,7 @@ registerCodeFoldingForMediaWiki();
 
 </details>
 
-## vue
+### vue
 
 <details>
 	<summary>Expand</summary>
@@ -383,7 +417,7 @@ registerColorPickerForVue();
 
 </details>
 
-## Other languages
+### Other languages
 
 <details>
 	<summary>Expand</summary>
@@ -406,13 +440,13 @@ registerLanguageCore('python', python);
 
 </details>
 
-# Themes
+## Themes
 
-## light
+### light
 
 This is the default theme, which is a light theme.
 
-## nord
+### nord
 
 <details>
 	<summary>Expand</summary>
@@ -426,7 +460,7 @@ registerTheme('nord', nord);
 
 </details>
 
-## Other themes
+### Other themes
 
 <details>
 	<summary>Expand</summary>
@@ -441,14 +475,14 @@ registerTheme('one-dark', oneDark);
 
 </details>
 
-# Constructor
+## Constructor
 
 <details>
 	<summary>Expand</summary>
 
 **param**: `HTMLTextAreaElement` the textarea element to be replaced by CodeMirror  
 **param**: `string` the language mode to be used, default as plain text  
-**param**: `unknown` the language configuration, only required for the MediaWiki mode and the mixed MediaWiki-HTML mode  
+**param**: `unknown` the language configuration, only required for the [MediaWiki](#mediawiki) mode and the [mixed MediaWiki-HTML](#html) mode  
 **param**: `boolean` whether to initialize immediately, default as true  
 
 ```js
@@ -461,13 +495,14 @@ cm = new CodeMirror6(textarea, 'javascript');
 cm = new CodeMirror6(textarea, 'json');
 cm = new CodeMirror6(textarea, 'lua');
 cm = new CodeMirror6(textarea, 'vue');
+cm = new CodeMirror6(textarea, 'abusefilter', dialect);
 ```
 
 </details>
 
-# Accessors
+## Accessors
 
-## dialect
+### dialect
 
 <details>
 	<summary>Expand</summary>
@@ -479,7 +514,7 @@ Only used for [Extension:TemplateStyles](https://www.mediawiki.org/wiki/Extensio
 
 </details>
 
-## lang
+### lang
 
 <details>
 	<summary>Expand</summary>
@@ -491,7 +526,7 @@ The current language mode, read-only.
 
 </details>
 
-## textarea
+### textarea
 
 <details>
 	<summary>Expand</summary>
@@ -501,7 +536,7 @@ The textarea element replaced by CodeMirror, read-only.
 
 </details>
 
-## view
+### view
 
 <details>
 	<summary>Expand</summary>
@@ -511,7 +546,7 @@ The CodeMirror EditorView instance, read-only.
 
 </details>
 
-## visible
+### visible
 
 <details>
 	<summary>Expand</summary>
@@ -523,9 +558,9 @@ Whether the editor is visible, read-only.
 
 </details>
 
-# Methods
+## Methods
 
-## destroy
+### destroy
 
 <details>
 	<summary>Expand</summary>
@@ -540,7 +575,7 @@ cm.destroy();
 
 </details>
 
-## extraKeys
+### extraKeys
 
 <details>
 	<summary>Expand</summary>
@@ -558,7 +593,7 @@ cm.extraKeys([
 
 </details>
 
-## getLinter
+### getLinter
 
 <details>
 	<summary>Expand</summary>
@@ -578,7 +613,7 @@ const linterCSS = await cm.getLinter({rules}); // Stylelint configuration
 
 </details>
 
-## getNodeAt
+### getNodeAt
 
 <details>
 	<summary>Expand</summary>
@@ -595,7 +630,7 @@ const tree = cm.getNodeAt(0);
 
 </details>
 
-## hasPreference
+### hasPreference
 
 <details>
 	<summary>Expand</summary>
@@ -612,7 +647,7 @@ const hasAutocompletion = cm.hasPreference('autocompletion');
 
 </details>
 
-## initialize
+### initialize
 
 <details>
 	<summary>Expand</summary>
@@ -628,7 +663,7 @@ cm.initialize();
 
 </details>
 
-## lint
+### lint
 
 <details>
 	<summary>Expand</summary>
@@ -653,7 +688,7 @@ cm.lint(({doc}) => [
 
 </details>
 
-## localize
+### localize
 
 <details>
 	<summary>Expand</summary>
@@ -671,7 +706,7 @@ cm.localize({
 
 </details>
 
-## prefer
+### prefer
 
 <details>
 	<summary>Expand</summary>
@@ -734,7 +769,7 @@ cm.prefer({
 
 </details>
 
-## replaceSelections
+### replaceSelections
 
 <details>
 	<summary>Expand</summary>
@@ -750,7 +785,7 @@ cm.replaceSelections(str => str.toUpperCase());
 
 </details>
 
-## scrollTo
+### scrollTo
 
 <details>
 	<summary>Expand</summary>
@@ -766,7 +801,7 @@ cm.scrollTo();
 
 </details>
 
-## setContent
+### setContent
 
 <details>
 	<summary>Expand</summary>
@@ -783,7 +818,7 @@ cm.setContent('');
 
 </details>
 
-## setIndent
+### setIndent
 
 <details>
 	<summary>Expand</summary>
@@ -800,13 +835,13 @@ cm.setIndent('\t');
 
 </details>
 
-## setLanguage
+### setLanguage
 
 <details>
 	<summary>Expand</summary>
 
 **param**: `string` the language mode to be used, default as plain text  
-**param**: `unknown` the optional language configuration  
+**param**: `unknown` the language configuration, only required for the [MediaWiki](#mediawiki) mode and the [mixed MediaWiki-HTML](#html) mode  
 Set the language mode.
 
 ```js
@@ -817,11 +852,12 @@ cm.setLanguage('javascript');
 cm.setLanguage('json');
 cm.setLanguage('lua');
 cm.setLanguage('vue');
+cm.setLanguage('abusefilter', dialect);
 ```
 
 </details>
 
-## setLineWrapping
+### setLineWrapping
 
 <details>
 	<summary>Expand</summary>
@@ -838,7 +874,7 @@ cm.setLineWrapping(true);
 
 </details>
 
-## setTheme
+### setTheme
 
 <details>
 	<summary>Expand</summary>
@@ -856,7 +892,7 @@ cm.setTheme('nord');
 
 </details>
 
-## toggle
+### toggle
 
 <details>
 	<summary>Expand</summary>
@@ -874,7 +910,7 @@ cm.toggle(false); // hide CodeMirror
 
 </details>
 
-## update
+### update
 
 <details>
 	<summary>Expand</summary>
@@ -883,9 +919,9 @@ Refresh linting immediately.
 
 </details>
 
-# Static accessors
+## Static accessors
 
-## CDN
+### CDN
 
 <details>
 	<summary>Expand</summary>
@@ -901,9 +937,9 @@ CodeMirror6.CDN = 'https://cdn.jsdelivr.net';
 
 </details>
 
-# Static methods
+## Static methods
 
-## getMwConfig
+### getMwConfig
 
 <details>
 	<summary>Expand</summary>
@@ -920,7 +956,7 @@ const mwConfig = CodeMirror6.getMwConfig(config);
 
 </details>
 
-## replaceSelections (static)
+### replaceSelections (static)
 
 <details>
 	<summary>Expand</summary>
@@ -937,9 +973,9 @@ CodeMirror6.replaceSelections(cm.view, str => str.toUpperCase());
 
 </details>
 
-# Extensions
+## Extensions
 
-## allowMultipleSelections
+### allowMultipleSelections
 
 <details>
 	<summary>Expand</summary>
@@ -957,14 +993,14 @@ registerAllowMultipleSelections();
 
 </details>
 
-## autocompletion
+### autocompletion
 
 <details>
 	<summary>Expand</summary>
 
 *version added: 2.5.1*
 
-Provide autocompletion for MediaWiki, CSS and JavaScript modes.
+Provide autocompletion.
 
 Key bindings:
 
@@ -980,7 +1016,25 @@ registerAutocompletion();
 
 </details>
 
-## bracketMatching
+### bidiIsolates
+
+<details>
+	<summary>Expand</summary>
+
+*version added: 3.10.0*
+
+When Wikitext contains right-to-left text, isolate bidirectional text from the surrounding text.
+
+This extension is not included in the [`mediawiki`](#mediawiki) language support by default. You need to import the `registerBidiIsolates` function:
+
+```js
+import {registerBidiIsolates} from '@bhsd/codemirror-mediawiki';
+registerBidiIsolates();
+```
+
+</details>
+
+### bracketMatching
 
 <details>
 	<summary>Expand</summary>
@@ -998,7 +1052,7 @@ registerBracketMatching();
 
 </details>
 
-## closeBrackets
+### closeBrackets
 
 <details>
 	<summary>Expand</summary>
@@ -1016,7 +1070,7 @@ registerCloseBrackets();
 
 </details>
 
-## codeFolding
+### codeFolding
 
 <details>
 	<summary>Expand</summary>
@@ -1042,7 +1096,7 @@ registerCodeFolding();
 
 </details>
 
-## colorPicker
+### colorPicker
 
 <details>
 	<summary>Expand</summary>
@@ -1060,7 +1114,7 @@ registerColorPicker();
 
 </details>
 
-## escape
+### escape
 
 <details>
 	<summary>Expand</summary>
@@ -1077,12 +1131,13 @@ For granular control over the bundled extensions, you can import the `registerEs
 
 ```js
 import {registerEscape} from '@bhsd/codemirror-mediawiki';
-registerEscape();
+// optionally pass the article path of a MediaWiki site
+registerEscape('https://www.mediawiki.org/wiki/');
 ```
 
 </details>
 
-## highlightActiveLine
+### highlightActiveLine
 
 <details>
 	<summary>Expand</summary>
@@ -1098,7 +1153,7 @@ registerHighlightActiveLine();
 
 </details>
 
-## highlightSelectionMatches
+### highlightSelectionMatches
 
 <details>
 	<summary>Expand</summary>
@@ -1116,7 +1171,7 @@ registerHighlightSelectionMatches();
 
 </details>
 
-## highlightSpecialChars
+### highlightSpecialChars
 
 <details>
 	<summary>Expand</summary>
@@ -1132,7 +1187,7 @@ registerHighlightSpecialChars();
 
 </details>
 
-## highlightTrailingWhitespace
+### highlightTrailingWhitespace
 
 <details>
 	<summary>Expand</summary>
@@ -1150,7 +1205,7 @@ registerHighlightTrailingWhitespace();
 
 </details>
 
-## highlightWhitespace
+### highlightWhitespace
 
 <details>
 	<summary>Expand</summary>
@@ -1168,7 +1223,7 @@ registerHighlightWhitespace();
 
 </details>
 
-## hover
+### hover
 
 <details>
 	<summary>Expand</summary>
@@ -1181,12 +1236,13 @@ For granular control over the bundled extensions, you can import the `registerHo
 
 ```js
 import {registerHover} from '@bhsd/codemirror-mediawiki';
-registerHover();
+// optionally pass the article path of a MediaWiki site
+registerHover('https://www.mediawiki.org/wiki/');
 ```
 
 </details>
 
-## inlayHints
+### inlayHints
 
 <details>
 	<summary>Expand</summary>
@@ -1199,12 +1255,13 @@ For granular control over the bundled extensions, you can import the `registerIn
 
 ```js
 import {registerInlayHints} from '@bhsd/codemirror-mediawiki';
-registerInlayHints();
+// optionally pass the article path of a MediaWiki site
+registerInlayHints('https://www.mediawiki.org/wiki/');
 ```
 
 </details>
 
-## openLinks
+### openLinks
 
 <details>
 	<summary>Expand</summary>
@@ -1217,12 +1274,13 @@ For granular control over the bundled extensions, you can import the `registerOp
 
 ```js
 import {registerOpenLinks} from '@bhsd/codemirror-mediawiki';
-registerOpenLinks();
+// optionally pass the article path of a MediaWiki site
+registerOpenLinks('https://www.mediawiki.org/wiki/');
 ```
 
 </details>
 
-## refHover
+### refHover
 
 <details>
 	<summary>Expand</summary>
@@ -1235,12 +1293,13 @@ For granular control over the bundled extensions, you can import the `registerRe
 
 ```js
 import {registerRefHover} from '@bhsd/codemirror-mediawiki';
-registerRefHover();
+// optionally pass the article path of a MediaWiki site
+registerRefHover('https://www.mediawiki.org/wiki/');
 ```
 
 </details>
 
-## scrollPastEnd
+### scrollPastEnd
 
 <details>
 	<summary>Expand</summary>
@@ -1258,7 +1317,7 @@ registerScrollPastEnd();
 
 </details>
 
-## signatureHelp
+### signatureHelp
 
 <details>
 	<summary>Expand</summary>
@@ -1271,49 +1330,50 @@ For granular control over the bundled extensions, you can import the `registerSi
 
 ```js
 import {registerSignatureHelp} from '@bhsd/codemirror-mediawiki';
-registerSignatureHelp();
+// optionally pass the article path of a MediaWiki site
+registerSignatureHelp('https://www.mediawiki.org/wiki/');
 ```
 
 </details>
 
-# Known issues
+## Known issues
 
-## Syntax Highlighting
+### Syntax Highlighting
 
 <details>
 	<summary>Expand</summary>
 
-### Extension
+#### Extension
 
 1. [Extension:Poem](https://www.mediawiki.org/wiki/Extension:Poem) should prevent preformatted text ([Example](http://bhsd-harry.github.io/monaco-wiki/tests.html#%3Cpoem%3E%20with%20leading%20whitespace)).
 
-### Transclusion
+#### Transclusion
 
 1. Non-existing parser functions starting with `#` are highlighted as parser functions ([Example](http://bhsd-harry.github.io/codemirror-mediawiki/tests.html#Parsoid%3A%20unknown%20parser%20function%20(T314524))).
 1. Wikitext in template parameter names is not highlighted ([Example](http://bhsd-harry.github.io/codemirror-mediawiki/tests.html#Templates%3A%20Other%20wikitext%20in%20parameter%20names%20(T69657))).
 1. Template parameter names followed by a newline are not recognized ([Example](http://bhsd-harry.github.io/codemirror-mediawiki/tests.html#Templates%3A%20Handle%20comments%20in%20parameter%20names%20(T69657))).
 1. Template-like syntax without a template name ([Example](http://bhsd-harry.github.io/codemirror-mediawiki/tests.html#T408631%3A%20Invalid%20templates%20inside%20template%20parameters)).
 
-### Heading
+#### Heading
 
 1. Comments at the SOL should not break section headings ([Example](https://bhsd-harry.github.io/codemirror-mediawiki/tests.html#Section%20extraction%20prefixed%20by%20comment%20(section%201))).
 
-### Table
+#### Table
 
 1. Comments at the SOL should not break table syntax ([Example](https://bhsd-harry.github.io/codemirror-mediawiki/tests.html#3c.%20Table%20cells%20without%20escapable%20prefixes%20after%20edits)).
 1. `!!` in links should start a new `<th>` ([Example](http://bhsd-harry.github.io/codemirror-mediawiki/tests.html#Precedence%20of%20table%20over%20links)).
 
-### External link
+#### External link
 
 1. IPv6 addresses are not supported ([Example](http://bhsd-harry.github.io/codemirror-mediawiki/tests.html#IPv6%20urls%2C%20autolink%20format%20(T23261))).
 1. External links inside double brackets are highlighted incorrectly ([Example](http://bhsd-harry.github.io/codemirror-mediawiki/tests.html#Render%20invalid%20page%20names%20as%20plain%20text%20(T53090))).
 
-### Block element
+#### Block element
 
 1. Comments at the SOL break the highlighting ([Example](https://bhsd-harry.github.io/codemirror-mediawiki/tests.html#1.%20Lists%20with%20start-of-line-transparent%20tokens%20before%20bullets%3A%20Comments)).
 1. False positives of preformatted text when there are categories ([Example](http://bhsd-harry.github.io/codemirror-mediawiki/tests.html#Category%20%2F%20paragraph%20interactions)) or HTML tags ([Example](http://bhsd-harry.github.io/codemirror-mediawiki/tests.html#Parsing%20optional%20HTML%20elements%20(T8171))).
 
-### Language conversion
+#### Language conversion
 
 1. BCP 47 language codes are not supported in language conversion ([Example](https://bhsd-harry.github.io/wikiparser-node/tests.html#Explicit%20definition%20of%20language%20variant%20alternatives%20(BCP%2047%20codes))).