@bhsd/codemirror-mediawiki 2.9.0 → 2.9.2

package/mw/README.md

@@ -1,156 +0,0 @@
-<details>
-	<summary>Expand</summary>
-
-- [Usage](#usage)
-- [Constructor](#constructor)
-- [Accessors](#accessors)
-- [Methods](#methods)
-	- [defaultLint](#defaultlint)
-- [Static properties](#static-properties)
-	- [version](#version)
-- [Static methods](#static-methods)
-	- [fromTextArea](#fromtextarea)
-- [Extensions](#extensions)
-	- [openLinks](#openlinks)
-	- [wikiEditor](#wikieditor)
-	- [save](#save)
-
-</details>
-
-# Usage
-
-You can download the code via CDN, for example:
-
-```js
-// static import
-import {CodeMirror} from 'https://cdn.jsdelivr.net/npm/@bhsd/codemirror-mediawiki/dist/mw.min.js';
-```
-
-or
-
-```js
-import {CodeMirror} from 'https://unpkg.com/@bhsd/codemirror-mediawiki/dist/mw.min.js';
-```
-
-or
-
-```js
-// dynamic import
-const {CodeMirror} = await import('https://cdn.jsdelivr.net/npm/@bhsd/codemirror-mediawiki/dist/mw.min.js');
-```
-
-or
-
-```js
-const {CodeMirror} = await import('https://unpkg.com/@bhsd/codemirror-mediawiki/dist/mw.min.js');
-```
-
-The script also loads the [styles](../mediawiki.css), adds a button to configure user preferences, and watches `Shift`-clicks of any textarea.
-
-# Constructor
-
-<details>
-	<summary>Expand</summary>
-
-*version added: 2.2.2*
-
-The `CodeMirror` class extends the [`CodeMirror6`](../README.md#constructor) class with one more argument to specify the namespace.
-
-**param**: `HTMLTextAreaElement` the textarea element to be replaced by CodeMirror  
-**param**: `string` the language mode to be used, default as plain text  
-**param**: `number` the namespace id associated with the content, default as the current namespace  
-**param**: `unknown` the optional language configuration  
-
-```js
-const cm = new CodeMirror6(textarea); // plain text
-const cm = new CodeMirror6(textarea, 'mediawiki', undefined, mwConfig);
-const cm = new CodeMirror6(textarea, 'html', 274, mwConfig); // mixed MediaWiki-HTML
-const cm = new CodeMirror6(textarea, 'css');
-const cm = new CodeMirror6(textarea, 'javascript');
-const cm = new CodeMirror6(textarea, 'json');
-const cm = new CodeMirror6(textarea, 'lua');
-```
-
-</details>
-
-# Accessors
-
-The `CodeMirror` class inherits all the [accessors](../README.md#accessors) from the `CodeMirror6` class.
-
-# Methods
-
-The `CodeMirror` class inherits all the [methods](../README.md#methods) from the `CodeMirror6` class and addes more.
-
-## defaultLint
-
-<details>
-	<summary>Expand</summary>
-
-*version added: 2.1.9*
-
-**param**: `boolean` whether to start linting  
-**param**: `Record<string, unknown> | number` the optional linter configuration or the namespace id  
-Lint with a default linter.
-
-```js
-cm.defaultLint(true, 0);
-```
-
-</details>
-
-# Static properties
-
-## version
-
-<details>
-	<summary>Expand</summary>
-
-*version added: 2.6.3*
-
-**type**: `string`  
-The version number.
-</details>
-
-# Static methods
-
-The `CodeMirror` class inherits all the [static methods](../README.md#static-methods) from the `CodeMirror6` class and addes more.
-
-## fromTextArea
-
-<details>
-	<summary>Expand</summary>
-
-*version added: 2.2.2*
-
-**param**: `HTMLTextAreaElement` the textarea element to be replaced by CodeMirror  
-**param**: `string` the language mode to be used, default as plain text  
-**param**: `number` the namespace id associated with the content, default as the current namespace  
-Replace the textarea with CodeMirror editor.
-
-```js
-CodeMirror6.fromTextArea(textarea, 'mediawiki');
-```
-
-</details>
-
-# Extensions
-
-The `CodeMirror` class inherits all the [extensions](../README.md#extensions) from the `CodeMirror6` class and addes more.
-
-## openLinks
-
-*version added: 2.1.15*
-
-CTRL/CMD-click opens a wikilink or template or external link in a new tab.
-
-## wikiEditor
-
-*version added: 2.4.5*
-
-Load the WikiEditor toolbar. This extension can only be used before CodeMirror instantiation, which means it is inaccessible by the [`prefer`](../README.md#prefer) method.
-
-## save
-
-*version added: 2.7.0*
-
-Save preferences as JSON on a user subpage (`Special:Mypage/codemirror-mediawiki.json`).

package/mw/base.ts

@@ -1,262 +0,0 @@
-import {CodeMirror6, CDN} from 'https://testingcf.jsdelivr.net/npm/@bhsd/codemirror-mediawiki@2.9.0/dist/main.min.js';
-import {getMwConfig, getParserConfig} from './config';
-import {openLinks} from './openLinks';
-import {instances, textSelection} from './textSelection';
-import {openPreference, prefs, indentKey, wikilintConfig, codeConfigs, loadJSON} from './preference';
-import {msg, setI18N, welcome, REPO_CDN, curVersion, localize} from './msg';
-import {wikiEditor} from './wikiEditor';
-import type {Diagnostic} from '@codemirror/lint';
-import type {Config, LintError} from 'wikiparser-node';
-import type {Linter} from 'eslint';
-import type {LintSource, MwConfig} from '../src/codemirror';
-
-// 每次新增插件都需要修改这里
-const baseVersion = '2.7',
-	addons = ['save'];
-
-mw.loader.load(`${CDN}/${REPO_CDN}/mediawiki.min.css`, 'text/css');
-
-/**
- * jQuery.val overrides for CodeMirror.
- */
-$.valHooks['textarea'] = {
-	get(elem: HTMLTextAreaElement): string {
-		const cm = instances.get(elem);
-		return cm?.visible ? cm.view.state.doc.toString() : elem.value;
-	},
-	set(elem: HTMLTextAreaElement, value: string): void {
-		const cm = instances.get(elem);
-		if (cm?.visible) {
-			cm.setContent(value);
-		} else {
-			elem.value = value;
-		}
-	},
-};
-
-const linters: Record<string, LintSource | undefined> = {};
-
-/**
- * 判断是否为普通编辑器
- * @param textarea 文本框
- */
-const isEditor = (textarea: HTMLTextAreaElement): boolean => !textarea.closest('#cm-preference');
-
-/** 专用于MW环境的 CodeMirror 6 编辑器 */
-export class CodeMirror extends CodeMirror6 {
-	static version = curVersion;
-
-	ns;
-
-	/**
-	 * @param textarea 文本框
-	 * @param lang 语言
-	 * @param ns 命名空间
-	 * @param config 语言设置
-	 */
-	constructor(textarea: HTMLTextAreaElement, lang?: string, ns?: number, config?: unknown) {
-		if (instances.get(textarea)?.visible) {
-			throw new RangeError('The textarea has already been replaced by CodeMirror.');
-		}
-		super(textarea, lang, config);
-		this.ns = ns;
-		instances.set(textarea, this);
-		if (mw.loader.getState('jquery.textSelection') === 'ready') {
-			$(textarea).data('jquery.textSelection', textSelection);
-		}
-		if (isEditor(textarea)) {
-			mw.hook('wiki-codemirror6').fire(this);
-			if (textarea.id === 'wpTextbox1') {
-				textarea.form?.addEventListener('submit', () => {
-					const scrollTop = document.querySelector<HTMLInputElement>('#wpScrolltop');
-					if (scrollTop) {
-						scrollTop.value = String(this.view.scrollDOM.scrollTop);
-					}
-				});
-			}
-		}
-	}
-
-	override toggle(show = !this.visible): void {
-		super.toggle(show);
-		$(this.textarea).data('jquery.textSelection', show && textSelection);
-	}
-
-	override async getLinter(opt?: Record<string, unknown>): Promise<LintSource | undefined> {
-		const linter = await super.getLinter(opt);
-		linters[this.lang] = linter;
-		return linter;
-	}
-
-	/**
-	 * 添加或移除默认 linter
-	 * @param on 是否添加
-	 * @param opt linter选项
-	 * @param ns 命名空间
-	 */
-	defaultLint(on: boolean, opt: Record<string, unknown>): Promise<void>;
-	defaultLint(on: boolean, ns?: number): Promise<void>;
-	async defaultLint(on: boolean, optOrNs: Record<string, unknown> | number | undefined = this.ns): Promise<void> {
-		if (!on) {
-			this.lint();
-			return;
-		}
-		const {lang} = this,
-			eslint = codeConfigs.get('ESLint'),
-			stylelint = codeConfigs.get('Stylelint');
-		let opt: Record<string, unknown> | undefined;
-		if (typeof optOrNs === 'number') {
-			if (lang === 'mediawiki' && (optOrNs === 10 || optOrNs === 828 || optOrNs === 2)) {
-				opt = {include: true};
-			} else if (lang === 'javascript') {
-				opt = {
-					env: {browser: true, es2024: true, jquery: true},
-					globals: {mw: 'readonly', mediaWiki: 'readonly', OO: 'readonly'},
-					...optOrNs === 8 || optOrNs === 2300 ? {parserOptions: {ecmaVersion: 8}} : {},
-					...eslint,
-				} as Linter.Config as Record<string, unknown>;
-			} else if (lang === 'css' && stylelint) {
-				opt = stylelint;
-			}
-		} else {
-			opt = optOrNs;
-		}
-		if (!(lang in linters)) {
-			if (lang === 'mediawiki') {
-				const i18n = mw.config.get('wgUserLanguage');
-				if (['zh', 'zh-hans', 'zh-cn', 'zh-sg', 'zh-my'].includes(i18n)) {
-					opt = {...opt, i18n: 'zh-hans'};
-				} else if (['zh-hant', 'zh-tw', 'zh-hk', 'zh-mo'].includes(i18n)) {
-					opt = {...opt, i18n: 'zh-hant'};
-				}
-			}
-			await this.getLinter(opt);
-			if (lang === 'mediawiki') {
-				const [mwConfig, minConfig] = await Promise.all([getMwConfig(), wikiparse.getConfig()]);
-				wikiparse.setConfig(getParserConfig(minConfig, mwConfig));
-			}
-		} else if (opt) {
-			await this.getLinter(opt);
-		}
-		if (linters[lang]) {
-			if (lang === 'mediawiki') {
-				this.lint(
-					async doc => (await linters[lang]!(doc) as (Diagnostic & {rule: LintError.Rule})[])
-						.filter(({rule, severity}) => Number(wikilintConfig[rule]) > Number(severity === 'warning')),
-				);
-			} else {
-				this.lint(linters[lang]);
-			}
-		}
-	}
-
-	override prefer(extensions: string[] | Record<string, boolean>): void {
-		super.prefer(extensions);
-		const hasExtension = Array.isArray(extensions)
-				? (ext: string): boolean => extensions.includes(ext)
-				: (ext: string): boolean | undefined => extensions[ext],
-			hasLint = hasExtension('lint');
-		if (hasLint !== undefined) {
-			void this.defaultLint(hasLint);
-		}
-		openLinks(this, hasExtension('openLinks'));
-		if (!Array.isArray(extensions)) {
-			for (const [k, v] of Object.entries(extensions)) {
-				prefs[v ? 'add' : 'delete'](k);
-			}
-		}
-	}
-
-	/**
-	 * 将 textarea 替换为 CodeMirror
-	 * @param textarea textarea 元素
-	 * @param lang 语言
-	 * @param ns 命名空间
-	 */
-	static async fromTextArea(textarea: HTMLTextAreaElement, lang?: string, ns?: number): Promise<CodeMirror> {
-		if (prefs.has('wikiEditor') && isEditor(textarea)) {
-			await wikiEditor($(textarea));
-		}
-		if (!lang && ns === undefined) {
-			/* eslint-disable no-param-reassign */
-			const {wgAction, wgNamespaceNumber, wgPageContentModel} = mw.config.get();
-			if (wgAction === 'edit' || wgAction === 'submit') {
-				ns = wgNamespaceNumber;
-				lang = wgNamespaceNumber === 274 ? 'html' : wgPageContentModel.toLowerCase();
-			} else {
-				await mw.loader.using('oojs-ui-windows');
-				lang = (await OO.ui.prompt(msg('contentmodel')) || undefined)?.toLowerCase();
-			}
-			if (lang && lang in langMap) {
-				lang = langMap[lang];
-			}
-			/* eslint-enable no-param-reassign */
-		}
-		const isWiki = lang === 'mediawiki' || lang === 'html',
-			cm = new CodeMirror(textarea, isWiki ? undefined : lang, ns);
-		if (isWiki) {
-			let config: MwConfig;
-			if (mw.config.get('wgServerName').endsWith('.moegirl.org.cn')) {
-				if (mw.config.exists('wikilintConfig')) {
-					config = mw.config.get('extCodeMirrorConfig') as MwConfig;
-				} else {
-					const parserConfig: Config = await (await fetch(
-						`${CDN}/npm/wikiparser-node@browser/config/moegirl.json`,
-					)).json();
-					mw.config.set('wikilintConfig', parserConfig);
-					config = CodeMirror6.getMwConfig(parserConfig);
-					mw.config.set('extCodeMirrorConfig', config);
-				}
-			} else {
-				config = await getMwConfig();
-			}
-			cm.setLanguage(lang, config);
-		}
-		await loadJSON;
-		cm.prefer([...prefs]);
-		const indent = localStorage.getItem(indentKey);
-		if (indent) {
-			cm.setIndent(indent);
-		}
-		return cm;
-	}
-}
-
-const langMap: Record<string, string> = {
-	'sanitized-css': 'css',
-	js: 'javascript',
-	scribunto: 'lua',
-	wikitext: 'mediawiki',
-};
-document.body.addEventListener('click', e => {
-	if (e.target instanceof HTMLTextAreaElement && e.shiftKey && !instances.has(e.target)) {
-		e.preventDefault();
-		void CodeMirror.fromTextArea(e.target);
-	}
-});
-
-(async () => {
-	const portletContainer: Record<string, string> = {
-		minerva: 'page-actions-overflow',
-		moeskin: 'ca-more-actions',
-		citizen: 'p-tb',
-	};
-	await Promise.all([
-		mw.loader.using('mediawiki.util'),
-		setI18N(CDN),
-	]);
-	mw.hook('wiki-codemirror6').add(localize);
-	mw.util.addPortletLink(
-		portletContainer[mw.config.get('skin')] || 'p-cactions',
-		'#',
-		msg('title'),
-		'cm-settings',
-	).addEventListener('click', e => {
-		e.preventDefault();
-		const textareas = [...document.querySelectorAll<HTMLTextAreaElement>('.cm-editor + textarea')];
-		void openPreference(textareas.map(textarea => instances.get(textarea)));
-	});
-	void welcome(baseVersion, addons);
-})();
-
-Object.assign(window, {CodeMirror6: CodeMirror});

package/mw/config.ts

@@ -1,183 +0,0 @@
-import {setObject, getObject} from './msg';
-import {CodeMirror} from './base';
-import type {Config} from 'wikiparser-node';
-import type {MwConfig} from '../src/mediawiki';
-
-declare interface MagicWord {
-	name: string;
-	aliases: string[];
-	'case-sensitive': boolean;
-}
-
-// 和本地缓存有关的常数
-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}>
-		= getObject('InPageEditMwConfig') || {},
-	SITE_ID = `${mw.config.get('wgServerName')}${mw.config.get('wgScriptPath')}`,
-	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: (word: MagicWord) => boolean,
-	flip?: boolean,
-): Record<string, string> => {
-	const words = 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,
-			}))),
-		obj: Record<string, string> = {};
-	for (const {alias, name} of words) {
-		obj[alias] = name;
-	}
-	return obj;
-};
-
-/**
- * 将魔术字信息转换为CodeMirror接受的设置
- * @param magicWords 完整魔术字列表
- * @param rule 过滤函数
- */
-const getConfigPair = (
-	magicWords: MagicWord[],
-	rule: (word: MagicWord) => boolean,
-): [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模块需要的设置 */
-export const getMwConfig = async (): Promise<MwConfig> => {
-	if (USING_LOCAL && !VALID) { // 只在localStorage过期时才会重新加载ext.CodeMirror.data
-		await mw.loader.using(DATA_MODULE);
-	}
-
-	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'),
-		tagModes = CodeMirror.mwTagModes;
-	// 情形1：config已更新，可能来自localStorage
-	if (config?.img && config.variants && !isIPE) {
-		config.urlProtocols = config.urlProtocols.replace(/\\:/gu, ':');
-		return {...config, nsid, tagModes};
-	}
-
-	// 以下情形均需要发送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`
-		// @ts-expect-error incomplete properties
-		config = {
-			tagModes: {},
-			tags: {},
-			urlProtocols: mw.config.get('wgUrlProtocols').replace(/\\:/gu, ':'),
-		};
-		for (const tag of extensiontags) {
-			config!.tags[tag.slice(1, -1)] = true;
-		}
-		const functions = new Set([
-			...functionhooks,
-			...variables,
-			...others,
-		]);
-		config!.functionSynonyms = getConfigPair(magicwords, ({name}) => functions.has(name));
-		config!.doubleUnderscore = getConfigPair(
-			magicwords,
-			({aliases}) => aliases.some(alias => /^__.+__$/u.test(alias)),
-		);
-		config!.fromApi = true;
-	}
-	config!.img = getConfig(magicwords, ({name}) => name.startsWith('img_'));
-	config!.variants = variants ? variants.map(({code}) => code) : [];
-	config!.nsid = nsid;
-	Object.assign(config!.tagModes, tagModes);
-	setConfig(config!);
-	ALL_SETTINGS_CACHE[SITE_ID] = {config: config!, time: Date.now()};
-	setObject('InPageEditMwConfig', ALL_SETTINGS_CACHE);
-	return config!;
-};
-
-/**
- * 将MwConfig转换为Config
- * @param minConfig 基础Config
- * @param mwConfig
- */
-export const getParserConfig = (minConfig: Config, mwConfig: MwConfig): Config => {
-	if (mw.config.exists('wikilintConfig')) {
-		return mw.config.get('wikilintConfig') as 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,
-	};
-	[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, val] of Object.entries(mwConfig.img!)) {
-		config.img[key] = val.slice(4);
-	}
-	return config;
-};