wikiplus-highlight 3.2.1 → 3.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +49 -13
- package/dist/main.js +23 -23
- package/package.json +5 -19
package/README.md
CHANGED
|
@@ -5,6 +5,30 @@
|
|
|
5
5
|
|
|
6
6
|
**Wikiplus-highlight** 是由 Bhsd 编写的一款 [Wikiplus](https://github.com/Wikiplus/Wikiplus) 语法高亮插件，它主要基于 MediaWiki 内置的 [JavaScript 模块](https://www.mediawiki.org/wiki/ResourceLoader/Core_modules)和 [CodeMirror](https://codemirror.net/) 编写。
|
|
7
7
|
|
|
8
|
+
<details>
|
|
9
|
+
<summary>展开</summary>
|
|
10
|
+
|
|
11
|
+
- [使用方法](#使用方法)
|
|
12
|
+
- [更多插件](#更多插件)
|
|
13
|
+
- [高亮当前行](#高亮当前行)
|
|
14
|
+
- [显示不可见字符](#显示不可见字符)
|
|
15
|
+
- [显示空白字符](#显示空白字符)
|
|
16
|
+
- [显示尾随空格](#显示尾随空格)
|
|
17
|
+
- [匹配括号](#匹配括号)
|
|
18
|
+
- [自动闭合括号和引号](#自动闭合括号和引号)
|
|
19
|
+
- [代码折叠](#代码折叠)
|
|
20
|
+
- [自动填充](#自动填充)
|
|
21
|
+
- [匹配标签](#匹配标签)
|
|
22
|
+
- [HTML/URL编码快捷键](#htmlurl编码快捷键)
|
|
23
|
+
- [快速打开链接](#快速打开链接)
|
|
24
|
+
- [语法检查](#语法检查)
|
|
25
|
+
- [添加 WikiEditor 工具栏](#添加-wikieditor-工具栏)
|
|
26
|
+
- [使用 Monaco Editor](#使用-monaco-editor)
|
|
27
|
+
- [调整缩进](#调整缩进)
|
|
28
|
+
- [Supported languages](#supported-languages)
|
|
29
|
+
|
|
30
|
+
</details>
|
|
31
|
+
|
|
8
32
|
## 使用方法
|
|
9
33
|
|
|
10
34
|
在*个人 JS 页*添加以下代码：
|
|
@@ -45,43 +69,55 @@ mw.loader.load('//unpkg.com/wikiplus-highlight');
|
|
|
45
69
|
|
|
46
70
|
### 自动闭合括号和引号
|
|
47
71
|
|
|
48
|
-
MediaWiki 模式下自动闭合生效的字符包括 `(`、`[`、`{` 和 `"
|
|
49
|
-
|
|
50
|
-
### 匹配标签
|
|
51
|
-
|
|
52
|
-
匹配的标签对或自封闭标签会添加青色背景，未匹配的标签会添加暗红色背景。注意被高亮标记为错误的标签不会进行匹配。
|
|
72
|
+
MediaWiki 模式下自动闭合生效的字符包括 `(`、`[`、`{` 和 `"`，其他模式还额外包括 `'`。如果在选中部分文字的情况下键入这些字符，选中的文字会被成对的括号或引号包裹。
|
|
53
73
|
|
|
54
74
|
### 代码折叠
|
|
55
75
|
|
|
56
|
-
|
|
76
|
+
MediaWiki 模式下，光标移动至模板、解析器函数或扩展标签内部时会在光标上方出现一个 `－` 标记，点击即可折叠模板和解析器函数的参数或扩展标签内部的文本。折叠后使用一个带有虚线边框的 `⋯` 标记占位，点击该标记将重新展开折叠的代码部分。除此以外，可折叠的代码行行号左侧会出现箭头 `⌄` 作为折叠按钮。同时添加以下快捷键：
|
|
57
77
|
|
|
58
78
|
- `Ctrl` + `Shift` + `[`/`Cmd` + `Alt` + `[`: 折叠选中的文字（如果可行）
|
|
59
79
|
- `Ctrl` + `Shift` + `]`/`Cmd` + `Alt` + `]`: 展开选中的文字
|
|
60
|
-
- `Ctrl` + `Alt` + `[`:
|
|
80
|
+
- `Ctrl` + `Alt` + `[`: 折叠所有可折叠的代码
|
|
61
81
|
- `Ctrl` + `Alt` + `]`: 展开所有折叠的代码
|
|
62
82
|
|
|
83
|
+
### 自动填充
|
|
84
|
+
|
|
85
|
+
MediaWiki 模式下可自动填充魔术字（包括状态开关和解析器函数）、标签名、标签属性名、URL 协议和图片参数。此外按下 `Shift` + `Enter` 还可触发页面名称和模板参数（需要 [TemplateData](https://www.mediawiki.org/wiki/Extension:TemplateData) 扩展）的自动填充。JavaScript 和 CSS 模式下可自动填充关键字和常数。
|
|
86
|
+
|
|
87
|
+
### 匹配标签
|
|
88
|
+
|
|
89
|
+
仅用于 MediaWiki 模式，匹配的标签对或自封闭标签会添加青色背景，未匹配的标签会添加暗红色背景。注意被高亮标记为错误的标签不会进行匹配。
|
|
90
|
+
|
|
63
91
|
### HTML/URL编码快捷键
|
|
64
92
|
|
|
65
|
-
|
|
93
|
+
仅用于 MediaWiki 模式，添加以下快捷键：
|
|
66
94
|
|
|
67
95
|
- `Ctrl`/`Cmd` + `[`: 将选中的文字转换为HTML实体
|
|
68
96
|
- `Ctrl`/`Cmd` + `]`: 将选中的文字解码或转换为URL编码
|
|
69
97
|
|
|
70
98
|
### 快速打开链接
|
|
71
99
|
|
|
72
|
-
|
|
100
|
+
仅用于 MediaWiki 模式，按住 `Ctrl`/`Cmd` 并点击被高亮标记为内部链接、模板标题或外部链接的文字时，会在新标签页打开对应页面。
|
|
101
|
+
|
|
102
|
+
### 语法检查
|
|
73
103
|
|
|
74
|
-
|
|
104
|
+
开启后将在编辑框内提示可能存在的语法错误。
|
|
75
105
|
|
|
76
|
-
|
|
106
|
+
|模式|语法检查库|
|
|
107
|
+
|:-:|:-:|
|
|
108
|
+
|MediaWiki|[WikiParser-Node](https://github.com/bhsd-harry/wikiparser-node)|
|
|
109
|
+
|JavaScript|[ESLint](https://eslint.org/)|
|
|
110
|
+
|CSS|[Stylelint](https://stylelint.io/)|
|
|
111
|
+
|JSON|[JSON.parse](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse)|
|
|
112
|
+
|Lua|[luaparse](https://npmjs.com/package/luaparse)|
|
|
77
113
|
|
|
78
114
|
### 添加 WikiEditor 工具栏
|
|
79
115
|
|
|
80
116
|
工具栏遵从当前网站安装的 [WikiEditor](https://www.mediawiki.org/wiki/Extension:WikiEditor) 扩展的版本。
|
|
81
117
|
|
|
82
|
-
###
|
|
118
|
+
### 使用 Monaco Editor
|
|
83
119
|
|
|
84
|
-
|
|
120
|
+
不使用默认的 [CodeMirror 6](https://codemirror.net/) 编辑器，而是使用 [Monaco Editor](https://microsoft.github.io/monaco-editor/)。
|
|
85
121
|
|
|
86
122
|
### 调整缩进
|
|
87
123
|
|
package/dist/main.js
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
if (wphl === null || wphl === void 0 ? void 0 : wphl.version) {
|
|
10
10
|
return;
|
|
11
11
|
}
|
|
12
|
-
const version = '3.2.
|
|
12
|
+
const version = '3.2.3';
|
|
13
13
|
libs.wphl = { version, ...wphl }; // 开始加载
|
|
14
14
|
// 路径
|
|
15
15
|
const CDN = '//testingcf.jsdelivr.net', MW_CDN = `npm/@bhsd/codemirror-mediawiki@${libs.wphl.cmVersion || 'latest'}/dist/mw.min.js`, REPO_CDN = 'npm/wikiplus-highlight';
|
|
@@ -41,8 +41,15 @@
|
|
|
41
41
|
* @param value 页面内容
|
|
42
42
|
*/
|
|
43
43
|
const getPageMode = async (value) => {
|
|
44
|
+
let WikiplusPages;
|
|
44
45
|
if (typeof _WikiplusPages === 'object') {
|
|
45
|
-
|
|
46
|
+
WikiplusPages = _WikiplusPages;
|
|
47
|
+
}
|
|
48
|
+
else if (typeof Pages === 'object') {
|
|
49
|
+
WikiplusPages = Pages;
|
|
50
|
+
}
|
|
51
|
+
if (WikiplusPages) {
|
|
52
|
+
const pages = Object.values(WikiplusPages)
|
|
46
53
|
.filter(({ sectionCache }) => Object.values(sectionCache).includes(value));
|
|
47
54
|
if (pages.some(({ title }) => !title.endsWith('/doc'))) {
|
|
48
55
|
await mw.loader.using('mediawiki.Title');
|
|
@@ -63,11 +70,11 @@
|
|
|
63
70
|
return namespace === 10 || namespace === 2 ? 'template' : 'mediawiki';
|
|
64
71
|
}));
|
|
65
72
|
if (modes.size === 1) {
|
|
66
|
-
const [mode] = modes;
|
|
73
|
+
const [mode] = modes, title = pages.length === 1 ? pages[0].title : undefined;
|
|
67
74
|
if (mode === 'gadget') {
|
|
68
75
|
return ['javascript', 8];
|
|
69
76
|
}
|
|
70
|
-
return mode === 'template' ? ['mediawiki', 10] : [mode];
|
|
77
|
+
return mode === 'template' ? ['mediawiki', 10, title] : [mode, undefined, title];
|
|
71
78
|
}
|
|
72
79
|
else if (modes.size === 2) {
|
|
73
80
|
if (modes.has('javascript') && modes.has('gadget')) {
|
|
@@ -96,8 +103,12 @@
|
|
|
96
103
|
document.querySelector('#Wikiplus-Quickedit-MinorEdit').checked = true;
|
|
97
104
|
return submit();
|
|
98
105
|
}, escapeEdit = /** 按下Esc键退出编辑 */ () => {
|
|
99
|
-
|
|
100
|
-
|
|
106
|
+
const settings = getObject('Wikiplus_Settings'), escToExitQuickEdit = settings && (settings['esc_to_exit_quickedit'] || settings['escToExitQuickEdit']);
|
|
107
|
+
if (escToExitQuickEdit === true || escToExitQuickEdit === 'true') {
|
|
108
|
+
document.getElementById('Wikiplus-Quickedit-Back').dispatchEvent(new MouseEvent('click'));
|
|
109
|
+
return true;
|
|
110
|
+
}
|
|
111
|
+
return false;
|
|
101
112
|
};
|
|
102
113
|
/**
|
|
103
114
|
* 渲染编辑器
|
|
@@ -106,32 +117,21 @@
|
|
|
106
117
|
*/
|
|
107
118
|
const renderEditor = async ($target, setting) => {
|
|
108
119
|
var _a;
|
|
109
|
-
const settings = getObject('Wikiplus_Settings'), escToExitQuickEdit = settings && (settings['esc_to_exit_quickedit'] || settings['escToExitQuickEdit']), esc = escToExitQuickEdit === true || escToExitQuickEdit === 'true';
|
|
110
120
|
const cm = await (await CodeMirror6).fromTextArea($target[0], ...setting ? ['json'] : await getPageMode($target.val()));
|
|
111
121
|
(((_a = cm.view) === null || _a === void 0 ? void 0 : _a.dom) || cm.editor.getDomNode()).id = 'Wikiplus-CodeMirror';
|
|
112
122
|
if (!setting) { // 普通Wikiplus编辑区
|
|
113
123
|
if (cm.editor) {
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
}
|
|
120
|
-
else {
|
|
121
|
-
submit();
|
|
122
|
-
}
|
|
123
|
-
}
|
|
124
|
-
else if (e.keyCode === 9 && esc) {
|
|
125
|
-
e.preventDefault();
|
|
126
|
-
escapeEdit();
|
|
127
|
-
}
|
|
128
|
-
});
|
|
124
|
+
/* eslint-disable no-bitwise */
|
|
125
|
+
cm.editor.addCommand(monaco.KeyMod.CtrlCmd | monaco.KeyCode.KeyS, submit);
|
|
126
|
+
cm.editor.addCommand(monaco.KeyMod.CtrlCmd | monaco.KeyMod.Shift | monaco.KeyCode.KeyS, submitMinor);
|
|
127
|
+
/* eslint-enable no-bitwise */
|
|
128
|
+
cm.editor.addCommand(monaco.KeyCode.Escape, escapeEdit);
|
|
129
129
|
}
|
|
130
130
|
else {
|
|
131
131
|
cm.extraKeys([
|
|
132
132
|
{ key: 'Mod-S', run: submit },
|
|
133
133
|
{ key: 'Shift-Mod-S', run: submitMinor },
|
|
134
|
-
|
|
134
|
+
{ key: 'Esc', run: escapeEdit },
|
|
135
135
|
]);
|
|
136
136
|
}
|
|
137
137
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "wikiplus-highlight",
|
|
3
|
-
"version": "3.2.
|
|
3
|
+
"version": "3.2.3",
|
|
4
4
|
"description": "A plugin for the MediaWiki front-end add-on \"Wikiplus\"",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"mediawiki",
|
|
@@ -29,25 +29,11 @@
|
|
|
29
29
|
"build": "tsc"
|
|
30
30
|
},
|
|
31
31
|
"devDependencies": {
|
|
32
|
-
"@bhsd/codemirror-mediawiki": "^2.
|
|
33
|
-
"@
|
|
34
|
-
"@stylistic/stylelint-plugin": "^2.0.0",
|
|
32
|
+
"@bhsd/codemirror-mediawiki": "^2.14.7",
|
|
33
|
+
"@bhsd/common": "^0.0.0",
|
|
35
34
|
"@types/jquery": "^3.5.29",
|
|
36
35
|
"@types/oojs-ui": "^0.49.0",
|
|
37
|
-
"
|
|
38
|
-
"
|
|
39
|
-
"eslint": "^8.56.0",
|
|
40
|
-
"eslint-plugin-es-x": "^7.5.0",
|
|
41
|
-
"eslint-plugin-eslint-comments": "^3.2.0",
|
|
42
|
-
"eslint-plugin-jsdoc": "^48.0.2",
|
|
43
|
-
"eslint-plugin-json-es": "^1.5.7",
|
|
44
|
-
"eslint-plugin-promise": "^6.1.1",
|
|
45
|
-
"eslint-plugin-regexp": "^2.2.0",
|
|
46
|
-
"eslint-plugin-unicorn": "^52.0.0",
|
|
47
|
-
"monaco-editor": "^0.48.0",
|
|
48
|
-
"stylelint": "^16.1.0",
|
|
49
|
-
"stylelint-config-recommended": "^14.0.0",
|
|
50
|
-
"types-mediawiki": "^1.4.0",
|
|
51
|
-
"typescript": "^5.3.3"
|
|
36
|
+
"monaco-editor": "^0.50.0",
|
|
37
|
+
"types-mediawiki": "^1.8.0"
|
|
52
38
|
}
|
|
53
39
|
}
|