@bhsd/codemirror-mediawiki 2.19.4 → 2.19.6

package/i18n/en.json

@@ -1,5 +1,5 @@
 {
-	"version": "2.19.4",
+	"version": "2.19.6",
 	"lang": "en",
 	"i18n-failed": "Failed to fetch the translation file in $1.",
 	"title": "CodeMirror Addons",

package/i18n/zh-hans.json

@@ -1,5 +1,5 @@
 {
-	"version": "2.19.4",
+	"version": "2.19.6",
 	"lang": "zh-hans",
 	"i18n-failed": "获取 $1 的语言文件失败。",
 	"title": "CodeMirror插件",

package/i18n/zh-hant.json

@@ -1,5 +1,5 @@
 {
-	"version": "2.19.4",
+	"version": "2.19.6",
 	"lang": "zh-hant",
 	"i18n-failed": "取得 $1 的語言檔案失敗。",
 	"title": "CodeMirror外掛程式",

package/mediawiki.css

@@ -29,17 +29,6 @@
 .cm-focused .cm-nonmatchingTag {
 	background-color: rgba(187, 85, 85, .27);
 }
-.cm-mw-template-name,
-.cm-mw-link-pagename,
-.cm-mw-parserfunction.cm-mw-pagename,
-.cm-mw-exttag-attribute-value.cm-mw-pagename,
-.cm-mw-extlink-protocol,
-.cm-mw-extlink,
-.cm-mw-free-extlink-protocol,
-.cm-mw-free-extlink,
-.cm-mw-magic-link {
-	cursor: var(--codemirror-cursor);
-}
 #cm-preference > .oo-ui-window-frame {
 	height: 100% !important;
 }

package/mw/config.ts

@@ -0,0 +1,180 @@
+import {CDN, setObject, getObject} from '@bhsd/common';
+import {getStaticMwConfig} from '../src/static';
+import type {Config} from 'wikiparser-node';
+import type {MwConfig} from '../src/token';
+
+declare interface MagicWord {
+	name: string;
+	aliases: string[];
+	'case-sensitive': boolean;
+}
+
+declare type MagicRule = (word: MagicWord) => boolean;
+
+// 和本地缓存有关的常数
+const ALL_SETTINGS_CACHE: Record<string, {time: number, config: MwConfig}> =
+		getObject('InPageEditMwConfig') ?? {},
+	SITE_ID = typeof mw === 'object' ? mw.config.get('wgServerName') + mw.config.get('wgScriptPath') : location.origin,
+	SITE_SETTINGS = ALL_SETTINGS_CACHE[SITE_ID],
+	VALID = Number(SITE_SETTINGS?.time) > Date.now() - 86_400 * 1000 * 30;
+
+/**
+ * 将魔术字信息转换为CodeMirror接受的设置
+ * @param magicWords 完整魔术字列表
+ * @param rule 过滤函数
+ * @param flip 是否反向筛选对大小写敏感的魔术字
+ */
+const getConfig = (magicWords: MagicWord[], rule: MagicRule, flip?: boolean): Record<string, string> =>
+	Object.fromEntries(
+		magicWords.filter(rule).filter(({'case-sensitive': i}) => i !== flip)
+			.flatMap(({aliases, name, 'case-sensitive': i}) => aliases.map(alias => ({
+				alias: (i ? alias : alias.toLowerCase()).replace(/:$/u, ''),
+				name,
+			})))
+			.map(({alias, name}) => [alias, name]),
+	);
+
+/**
+ * 将魔术字信息转换为CodeMirror接受的设置
+ * @param magicWords 完整魔术字列表
+ * @param rule 过滤函数
+ */
+const getConfigPair = (magicWords: MagicWord[], rule: MagicRule): [Record<string, string>, Record<string, string>] =>
+	[true, false].map(bool => getConfig(magicWords, rule, bool)) as [Record<string, string>, Record<string, string>];
+
+/**
+ * 将设置保存到mw.config
+ * @param config 设置
+ */
+const setConfig = (config: MwConfig): void => {
+	mw.config.set('extCodeMirrorConfig', config);
+};
+
+/**
+ * 加载CodeMirror的mediawiki模块需要的设置
+ * @param modes tagModes
+ */
+export const getMwConfig = async (modes: Record<string, string>): Promise<MwConfig> => {
+	if (mw.loader.getState('ext.CodeMirror') !== null && !VALID) { // 只在localStorage过期时才会重新加载ext.CodeMirror.data
+		await mw.loader.using(mw.loader.getState('ext.CodeMirror.data') ? 'ext.CodeMirror.data' : 'ext.CodeMirror');
+	}
+
+	let config = mw.config.get('extCodeMirrorConfig') as MwConfig | null;
+	if (!config && VALID) {
+		({config} = SITE_SETTINGS!);
+		setConfig(config);
+	}
+	const isIPE = config && Object.values(config.functionSynonyms[0]).includes(true as unknown as string),
+		nsid = mw.config.get('wgNamespaceIds');
+	// 情形1：config已更新，可能来自localStorage
+	if (config?.img && config.redirection && config.variants && !isIPE) {
+		config.urlProtocols = config.urlProtocols.replace(/\\:/gu, ':');
+		config.tagModes = modes;
+		return {...config, nsid};
+	} else if (location.hostname.endsWith('.moegirl.org.cn')) {
+		const parserConfig: Config = await (await fetch(
+			`${CDN}/npm/wikiparser-node@browser/config/moegirl.json`,
+		)).json();
+		setObject('wikilintConfig', parserConfig);
+		config = getStaticMwConfig(parserConfig, modes);
+	} else {
+		// 以下情形均需要发送API请求
+		// 情形2：localStorage未过期但不包含新设置
+		// 情形3：新加载的 ext.CodeMirror.data
+		// 情形4：`config === null`
+		await mw.loader.using('mediawiki.api');
+		const {query: {general: {variants}, magicwords, extensiontags, functionhooks, variables}}: {
+			query: {
+				general: {variants?: {code: string}[]};
+				magicwords: MagicWord[];
+				extensiontags: string[];
+				functionhooks: string[];
+				variables: string[];
+			};
+		} = await new mw.Api().get({
+			meta: 'siteinfo',
+			siprop: [
+				'general',
+				'magicwords',
+				...config && !isIPE ? [] : ['extensiontags', 'functionhooks', 'variables'],
+			],
+			formatversion: '2',
+		}) as any; // eslint-disable-line @typescript-eslint/no-explicit-any
+		const others = new Set(['msg', 'raw', 'msgnw', 'subst', 'safesubst']);
+
+		// 先处理魔术字和状态开关
+		if (config && !isIPE) { // 情形2或3
+			const {functionSynonyms: [insensitive]} = config;
+			if (!('subst' in insensitive)) {
+				Object.assign(insensitive, getConfig(magicwords, ({name}) => others.has(name)));
+			}
+		} else { // 情形4：`config === null`
+			const functions = new Set([
+				...functionhooks,
+				...variables,
+				...others,
+			]);
+			// @ts-expect-error incomplete properties
+			config = {
+				tags: Object.fromEntries(extensiontags.map(tag => [tag.slice(1, -1), true])),
+				functionSynonyms: getConfigPair(magicwords, ({name}) => functions.has(name)),
+				doubleUnderscore: getConfigPair(
+					magicwords,
+					({aliases}) => aliases.some(alias => /^__.+__$/u.test(alias)),
+				),
+			};
+		}
+		config!.tagModes = modes;
+		config!.img = getConfig(magicwords, ({name}) => name.startsWith('img_'));
+		config!.variants = variants ? variants.map(({code}) => code) : [];
+		config!.redirection = magicwords.find(({name}) => name === 'redirect')!.aliases;
+		config!.urlProtocols = mw.config.get('wgUrlProtocols').replace(/\\:/gu, ':');
+	}
+	setConfig(config!);
+	ALL_SETTINGS_CACHE[SITE_ID] = {config: config!, time: Date.now()};
+	setObject('InPageEditMwConfig', ALL_SETTINGS_CACHE);
+	return {...config!, nsid};
+};
+
+/**
+ * 将MwConfig转换为Config
+ * @param minConfig 基础Config
+ * @param mwConfig
+ */
+export const getParserConfig = (minConfig: Config, mwConfig: MwConfig): Config => {
+	let config: Config | null = getObject('wikilintConfig');
+	if (config) {
+		return 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(/\|\\?\/\\?\//u, ''),
+		redirection: mwConfig.redirection ?? minConfig.redirection,
+	};
+	if (location.hostname.endsWith('.moegirl.org.cn')) {
+		config.html[2].push('img');
+	}
+	[config.parserFunction[0]] = mwConfig.functionSynonyms;
+	if (mw.loader.getState('ext.CodeMirror') === null) {
+		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, val] of Object.entries(mwConfig.img!)) {
+		config.img[key] = val.slice(4);
+	}
+	return config;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@bhsd/codemirror-mediawiki",
-	"version": "2.19.4",
+	"version": "2.19.6",
 	"description": "Modified CodeMirror mode based on wikimedia/mediawiki-extensions-CodeMirror",
 	"keywords": [
 		"mediawiki",
@@ -16,8 +16,12 @@
 		"/i18n/",
 		"/dist/*.js",
 		"/dist/*.d.ts",
+		"/dist/*.mjs",
 		"!/dist/*-page.d.ts",
 		"!/dist/parser.*",
+		"/src/linter.ts",
+		"/src/static.ts",
+		"/mw/config.ts",
 		"/mediawiki.css"
 	],
 	"browser": "dist/main.min.js",
@@ -29,8 +33,8 @@
 	},
 	"scripts": {
 		"prepublishOnly": "npm run build",
-		"build:core": "esbuild ./src/codemirror.ts --charset=utf8 --bundle --minify --target=es2019 --format=esm --sourcemap --outfile=dist/main.min.js && tsc --emitDeclarationOnly",
-		"build:mw": "esbuild ./mw/base.ts --charset=utf8 --bundle --minify --target=es2019 --format=esm --sourcemap --outfile=dist/mw.min.js",
+		"build:core": "esbuild ./src/codemirror.ts --charset=utf8 --bundle --minify --target=es2019 --format=esm --sourcemap --outfile=dist/main.min.js && esbuild ./src/linter.ts --charset=utf8 --target=es2019 --format=esm --outfile=dist/linter.mjs && tsc --emitDeclarationOnly",
+		"build:mw": "esbuild ./mw/base.ts --charset=utf8 --bundle --minify --target=es2019 --format=esm --sourcemap --outfile=dist/mw.min.js && esbuild ./mw/config.ts --charset=utf8 --bundle --target=es2019 --format=esm --outfile=dist/mwConfig.mjs",
 		"build:wiki": "esbuild ./mw/base.ts --charset=utf8 --bundle --minify --target=es2019 --format=iife --sourcemap --outfile=dist/wiki.min.js",
 		"build:gh-page": "bash build.sh",
 		"build:test": "tsc --project test/tsconfig.json && node test/dist/test/test.js",
@@ -45,6 +49,7 @@
 		"test:real": "node test/dist/test/real.js"
 	},
 	"dependencies": {
+		"@bhsd/common": "^0.5.0",
 		"@codemirror/language": "^6.10.6",
 		"@codemirror/lint": "^6.8.4",
 		"@codemirror/state": "^6.4.1",
@@ -54,7 +59,6 @@
 		"wikiparser-node": "^1.14.0"
 	},
 	"devDependencies": {
-		"@bhsd/common": "^0.4.6",
 		"@codemirror/autocomplete": "^6.18.3",
 		"@codemirror/commands": "^6.7.1",
 		"@codemirror/lang-css": "^6.3.1",
@@ -66,7 +70,9 @@
 		"@replit/codemirror-css-color-picker": "^6.3.0",
 		"@stylistic/eslint-plugin": "^2.11.0",
 		"@stylistic/stylelint-plugin": "^3.1.1",
+		"@types/eslint": "^8.56.10",
 		"@types/jquery": "^3.5.32",
+		"@types/node": "^22.10.1",
 		"@types/oojs-ui": "^0.49.0",
 		"@typescript-eslint/eslint-plugin": "^8.16.0",
 		"@typescript-eslint/parser": "^8.16.0",

package/src/linter.ts

@@ -0,0 +1,149 @@
+import {CDN, loadScript} from '@bhsd/common';
+import type {LinterBase} from 'wikiparser-node/extensions/typings';
+import type {Linter} from 'eslint';
+import type {Warning} from 'stylelint';
+import type {Diagnostic} from 'luacheck-browserify';
+
+declare type getLinter<T> = (opt?: Record<string, unknown>) => T;
+declare type getAsyncLinter<T> = (opt?: Record<string, unknown>) => Promise<T>;
+
+/**
+ * 获取 WikiLint
+ * @param opt 选项
+ */
+export const getWikiLinter: getAsyncLinter<LinterBase> = async opt => {
+	const REPO = 'npm/wikiparser-node@browser',
+		DIR = `${REPO}/extensions/dist`,
+		lang = opt?.['i18n'];
+	await loadScript(`${DIR}/base.min.js`, 'wikiparse');
+	await loadScript(`${DIR}/lint.min.js`, 'wikiparse.Linter');
+	if (typeof lang === 'string') {
+		try {
+			const i18n: Record<string, string> =
+				await (await fetch(`${CDN}/${REPO}/i18n/${lang.toLowerCase()}.json`)).json();
+			wikiparse.setI18N(i18n);
+		} catch {}
+	}
+	return new wikiparse.Linter!(opt?.['include'] as boolean | undefined);
+};
+
+/**
+ * 获取 ESLint
+ * @param opt 选项
+ */
+export const getJsLinter: getAsyncLinter<(text: string) => Linter.LintMessage[]> = async opt => {
+	await loadScript('npm/eslint-linter-browserify@8.57.0/linter.min.js', 'eslint', true);
+	/** @see https://www.npmjs.com/package/@codemirror/lang-javascript */
+	const esLinter = new eslint.Linter(),
+		conf: Linter.Config = {
+			env: {browser: true, es2024: true},
+			parserOptions: {ecmaVersion: 15, sourceType: 'module'},
+			rules: {},
+			...opt,
+		};
+	for (const [name, {meta}] of esLinter.getRules()) {
+		if (meta?.docs?.recommended) {
+			conf.rules![name] ??= 2;
+		}
+	}
+	return text => esLinter.verify(text, conf);
+};
+
+/**
+ * 获取 Stylelint
+ * @param opt 选项
+ */
+export const getCssLinter: getAsyncLinter<(text: string) => Promise<Warning[]>> = async opt => {
+	await loadScript('npm/stylelint-bundle', 'stylelint');
+	/** @see https://www.npmjs.com/package/stylelint-config-recommended */
+	const config = {
+		rules: {
+			'annotation-no-unknown': true,
+			'at-rule-no-unknown': true,
+			'block-no-empty': true,
+			'color-no-invalid-hex': true,
+			'comment-no-empty': true,
+			'custom-property-no-missing-var-function': true,
+			'declaration-block-no-duplicate-custom-properties': true,
+			'declaration-block-no-duplicate-properties': [
+				true,
+				{
+					ignore: ['consecutive-duplicates-with-different-syntaxes'],
+				},
+			],
+			'declaration-block-no-shorthand-property-overrides': true,
+			'font-family-no-duplicate-names': true,
+			'font-family-no-missing-generic-family-keyword': true,
+			'function-calc-no-unspaced-operator': true,
+			'function-linear-gradient-no-nonstandard-direction': true,
+			'function-no-unknown': true,
+			'keyframe-block-no-duplicate-selectors': true,
+			'keyframe-declaration-no-important': true,
+			'media-feature-name-no-unknown': true,
+			'media-query-no-invalid': true,
+			'named-grid-areas-no-invalid': true,
+			'no-descending-specificity': true,
+			'no-duplicate-at-import-rules': true,
+			'no-duplicate-selectors': true,
+			'no-empty-source': true,
+			'no-invalid-double-slash-comments': true,
+			'no-invalid-position-at-import-rule': true,
+			'no-irregular-whitespace': true,
+			'property-no-unknown': true,
+			'selector-anb-no-unmatchable': true,
+			'selector-pseudo-class-no-unknown': true,
+			'selector-pseudo-element-no-unknown': true,
+			'selector-type-no-unknown': [
+				true,
+				{
+					ignore: ['custom-elements'],
+				},
+			],
+			'string-no-newline': true,
+			'unit-no-unknown': true,
+			...opt?.['rules'] as Record<string, unknown>,
+		},
+	};
+	return async code => (await stylelint.lint({code, config})).results.flatMap(({warnings}) => warnings);
+};
+
+/** 获取 Luacheck */
+export const getLuaLinter: getAsyncLinter<(text: string) => Promise<Diagnostic[]>> = async () => {
+	await loadScript('npm/luacheck-browserify/dist/index.min.js', 'luacheck');
+	const luachecker = await luacheck(undefined as unknown as string);
+	return async text => (await luachecker.queue(text)).filter(({severity}) => severity);
+};
+
+declare interface JsonError {
+	message: string;
+	severity: 'error';
+	line: string | undefined;
+	column: string | undefined;
+	position: string | undefined;
+}
+
+/** JSON.parse */
+export const getJsonLinter: getLinter<(text: string) => JsonError[]> = () => str => {
+	try {
+		if (str.trim()) {
+			JSON.parse(str);
+		}
+	} catch (e) {
+		if (e instanceof SyntaxError) {
+			const {message} = e,
+				line = /\bline (\d+)/u.exec(message)?.[1],
+				column = /\bcolumn (\d+)/u.exec(message)?.[1],
+				position = /\bposition (\d+)/u.exec(message)?.[1];
+			return [
+				{
+					message,
+					severity: 'error',
+					line,
+					column,
+					position,
+				},
+			];
+		}
+	}
+	return [];
+};

package/src/static.ts

@@ -0,0 +1,66 @@
+import type {Config} from 'wikiparser-node';
+import type {MwConfig} from './token';
+
+export const tagModes = {
+	onlyinclude: 'mediawiki',
+	includeonly: 'mediawiki',
+	noinclude: 'mediawiki',
+	pre: 'text/pre',
+	nowiki: 'text/nowiki',
+	indicator: 'mediawiki',
+	poem: 'mediawiki',
+	ref: 'mediawiki',
+	references: 'text/references',
+	gallery: 'text/gallery',
+	poll: 'mediawiki',
+	tabs: 'mediawiki',
+	tab: 'mediawiki',
+	choose: 'text/choose',
+	option: 'mediawiki',
+	combobox: 'text/combobox',
+	combooption: 'mediawiki',
+	inputbox: 'text/inputbox',
+	templatedata: 'json',
+	mapframe: 'json',
+	maplink: 'json',
+	graph: 'json',
+};
+
+/**
+ * Object.fromEntries polyfill
+ * @param entries
+ * @param obj
+ * @param string 是否为字符串
+ */
+const fromEntries = (entries: readonly string[], obj: Record<string, unknown>, string?: boolean): void => {
+	for (const entry of entries) {
+		obj[entry] = string ? entry : true;
+	}
+};
+
+export const getStaticMwConfig = (
+	{parserFunction, protocol, nsid, variants, redirection, ext, doubleUnderscore, img}: Config,
+	modes: Record<string, string>,
+): MwConfig => {
+	const mwConfig: MwConfig = {
+			tags: {},
+			tagModes: modes,
+			doubleUnderscore: [{}, {}],
+			functionSynonyms: [parserFunction[0], {}],
+			urlProtocols: `${protocol}|//`,
+			nsid,
+			img: Object.fromEntries(Object.entries(img).map(([key, val]) => [key, `img_${val}`])),
+			variants,
+			redirection,
+		},
+		[insensitive,, obj] = doubleUnderscore;
+	fromEntries(ext, mwConfig.tags);
+	fromEntries(
+		(obj && insensitive.length === 0 ? Object.keys(obj) : insensitive).map(s => `__${s}__`),
+		mwConfig.doubleUnderscore[0],
+	);
+	fromEntries(doubleUnderscore[1].map(s => `__${s}__`), mwConfig.doubleUnderscore[1]);
+	fromEntries((parserFunction.slice(2) as string[][]).flat(), mwConfig.functionSynonyms[0], true);
+	fromEntries(parserFunction[1], mwConfig.functionSynonyms[1]);
+	return mwConfig;
+};