@bhsd/common 0.11.0 → 0.13.0

package/README.md

@@ -0,0 +1,4 @@
+# @bhsd/common
+
+[![npm version](https://badge.fury.io/js/@bhsd%2Fcommon.svg)](https://www.npmjs.com/package/@bhsd/common)
+[![License](https://img.shields.io/badge/License-MIT-brightgreen.svg)](LICENSE)

package/dist/index.d.ts

@@ -47,6 +47,16 @@ export declare const setObject: (key: string, value: unknown) => void;
  * @param baseVersion 基础版本号
  */
 export declare const compareVersion: (version: string, baseVersion: string) => boolean;
+/**
+ * 加载 I18N
+ * @param url 下载地址
+ * @param cur 当前版本号
+ * @param languages 语言代码列表
+ * @param key 存储的键名
+ * @param i18n 已存储的I18N对象
+ * @throws `Error` 无法获取语言包
+ */
+export declare const setI18N: (url: string, cur: string, languages: string[] | string, key: string, i18n?: Record<string, string>) => Promise<Record<string, string>>;
 /**
  * 加载 wikiparse
  * @param getConfig 获取解析配置的函数

package/dist/index.js

@@ -32,6 +32,7 @@ __export(index_exports, {
   rawurldecode: () => rawurldecode,
   refreshStdout: () => refreshStdout,
   sanitizeInlineStyle: () => sanitizeInlineStyle,
+  setI18N: () => setI18N,
   setObject: () => setObject,
   splitColors: () => splitColors
 });
@@ -114,6 +115,22 @@ const compareVersion = (version, baseVersion) => {
   const [major, minor] = parseVersion(version), [baseMajor, baseMinor] = parseVersion(baseVersion);
   return major > baseMajor || major === baseMajor && minor >= baseMinor;
 };
+const setI18N = async (url, cur, languages, key, i18n = getObject(key) ?? {}) => {
+  const { version, lang } = i18n, langs = Array.isArray(languages) ? languages : [languages];
+  if (version === cur && langs.includes(lang)) {
+    return i18n;
+  }
+  for (const language of langs) {
+    try {
+      const res = await fetch(`${url}/${language.toLowerCase()}.json`);
+      Object.assign(i18n, await res.json(), { version: cur, lang: language });
+      setObject(key, i18n);
+      return i18n;
+    } catch {
+    }
+  }
+  throw new Error(`Failed to fetch the localization for ${langs[0]}.`);
+};
 let configLoaded = false, i18nLoaded = false;
 const getWikiparse = async (getConfig, langs) => {
   const dir = "extensions/dist";
@@ -128,13 +145,11 @@ const getWikiparse = async (getConfig, langs) => {
   }
   if (!i18nLoaded && langs) {
     i18nLoaded = true;
-    for (const lang of Array.isArray(langs) ? langs : [langs]) {
-      try {
-        const i18n = await (await fetch(`${wikiparse.CDN}/i18n/${lang.toLowerCase()}.json`)).json();
-        wikiparse.setI18N(i18n);
-        break;
-      } catch {
-      }
+    const key = "wikiparse-i18n", { version } = wikiparse;
+    try {
+      wikiparse.setI18N(await setI18N(`${wikiparse.CDN}/i18n`, version, langs, key));
+    } catch {
+      setObject(key, { version, lang: "en" });
     }
   }
 };

package/dist/index.mjs

@@ -76,6 +76,22 @@ const compareVersion = (version, baseVersion) => {
   const [major, minor] = parseVersion(version), [baseMajor, baseMinor] = parseVersion(baseVersion);
   return major > baseMajor || major === baseMajor && minor >= baseMinor;
 };
+const setI18N = async (url, cur, languages, key, i18n = getObject(key) ?? {}) => {
+  const { version, lang } = i18n, langs = Array.isArray(languages) ? languages : [languages];
+  if (version === cur && langs.includes(lang)) {
+    return i18n;
+  }
+  for (const language of langs) {
+    try {
+      const res = await fetch(`${url}/${language.toLowerCase()}.json`);
+      Object.assign(i18n, await res.json(), { version: cur, lang: language });
+      setObject(key, i18n);
+      return i18n;
+    } catch {
+    }
+  }
+  throw new Error(`Failed to fetch the localization for ${langs[0]}.`);
+};
 let configLoaded = false, i18nLoaded = false;
 const getWikiparse = async (getConfig, langs) => {
   const dir = "extensions/dist";
@@ -90,13 +106,11 @@ const getWikiparse = async (getConfig, langs) => {
   }
   if (!i18nLoaded && langs) {
     i18nLoaded = true;
-    for (const lang of Array.isArray(langs) ? langs : [langs]) {
-      try {
-        const i18n = await (await fetch(`${wikiparse.CDN}/i18n/${lang.toLowerCase()}.json`)).json();
-        wikiparse.setI18N(i18n);
-        break;
-      } catch {
-      }
+    const key = "wikiparse-i18n", { version } = wikiparse;
+    try {
+      wikiparse.setI18N(await setI18N(`${wikiparse.CDN}/i18n`, version, langs, key));
+    } catch {
+      setObject(key, { version, lang: "en" });
     }
   }
 };
@@ -143,6 +157,7 @@ export {
   rawurldecode,
   refreshStdout,
   sanitizeInlineStyle,
+  setI18N,
   setObject,
   splitColors
 };

package/dist/test.d.ts

@@ -0,0 +1,38 @@
+declare interface MediaWikiPage {
+    readonly pageid: number;
+    readonly title: string;
+    readonly ns: number;
+    readonly revisions?: {
+        readonly content: string;
+        readonly contentmodel: string;
+    }[];
+}
+export interface SimplePage extends Pick<MediaWikiPage, 'pageid' | 'title' | 'ns'> {
+    readonly content: string;
+}
+export interface Test {
+    desc: string;
+    wikitext?: string;
+    parsed?: string;
+    html?: string;
+    print?: string;
+    render?: string;
+}
+/**
+ * 获取最近更改的页面源代码
+ * @param url api.php网址
+ * @param site 站点名称
+ * @param grclimit 页面数上限
+ */
+export declare const getPages: (url: string, site?: string, grclimit?: string) => Promise<SimplePage[]>;
+/** 重置请求 */
+export declare const reset: () => void;
+/**
+ * 执行解析测试
+ * @param parse 解析函数
+ * @param retry 重试次数
+ * @param grclimit 页面数上限
+ */
+export declare const execute: (parse: (wikitext: string) => unknown, retry?: number, grclimit?: string) => Promise<void>;
+export declare const mochaTest: (results: unknown, parse: (wikitext: string) => string, beforeFn?: Mocha.Func | Mocha.AsyncFunc) => void;
+export {};

package/dist/test.js

@@ -0,0 +1,172 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// test/test.ts
+var test_exports = {};
+__export(test_exports, {
+  execute: () => execute,
+  getPages: () => getPages,
+  mochaTest: () => mochaTest,
+  reset: () => reset
+});
+module.exports = __toCommonJS(test_exports);
+var import_fs = __toESM(require("fs"));
+var import_assert = __toESM(require("assert"));
+var import_perf_hooks = require("perf_hooks");
+
+// src/index.ts
+var refreshStdout = (str) => {
+  process.stdout.write(`\x1B[K\x1B[?7l${str}\x1B[?7h\r`);
+};
+
+// test/test.ts
+var apis = [
+  ["维基百科", "https://zh.wikipedia.org/w"],
+  ["Wikipedia", "https://en.wikipedia.org/w"],
+  ["ウィキペディア", "https://ja.wikipedia.org/w"]
+];
+var c;
+var getPages = async (url, site, grclimit = "max") => {
+  const qs = {
+    action: "query",
+    format: "json",
+    formatversion: "2",
+    errorformat: "plaintext",
+    generator: "recentchanges",
+    grcnamespace: site === "MediaWiki" ? "0|10|12|100|102|104|106" : "0|10",
+    grclimit,
+    grctype: "edit|new",
+    grctoponly: "1",
+    prop: "revisions",
+    rvprop: "contentmodel|content",
+    ...c
+  }, response = await (await fetch(`${url}?${String(new URLSearchParams(qs))}`)).json();
+  c = response.continue;
+  return response.query.pages.map(({ pageid, title, ns, revisions }) => ({
+    pageid,
+    title,
+    ns,
+    content: revisions?.[0]?.contentmodel === "wikitext" && revisions[0].content
+  })).filter((page) => page.content !== false);
+};
+var reset = () => {
+  c = void 0;
+};
+var execute = async (parse, retry = 10, grclimit) => {
+  const failures = /* @__PURE__ */ new Map();
+  for (const [site, url] of apis) {
+    console.log(`开始检查${site}：`);
+    let worst;
+    reset();
+    try {
+      let failed = 0, i = 0;
+      for (let j = 0; j < retry; j++) {
+        for (const { content, title } of await getPages(`${url}/api.php`, site, grclimit)) {
+          refreshStdout(`${i++} ${title}`);
+          try {
+            const start = import_perf_hooks.performance.now();
+            parse(content);
+            const duration = import_perf_hooks.performance.now() - start;
+            if (!worst || duration > worst.duration) {
+              worst = { title, duration };
+            }
+          } catch (e) {
+            console.error(`
+解析 ${title} 页面时出错！`, e);
+            failed++;
+          }
+        }
+      }
+      if (failed) {
+        failures.set(site, failed);
+      }
+      console.log(`
+最耗时页面：${worst.title} (${worst.duration.toFixed(3)}ms)`);
+    } catch (e) {
+      console.error(`访问${site}的API端口时出错！`, e);
+    }
+  }
+  if (failures.size > 0) {
+    let total = 0;
+    for (const [site, failed] of failures) {
+      console.error(`${site}：${failed} 个页面解析失败！`);
+      total += failed;
+    }
+    throw new Error(`共有 ${total} 个页面解析失败！`);
+  }
+};
+var tests = require("wikiparser-node/test/parserTests.json");
+var split = (test) => test?.parsed?.split(/(?<=<\/>)(?!$)|(?<!^)(?=<\w)/u);
+var mochaTest = (results, parse, beforeFn) => {
+  describe("Parser tests", () => {
+    for (let i = tests.length - 1; i >= 0; i--) {
+      const test = tests[i], { wikitext, desc } = test;
+      if (wikitext) {
+        it(desc, () => {
+          try {
+            delete test.html;
+            delete test.print;
+            delete test.render;
+            test.parsed = parse(wikitext);
+            import_assert.default.deepStrictEqual(
+              split(test),
+              split(results.find(({ desc: d }) => d === desc))
+            );
+          } catch (e) {
+            if (!(e instanceof import_assert.default.AssertionError)) {
+              tests.splice(i, 1);
+            }
+            if (e instanceof Error) {
+              Object.assign(e, { cause: { message: `
+${wikitext}` } });
+            }
+            throw e;
+          }
+        });
+      }
+    }
+    if (beforeFn) {
+      before(beforeFn);
+    }
+    after(() => {
+      import_fs.default.writeFileSync(
+        "test/parserTests.json",
+        `${JSON.stringify(tests, null, "	")}
+`
+      );
+    });
+  });
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  execute,
+  getPages,
+  mochaTest,
+  reset
+});

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@bhsd/common",
-	"version": "0.11.0",
+	"version": "0.13.0",
 	"license": "MIT",
 	"author": "Bhsd",
 	"files": [
@@ -24,17 +24,19 @@
 			"import": "./dist/cm.mjs",
 			"require": "./dist/cm.js"
 		},
+		"./dist/test": {
+			"types": "./dist/test.d.ts",
+			"import": "./dist/test.js",
+			"require": "./dist/test.js"
+		},
 		"./*.cjs": "./*.cjs",
 		"./package.json": "./package.json"
 	},
 	"types": "./dist/index.d.ts",
 	"sideEffects": false,
-	"bin": {
-		"copy-dev": "bin/dev.cjs"
-	},
 	"scripts": {
 		"prepublishOnly": "npm run build",
-		"build": "tsc --emitDeclarationOnly && esbuild src/* --charset=utf8 --target=es2024 --format=cjs --outdir=dist && esbuild src/* --charset=utf8 --target=es2024 --format=esm --outdir=dist --out-extension:.js=.mjs && rm dist/global.*",
+		"build": "tsc && esbuild src/* --charset=utf8 --target=es2024 --format=cjs --outdir=dist && esbuild test/* --charset=utf8 --target=es2024 --format=cjs --outdir=dist --bundle --platform=node --external:wikiparser-node && esbuild src/* --charset=utf8 --target=es2024 --format=esm --outdir=dist --out-extension:.js=.mjs && mv dist/*/*.d.ts dist/ && rm dist/global.*",
 		"lint:ts": "tsc --noEmit && eslint --cache .",
 		"lint": "npm run lint:ts"
 	},
@@ -54,15 +56,12 @@
 		"eslint-plugin-eslint-comments": "^3.2.0",
 		"eslint-plugin-jsdoc": "^50.6.3",
 		"eslint-plugin-json-es": "^1.6.0",
-		"eslint-plugin-markdown": "4.0.1",
 		"eslint-plugin-n": "^17.15.1",
 		"eslint-plugin-promise": "^7.2.1",
 		"eslint-plugin-regexp": "^2.7.0",
 		"eslint-plugin-unicorn": "^56.0.1",
-		"http-server": "^14.1.1",
-		"mocha": "^11.1.0",
-		"stylelint": "^16.19.1",
+		"stylelint": "^16.20.0",
 		"typescript": "^5.8.2",
-		"wikiparser-node": "^1.20.3"
+		"wikiparser-node": "^1.21.2"
 	}
 }

package/bin/dev.cjs

@@ -1,15 +0,0 @@
-#!/usr/bin/env node
-'use strict';
-
-const fs = require('fs'),
-	{devDependencies, version} = require('@bhsd/common/package.json'),
-	json = require(`${process.cwd()}/package.json`);
-const {name: n, dependencies, optionalDependencies} = json,
-	others = {[n]: '', ...dependencies, ...optionalDependencies},
-	dev = Object.fromEntries(
-		Object.entries({...json.devDependencies, ...devDependencies}).filter(([k]) => !(k in others))
-			.sort(([a], [b]) => a.localeCompare(b)),
-	);
-(dependencies && '@bhsd/common' in dependencies ? dependencies : dev)['@bhsd/common'] = `^${version}`;
-json.devDependencies = dev;
-fs.writeFileSync('package.json', `${JSON.stringify(json, null, '\t')}\n`);