@bhsd/codemirror-mediawiki 2.3.2 → 2.3.4

package/mw/config.ts

@@ -1,3 +1,4 @@
+import type {Config} from 'wikilint';
 import type {MwConfig} from '../src/mediawiki';
 
 declare interface MagicWord {
@@ -6,10 +7,9 @@ declare interface MagicWord {
 	'case-sensitive': boolean;
 }
 
-export const USING_LOCAL = mw.loader.getState('ext.CodeMirror') !== null;
-
 // 和本地缓存有关的常数
-const DATA_MODULE = mw.loader.getState('ext.CodeMirror.data') ? 'ext.CodeMirror.data' : 'ext.CodeMirror',
+const USING_LOCAL = mw.loader.getState('ext.CodeMirror') !== null,
+	DATA_MODULE = mw.loader.getState('ext.CodeMirror.data') ? 'ext.CodeMirror.data' : 'ext.CodeMirror',
 	ALL_SETTINGS_CACHE: Record<string, {time: number, config: MwConfig}>
 		= JSON.parse(localStorage.getItem('InPageEditMwConfig')!) || {},
 	SITE_ID = `${mw.config.get('wgServerName')}${mw.config.get('wgScriptPath')}`,
@@ -50,7 +50,10 @@ const getConfigPair = (
 ): [Record<string, string>, Record<string, string>] => [true, false]
 	.map(bool => getConfig(magicWords, rule, bool)) as [Record<string, string>, Record<string, string>];
 
-/** 将设置保存到mw.config */
+/**
+ * 将设置保存到mw.config
+ * @param config 设置
+ */
 const setConfig = (config: MwConfig): void => {
 	mw.config.set('extCodeMirrorConfig', config);
 };
@@ -146,3 +149,38 @@ export const getMwConfig = async (): Promise<MwConfig> => {
 	localStorage.setItem('InPageEditMwConfig', JSON.stringify(ALL_SETTINGS_CACHE));
 	return config!;
 };
+
+/**
+ * 将MwConfig转换为Config
+ * @param minConfig 基础Config
+ * @param mwConfig MwConfig
+ */
+export const getParserConfig = (minConfig: Config, mwConfig: MwConfig): Config => {
+	const config: Config = {
+		...minConfig,
+		ext: Object.keys(mwConfig.tags),
+		namespaces: mw.config.get('wgFormattedNamespaces'),
+		nsid: mwConfig.nsid,
+		doubleUnderscore: mwConfig.doubleUnderscore.map(
+			obj => Object.keys(obj).map(s => s.slice(2, -2)),
+		) as [string[], string[]],
+		variants: mwConfig.variants!,
+		protocol: mwConfig.urlProtocols.replace(/\\:/gu, ':'),
+	};
+	[config.parserFunction[0]] = mwConfig.functionSynonyms;
+	if (!USING_LOCAL) {
+		for (const [key, val] of Object.entries(mwConfig.functionSynonyms[0])) {
+			if (!key.startsWith('#')) {
+				config.parserFunction[0][`#${key}`] = val;
+			}
+		}
+	}
+	config.parserFunction[1] = [
+		...Object.keys(mwConfig.functionSynonyms[1]),
+		'=',
+	];
+	for (const key of Object.keys(mwConfig.img!)) {
+		config.img[key] = mwConfig.img![key]!.slice(4);
+	}
+	return config;
+};

package/mw/msg.ts

@@ -1,6 +1,11 @@
-import {CDN} from './base';
+import type {CodeMirror} from './base';
 
-export const REPO_CDN = 'npm/@bhsd/codemirror-mediawiki@2.3.2';
+export const REPO_CDN = 'npm/@bhsd/codemirror-mediawiki@2.3.4';
+
+const {vendor, userAgent, maxTouchPoints, platform} = navigator;
+
+export const isMac = vendor.includes('Apple Computer') && (userAgent.includes('Mobile/') || maxTouchPoints > 2)
+	|| platform.includes('Mac');
 
 const storageKey = 'codemirror-mediawiki-i18n',
 	languages: Record<string, string> = {
@@ -21,8 +26,11 @@ const storageKey = 'codemirror-mediawiki-i18n',
 	{version} = i18n,
 	curVersion = REPO_CDN.slice(REPO_CDN.lastIndexOf('@') + 1);
 
-/** 加载 I18N */
-export const setI18N = async (): Promise<void> => {
+/**
+ * 加载 I18N
+ * @param CDN CDN地址
+ */
+export const setI18N = async (CDN: string): Promise<void> => {
 	if (i18n['lang'] !== lang || version !== curVersion) {
 		try {
 			Object.assign(i18n, await (await fetch(`${CDN}/${REPO_CDN}/i18n/${lang}.json`)).json());
@@ -33,7 +41,11 @@ export const setI18N = async (): Promise<void> => {
 		}
 	}
 	for (const [k, v] of Object.entries(i18n)) {
-		mw.messages.set(`cm-mw-${k}`, v);
+		if (!k.endsWith('-mac')) {
+			mw.messages.set(`cm-mw-${k}`, v);
+		} else if (isMac) {
+			mw.messages.set(`cm-mw-${k.slice(0, -4)}`, v);
+		}
 	}
 };
 
@@ -61,6 +73,11 @@ const notify = async (key: string, ...args: string[]): Promise<JQuery<HTMLElemen
 	return $p;
 };
 
+/**
+ * 欢迎消息
+ * @param baseVersion 首次加入新插件的版本
+ * @param addons 新插件
+ */
 export const welcome = async (baseVersion: string, addons: string[]): Promise<void> => {
 	let notification: JQuery<HTMLElement> | undefined;
 	if (!version) { // 首次安装
@@ -82,3 +99,27 @@ export const welcome = async (baseVersion: string, addons: string[]): Promise<vo
 		document.getElementById('cm-settings')!.dispatchEvent(new MouseEvent('click'));
 	});
 };
+
+/**
+ * 本地化
+ * @param cm 编辑器实例
+ */
+export const localize = (cm: CodeMirror): void => {
+	const obj: Record<string, string> = {},
+		messages = [
+			'Find',
+			'next',
+			'previous',
+			'all',
+			'match case',
+			'regexp',
+			'by word',
+			'Replace',
+			'replace',
+			'replace all',
+		];
+	for (const message of messages) {
+		obj[message] = msg(`phrase-${message.replace(/ /gu, '-')}`);
+	}
+	cm.localize(obj);
+};

package/mw/openLinks.ts

@@ -1,13 +1,13 @@
-const {vendor, userAgent, maxTouchPoints, platform} = navigator,
-	modKey = vendor.includes('Apple Computer') && (userAgent.includes('Mobile/') || maxTouchPoints > 2)
-	|| platform.includes('Mac')
-		? 'metaKey'
-		: 'ctrlKey';
+import {isMac} from './msg';
 
-export const pageSelector = '.cm-mw-template-name, .cm-mw-link-pagename';
+const modKey = isMac ? 'metaKey' : 'ctrlKey',
+	pageSelector = '.cm-mw-template-name, .cm-mw-link-pagename';
 
-/** 点击时在新页面打开链接、模板等 */
-export const openLinks = function(this: HTMLElement, e: JQuery.ClickEvent): void {
+/**
+ * 点击时在新页面打开链接、模板等
+ * @param e 点击事件
+ */
+const handler = function(this: HTMLElement, e: JQuery.ClickEvent): void {
 	if (!e[modKey]) {
 		return;
 	}
@@ -34,3 +34,17 @@ export const openLinks = function(this: HTMLElement, e: JQuery.ClickEvent): void
 	}
 	open(new mw.Title(page, this.classList.contains('cm-mw-template-name') ? 10 : 0).getUrl(undefined), '_blank');
 };
+
+/**
+ * 添加或移除打开链接的事件
+ * @param ele 编辑器DOM
+ * @param on 是否添加
+ */
+export const openLinks = (ele: HTMLElement, on?: boolean): void => {
+	if (on) {
+		mw.loader.load('mediawiki.Title');
+		$(ele).on('click', pageSelector, handler).css('--codemirror-cursor', 'pointer');
+	} else if (on === false) {
+		$(ele).off('click', pageSelector, handler).css('--codemirror-cursor', '');
+	}
+};

package/mw/preference.ts

@@ -1,8 +1,9 @@
 import {msg} from './msg';
 import type {CodeMirror} from './base';
 
-export const storageKey = 'codemirror-mediawiki-addons',
-	indentKey = 'codemirror-mediawiki-indent';
+const storageKey = 'codemirror-mediawiki-addons';
+export const indentKey = 'codemirror-mediawiki-indent',
+	prefs = new Set<string>(JSON.parse(localStorage.getItem(storageKey)!) as string[] | null);
 
 const options = [
 	'allowMultipleSelections',
@@ -28,13 +29,12 @@ let dialog: OO.ui.MessageDialog | undefined,
 
 /**
  * 打开设置对话框
- * @param addons 预设的扩展
  * @param editors CodeMirror实例
  */
-export const openPreference = async (addons: Set<string>, editors: (CodeMirror | undefined)[]): Promise<void> => {
+export const openPreference = async (editors: (CodeMirror | undefined)[]): Promise<void> => {
 	await mw.loader.using(['oojs-ui-windows', 'oojs-ui.styles.icons-content']);
 	if (dialog) {
-		widget.setValue([...addons] as unknown as string);
+		widget.setValue([...prefs] as unknown as string);
 		indentWidget.setValue(indent);
 	} else {
 		dialog = new OO.ui.MessageDialog();
@@ -43,17 +43,14 @@ export const openPreference = async (addons: Set<string>, editors: (CodeMirror |
 		windowManager.addWindows([dialog]);
 		widget = new OO.ui.CheckboxMultiselectInputWidget({
 			options: options.map(option => ({data: option, label: $($.parseHTML(msg(`addon-${option}`)))})),
-			value: [...addons] as unknown as string,
+			value: [...prefs] as unknown as string,
 		});
 		field = new OO.ui.FieldLayout(widget, {
 			label: msg('label'),
 			align: 'top',
 		});
-		indentWidget = new OO.ui.TextInputWidget({placeholder: '\\t'});
-		indentField = new OO.ui.FieldLayout(indentWidget, {
-			label: msg('addon-indent'),
-			notices: [msg('notice')],
-		});
+		indentWidget = new OO.ui.TextInputWidget({value: indent, placeholder: '\\t'});
+		indentField = new OO.ui.FieldLayout(indentWidget, {label: msg('addon-indent')});
 	}
 
 	const data = await (dialog.open({
@@ -68,9 +65,9 @@ export const openPreference = async (addons: Set<string>, editors: (CodeMirror |
 	if (typeof data === 'object' && data.action === 'accept') {
 		const value = widget.getValue() as unknown as string[];
 		indent = indentWidget.getValue(); // eslint-disable-line require-atomic-updates
-		addons.clear();
+		prefs.clear();
 		for (const option of value) {
-			addons.add(option);
+			prefs.add(option);
 		}
 		for (const cm of editors) {
 			cm?.prefer(value);

package/mw/textSelection.ts

@@ -2,6 +2,10 @@ import type {CodeMirror} from './base';
 
 export const instances = new WeakMap<HTMLTextAreaElement, CodeMirror>();
 
+/**
+ * 获取CodeMirror实例
+ * @param $ele textarea元素的jQuery对象
+ */
 const getInstance = ($ele: JQuery<HTMLTextAreaElement>): CodeMirror => instances.get($ele[0]!)!;
 
 function getCaretPosition(this: JQuery<HTMLTextAreaElement>, option: {startAndEnd: true}): [number, number];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@bhsd/codemirror-mediawiki",
-	"version": "2.3.2",
+	"version": "2.3.4",
 	"description": "Modified CodeMirror mode based on wikimedia/mediawiki-extensions-CodeMirror",
 	"keywords": [
 		"mediawiki",
@@ -13,13 +13,10 @@
 	"license": "GPL-2.0",
 	"files":[
 		"/i18n/",
-		"/src/",
-		"!/src/gh-page.ts",
-		"!/src/plugins.ts",
-		"!/src/*.d.ts",
 		"/mw/*.ts",
 		"!/mw/*.d.ts",
 		"/dist/",
+		"!/dist/main.min.js.map",
 		"/mediawiki.css"
 	],
 	"browser": "dist/main.min.js",
@@ -30,7 +27,7 @@
 		"url": "git+https://github.com/bhsd-harry/codemirror-mediawiki.git"
 	},
 	"scripts": {
-		"build:core": "esbuild ./src/codemirror.ts --bundle --minify --target=es2018 --format=esm --sourcemap --outfile=dist/main.min.js && tsc --emitDeclarationOnly && rm dist/gh-page.d.ts",
+		"build:core": "esbuild ./src/codemirror.ts --bundle --minify --target=es2018 --format=esm --sourcemap --outfile=dist/main.min.js && tsc --emitDeclarationOnly && rm dist/config.d.ts dist/[efgp]*.d.ts",
 		"build:mw": "esbuild ./mw/base.ts --bundle --minify --target=es2018 --format=esm --sourcemap --outfile=dist/mw.min.js",
 		"build:gh-page": "bash build.sh",
 		"build": "npm run build:core && npm run build:mw",
@@ -65,6 +62,7 @@
 		"eslint": "^8.56.0",
 		"eslint-plugin-es-x": "^7.5.0",
 		"eslint-plugin-eslint-comments": "^3.2.0",
+		"eslint-plugin-jsdoc": "^48.0.2",
 		"eslint-plugin-promise": "^6.1.1",
 		"eslint-plugin-regexp": "^2.2.0",
 		"eslint-plugin-unicorn": "^50.0.1",

package/dist/config.d.ts

@@ -1,130 +0,0 @@
-/**
- * @author MusikAnimal and others
- * @license GPL-2.0-or-later
- * @link https://gerrit.wikimedia.org/g/mediawiki/extensions/CodeMirror
- */
-import { Tag } from '@lezer/highlight';
-/**
- * Configuration for the MediaWiki highlighting mode for CodeMirror.
- */
-export declare const modeConfig: {
-    /**
-     * All HTML/XML tags permitted in MediaWiki Core.
-     *
-     * @see https://www.mediawiki.org/wiki/Extension:CodeMirror#Extension_integration
-     */
-    permittedHtmlTags: string[];
-    /**
-     * HTML tags that are only self-closing.
-     */
-    implicitlyClosedHtmlTags: string[];
-    /**
-     * Mapping of MediaWiki-esque token identifiers to a standardized lezer highlighting tag.
-     * 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.
-     *
-     * @see https://lezer.codemirror.net/docs/ref/#highlight.tags
-     * @internal
-     */
-    tags: {
-        apostrophes: string;
-        apostrophesBold: string;
-        apostrophesItalic: string;
-        comment: string;
-        doubleUnderscore: string;
-        extLink: string;
-        extLinkBracket: string;
-        extLinkProtocol: string;
-        extLinkText: string;
-        hr: string;
-        htmlTagAttribute: string;
-        htmlTagBracket: string;
-        htmlTagName: string;
-        linkBracket: string;
-        linkDelimiter: string;
-        linkText: string;
-        linkToSection: string;
-        list: string;
-        parserFunction: string;
-        parserFunctionBracket: string;
-        parserFunctionDelimiter: string;
-        parserFunctionName: string;
-        sectionHeader: string;
-        sectionHeader1: string;
-        sectionHeader2: string;
-        sectionHeader3: string;
-        sectionHeader4: string;
-        sectionHeader5: string;
-        sectionHeader6: string;
-        signature: string;
-        tableBracket: string;
-        tableDefinition: string;
-        tableDelimiter: string;
-        template: string;
-        templateArgumentName: string;
-        templateBracket: string;
-        templateDelimiter: string;
-        templateName: string;
-        templateVariable: string;
-        templateVariableBracket: string;
-        templateVariableName: string;
-        section: string;
-        em: string;
-        error: string;
-        extGround: string;
-        ext2Ground: string;
-        ext2LinkGround: string;
-        ext3Ground: string;
-        ext3LinkGround: string;
-        extLinkGround: string;
-        extTag: string;
-        extTagAttribute: string;
-        extTagBracket: string;
-        extTagName: string;
-        freeExtLink: string;
-        freeExtLinkProtocol: string;
-        htmlEntity: string;
-        link: string;
-        linkGround: string;
-        linkPageName: string;
-        pageName: string;
-        skipFormatting: string;
-        strong: string;
-        tableCaption: string;
-        templateExtGround: string;
-        templateExt2Ground: string;
-        templateExt2LinkGround: string;
-        templateExt3Ground: string;
-        templateExt3LinkGround: string;
-        templateExtLinkGround: string;
-        templateGround: string;
-        templateLinkGround: string;
-        templateVariableDelimiter: string;
-        template2ExtGround: string;
-        template2Ext2Ground: string;
-        template2Ext3Ground: string;
-        templatet2Ext2LinkGround: string;
-        template2Ext3LinkGround: string;
-        template2ExtLinkGround: string;
-        template2Ground: string;
-        template2LinkGround: string;
-        template3ExtGround: string;
-        template3Ext2Ground: string;
-        template3Ext3Ground: string;
-        template3ExtLinkGround: string;
-        template3Ext2LinkGround: string;
-        template3Ext3LinkGround: string;
-        template3Ground: string;
-        template3LinkGround: string;
-    };
-    /**
-     * These are custom tokens (a.k.a. tags) that aren't mapped to any of the standardized tags.
-     *
-     * TODO: pass parent Tags in Tag.define() where appropriate for better theming.
-     *
-     * @see https://codemirror.net/docs/ref/#language.StreamParser.tokenTable
-     * @see https://lezer.codemirror.net/docs/ref/#highlight.Tag%5Edefine
-     */
-    readonly tokenTable: Record<string, Tag>;
-};

package/dist/escape.d.ts

@@ -1,2 +0,0 @@
-import type { KeyBinding } from '@codemirror/view';
-export declare const keyMap: KeyBinding[];

package/dist/fold.d.ts

@@ -1,11 +0,0 @@
-import { EditorView } from '@codemirror/view';
-import { StateField } from '@codemirror/state';
-import type { Tooltip } from '@codemirror/view';
-/**
- * 寻找匹配的括号并折叠
- * @param view EditorView
- */
-export declare const fold: (view: EditorView) => boolean;
-export declare const cursorTooltipField: StateField<Tooltip | null>;
-export declare const cursorTooltipTheme: import("@codemirror/state").Extension;
-export declare const handler: (view: EditorView) => (e: MouseEvent) => void;