wikilint 2.25.1 → 2.26.0

package/README.md

@@ -18,7 +18,7 @@ npx wikilint --config zhwiki --include --lang zh-hans *.wiki
 
 | Option | Argument | Description | Default |
 | :----- | :------- | :---------- | :------ |
-| `-c`, `--config` | \<path or preset config\> | Choose parser's configuration | `default` |
+| `-c`, `--config` | \<path or preset config\> | Choose parser's [configuration](https://github.com/bhsd-harry/wikiparser-node/wiki/Parser-%28EN%29#config) | `default` |
 | `--cache` | | Enable caching | `false` |
 | `--cache-file` | \<path\> | Specify cache file and enable caching | `.wikilintcache` |
 | `--ext` | \<extension\> | Specify file extension<br>Can be used multiple times | all files |
@@ -26,8 +26,8 @@ npx wikilint --config zhwiki --include --lang zh-hans *.wiki
 | `-h`, `--help` | | Print available options | |
 | `-i`, `--include` | | Parse for inclusion | `false` |
 | `--ignore` | \<pattern\> | Ignore files matching the glob pattern<br>Can be used multiple times | |
-| `-l`, `--lang` | \<path or preset language\> | Choose i18n language | English |
-| `--lc`, `--lint-config` | \<path\> | Specify lint config file | `.wikilintrc.json`<br>`.wikilintrc.js`<br>`.wikilintrc.cjs`<br>`.wikilintrc.mjs` |
+| `-l`, `--lang` | \<path or preset language\> | Choose [i18n](https://github.com/bhsd-harry/wikiparser-node/wiki/Parser-%28EN%29#i18n) language | English |
+| `--lc`, `--lint-config` | \<path\> | Specify [lint config](https://github.com/bhsd-harry/wikiparser-node/wiki/Rules#configuration) file | `.wikilintrc.json`<br>`.wikilintrc.js`<br>`.wikilintrc.cjs`<br>`.wikilintrc.mjs` |
 | `-q`, `--quiet` | | Report errors only | errors and warnings |
 | `-r`, `--recursive` | | Recursively lint files | `false` |
 | `-s`, `--strict` | | Exit when there is an error or warning<br>Override `-q` or `--quiet` | Exit `1` only where there is an error |

package/config/default.json

@@ -549,6 +549,7 @@
 		"dir",
 		"interwikilink",
 		"interlanguagelink",
+		"contentmodel",
 		"timef",
 		"timefl",
 		"pendingchangelevel",
@@ -654,6 +655,7 @@
 		"numberofadmins",
 		"cascadingsources",
 		"bcp47",
+		"contentmodel",
 		"dir",
 		"language",
 		"numberofwikis",
@@ -1343,6 +1345,7 @@
 			"#dir": "dir",
 			"#interwikilink": "interwikilink",
 			"#interlanguagelink": "interlanguagelink",
+			"#contentmodel": "contentmodel",
 			"#timef": "timef",
 			"#timefl": "timefl",
 			"USERLANGUAGE": "userlanguage"

package/config/enwiki.json

@@ -242,6 +242,7 @@
 		"dir",
 		"interwikilink",
 		"interlanguagelink",
+		"contentmodel",
 		"int",
 		"special",
 		"speciale",
@@ -363,6 +364,7 @@
 		"numberofadmins",
 		"cascadingsources",
 		"bcp47",
+		"contentmodel",
 		"dir",
 		"language",
 		"numberofwikis",
@@ -499,6 +501,7 @@
 			"#dir": "dir",
 			"#interwikilink": "interwikilink",
 			"#interlanguagelink": "interlanguagelink",
+			"#contentmodel": "contentmodel",
 			"DISPLAYTITLE": "displaytitle",
 			"#timef": "timef",
 			"#timefl": "timefl",

package/config/jawiki.json

@@ -271,6 +271,7 @@
 		"dir",
 		"interwikilink",
 		"interlanguagelink",
+		"contentmodel",
 		"int",
 		"special",
 		"speciale",
@@ -389,6 +390,7 @@
 		"numberofadmins",
 		"cascadingsources",
 		"bcp47",
+		"contentmodel",
 		"dir",
 		"language",
 		"numberofwikis",
@@ -695,6 +697,7 @@
 			"#dir": "dir",
 			"#interwikilink": "interwikilink",
 			"#interlanguagelink": "interlanguagelink",
+			"#contentmodel": "contentmodel",
 			"表示タイトル": "displaytitle",
 			"DISPLAYTITLE": "displaytitle",
 			"#timef": "timef",

package/config/minimum.json

@@ -183,6 +183,7 @@
 			"#dir": "dir",
 			"#interwikilink": "interwikilink",
 			"#interlanguagelink": "interlanguagelink",
+			"#contentmodel": "contentmodel",
 			"#timef": "timef",
 			"#timefl": "timefl"
 		},

package/config/moegirl.json

@@ -368,16 +368,6 @@
 		"formatdate",
 		"displaytitle",
 		"choose",
-		"var",
-		"varexists",
-		"var_final",
-		"vardefine",
-		"vardefineecho",
-		"while",
-		"dowhile",
-		"loop",
-		"forargs",
-		"fornumargs",
 		"widget",
 		"avatar",
 		"categorytree",
@@ -552,16 +542,6 @@
 			"#格式化日期": "formatdate",
 			"#日期格式化": "formatdate",
 			"#choose": "choose",
-			"#var": "var",
-			"#varexists": "varexists",
-			"#var_final": "var_final",
-			"#vardefine": "vardefine",
-			"#vardefineecho": "vardefineecho",
-			"#while": "while",
-			"#dowhile": "dowhile",
-			"#loop": "loop",
-			"#forargs": "forargs",
-			"#fornumargs": "fornumargs",
 			"#widget": "widget",
 			"#微件": "widget",
 			"#小部件": "widget",

package/config/zhwiki.json

@@ -383,6 +383,7 @@
 		"dir",
 		"interwikilink",
 		"interlanguagelink",
+		"contentmodel",
 		"int",
 		"special",
 		"speciale",
@@ -502,6 +503,7 @@
 		"numberofadmins",
 		"cascadingsources",
 		"bcp47",
+		"contentmodel",
 		"dir",
 		"language",
 		"numberofwikis",
@@ -790,6 +792,7 @@
 			"#dir": "dir",
 			"#interwikilink": "interwikilink",
 			"#interlanguagelink": "interlanguagelink",
+			"#contentmodel": "contentmodel",
 			"DISPLAYTITLE": "displaytitle",
 			"显示标题": "displaytitle",
 			"顯示標題": "displaytitle",

package/data/ext/math.json

@@ -7,6 +7,7 @@
 	"\\alpha",
 	"\\Alpha",
 	"\\amalg",
+	"\\and",
 	"\\And",
 	"\\angle",
 	"\\approx",
@@ -28,13 +29,16 @@
 	"\\backslash",
 	"\\bar",
 	"\\barwedge",
+	"\\Bbb",
 	"\\Bbbk",
 	"\\bcancel",
 	"\\because",
+	"\\begin",
 	"\\beta",
 	"\\Beta",
 	"\\beth",
 	"\\between",
+	"\\bf",
 	"\\big",
 	"\\Big",
 	"\\bigcap",
@@ -68,6 +72,7 @@
 	"\\blacktriangleleft",
 	"\\blacktriangleright",
 	"\\bmod",
+	"\\bold",
 	"\\boldsymbol",
 	"\\bot",
 	"\\bowtie",
@@ -81,6 +86,8 @@
 	"\\bullet",
 	"\\bumpeq",
 	"\\Bumpeq",
+	"\\C",
+	"\\cal",
 	"\\cancel",
 	"\\cancelto",
 	"\\cap",
@@ -178,6 +185,7 @@
 	"\\emph",
 	"\\empty",
 	"\\emptyset",
+	"\\end",
 	"\\epsilon",
 	"\\Epsilon",
 	"\\eqcirc",
@@ -226,17 +234,21 @@
 	"\\gtrless",
 	"\\gtrsim",
 	"\\gvertneqq",
+	"\\H",
 	"\\hAar",
 	"\\harr",
+	"\\hArr",
 	"\\Harr",
 	"\\hat",
 	"\\hbar",
+	"\\hbox",
 	"\\hearts",
 	"\\heartsuit",
 	"\\hline",
 	"\\hom",
 	"\\hookleftarrow",
 	"\\hookrightarrow",
+	"\\hphantom",
 	"\\hslash",
 	"\\iff",
 	"\\iiiint",
@@ -252,10 +264,13 @@
 	"\\infty",
 	"\\injlim",
 	"\\int",
+	"\\intbar",
+	"\\intBar",
 	"\\intercal",
 	"\\iota",
 	"\\Iota",
 	"\\isin",
+	"\\it",
 	"\\jmath",
 	"\\kappa",
 	"\\Kappa",
@@ -275,6 +290,7 @@
 	"\\lceil",
 	"\\ldots",
 	"\\le",
+	"\\left",
 	"\\leftarrow",
 	"\\Leftarrow",
 	"\\leftarrowtail",
@@ -349,6 +365,7 @@
 	"\\mathsf",
 	"\\mathtt",
 	"\\max",
+	"\\mbox",
 	"\\measuredangle",
 	"\\mho",
 	"\\mid",
@@ -414,7 +431,10 @@
 	"\\O",
 	"\\odot",
 	"\\officialeuro",
+	"\\oiiint",
+	"\\oiint",
 	"\\oint",
+	"\\ointctrclockwise",
 	"\\omega",
 	"\\Omega",
 	"\\omicron",
@@ -422,9 +442,11 @@
 	"\\ominus",
 	"\\operatorname",
 	"\\oplus",
+	"\\or",
 	"\\oslash",
 	"\\otimes",
 	"\\over",
+	"\\overarc",
 	"\\overbrace",
 	"\\overleftarrow",
 	"\\overleftrightarrow",
@@ -432,9 +454,12 @@
 	"\\overrightarrow",
 	"\\overset",
 	"\\P",
+	"\\pagecolor",
 	"\\parallel",
+	"\\part",
 	"\\partial",
 	"\\perp",
+	"\\phantom",
 	"\\phi",
 	"\\Phi",
 	"\\pi",
@@ -478,6 +503,7 @@
 	"\\rfloor",
 	"\\rho",
 	"\\Rho",
+	"\\right",
 	"\\rightarrow",
 	"\\Rightarrow",
 	"\\rightarrowtail",
@@ -489,6 +515,7 @@
 	"\\rightsquigarrow",
 	"\\rightthreetimes",
 	"\\risingdotseq",
+	"\\rm",
 	"\\Rrightarrow",
 	"\\Rsh",
 	"\\rtimes",
@@ -508,6 +535,7 @@
 	"\\sharp",
 	"\\shortmid",
 	"\\shortparallel",
+	"\\sideset",
 	"\\sigma",
 	"\\Sigma",
 	"\\sim",
@@ -565,6 +593,7 @@
 	"\\tau",
 	"\\Tau",
 	"\\tbinom",
+	"\\text",
 	"\\textbf",
 	"\\textit",
 	"\\textrm",
@@ -611,27 +640,38 @@
 	"\\upuparrows",
 	"\\urcorner",
 	"\\varcoppa",
+	"\\varDelta",
 	"\\varepsilon",
+	"\\varGamma",
 	"\\varinjlim",
 	"\\varkappa",
+	"\\varLambda",
 	"\\varliminf",
 	"\\varlimsup",
 	"\\varnothing",
+	"\\varointclockwise",
+	"\\varOmega",
 	"\\varphi",
+	"\\varPhi",
 	"\\varpi",
+	"\\varPi",
 	"\\varprojlim",
 	"\\varpropto",
 	"\\varrho",
 	"\\varsigma",
+	"\\varSigma",
 	"\\varstigma",
 	"\\varsubsetneq",
 	"\\varsubsetneqq",
 	"\\varsupsetneq",
 	"\\varsupsetneqq",
 	"\\vartheta",
+	"\\varTheta",
 	"\\vartriangle",
 	"\\vartriangleleft",
 	"\\vartriangleright",
+	"\\varUpsilon",
+	"\\varXi",
 	"\\vdash",
 	"\\vDash",
 	"\\Vdash",
@@ -642,6 +682,7 @@
 	"\\vert",
 	"\\Vert",
 	"\\vline",
+	"\\vphantom",
 	"\\Vvdash",
 	"\\wedge",
 	"\\weierp",

package/dist/base.d.mts

@@ -267,9 +267,21 @@ export interface LanguageService {
     setTargetWikipedia(wiki: string, user: string): Promise<void>;
 }
 export type SeverityLevel = 0 | 1 | 2;
-export type LintConfigValue = SeverityLevel | [SeverityLevel, Record<string, unknown>];
-export type LintConfig = Partial<Record<LintError.Rule, LintConfigValue>>;
-export interface LintConfiguration extends LintConfig {
+export type LintConfigValue = SeverityLevel | [SeverityLevel, Record<string, SeverityLevel>];
+export type LintRuleConfig = Partial<Record<LintError.Rule, LintConfigValue>>;
+export interface FullLintConfig {
+    rules: LintRuleConfig;
+    configurationComment?: string;
+    ignoreDisables?: boolean;
+    fix?: boolean;
+    computeEditInfo?: boolean;
+}
+export type LintConfig = LintRuleConfig | FullLintConfig;
+export interface LintRuleConfiguration extends LintRuleConfig {
+    getSeverity(rule: LintError.Rule, key?: string): LintError.Severity | false;
+}
+export interface LintConfiguration extends FullLintConfig {
+    rules: LintRuleConfiguration;
     getSeverity(rule: LintError.Rule, key?: string): LintError.Severity | false;
 }
 export interface Parser {

package/dist/base.d.ts

@@ -267,9 +267,21 @@ export interface LanguageService {
     setTargetWikipedia(wiki: string, user: string): Promise<void>;
 }
 export type SeverityLevel = 0 | 1 | 2;
-export type LintConfigValue = SeverityLevel | [SeverityLevel, Record<string, unknown>];
-export type LintConfig = Partial<Record<LintError.Rule, LintConfigValue>>;
-export interface LintConfiguration extends LintConfig {
+export type LintConfigValue = SeverityLevel | [SeverityLevel, Record<string, SeverityLevel>];
+export type LintRuleConfig = Partial<Record<LintError.Rule, LintConfigValue>>;
+export interface FullLintConfig {
+    rules: LintRuleConfig;
+    configurationComment?: string;
+    ignoreDisables?: boolean;
+    fix?: boolean;
+    computeEditInfo?: boolean;
+}
+export type LintConfig = LintRuleConfig | FullLintConfig;
+export interface LintRuleConfiguration extends LintRuleConfig {
+    getSeverity(rule: LintError.Rule, key?: string): LintError.Severity | false;
+}
+export interface LintConfiguration extends FullLintConfig {
+    rules: LintRuleConfiguration;
     getSeverity(rule: LintError.Rule, key?: string): LintError.Severity | false;
 }
 export interface Parser {

package/dist/bin/cli.js

@@ -335,6 +335,8 @@ catch {
             }
         })();
     }
+    index_1.default.lintConfig.computeEditInfo = false;
+    index_1.default.lintConfig.fix = true;
     for (const file of new Set(files.map(f => path_1.default.resolve(f)))) {
         const stat = fs_1.default.statSync(file);
         if (stat.isDirectory()) {

package/dist/bin/config.js

@@ -77,7 +77,7 @@ const mw = {
         },
     },
 };
-const pkg = "wikilint", version = "2.25.1";
+const pkg = "wikilint", version = "2.26.0";
 let mwConfig;
 /**
  * Get the parser configuration for a Wikimedia Foundation project.
@@ -123,7 +123,13 @@ exports.default = async (site, url, user, force, internal) => {
         format: 'json',
         formatversion: '2',
     }, { query: { general: { articlepath, variants }, magicwords, namespaces, namespacealiases, functionhooks, }, } = await (await fetch(`${url}/api.php?${new URLSearchParams(params).toString()}`, headers)).json();
-    eval(m); // eslint-disable-line no-eval
+    try {
+        eval(m); // eslint-disable-line no-eval
+    }
+    catch (e) {
+        console.log(m);
+        throw e;
+    }
     if (!mwConfig) {
         throw new RangeError('Extension:CodeMirror is not installed!');
     }

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import type { Config, ConfigData, LintError, LintConfig, LintConfiguration, TokenTypes, Parser as ParserBase, Stage } from './base';
+import { LintConfiguration } from './lib/lintConfig';
+import type { Config, ConfigData, LintError, LintConfig, TokenTypes, Parser as ParserBase, Stage } from './base';
 import type { Title, TitleOptions } from './lib/title';
 import type { LanguageService, QuickFixData } from './lib/lsp';
 import type { Token } from './internal';

package/dist/index.js

@@ -27,7 +27,7 @@ const rootRequire = (file, dir) => require(path_1.default.isAbsolute(file)
 /* NOT FOR BROWSER ONLY END */
 let viewOnly = true;
 let lintConfig = (() => {
-    LINT: return (0, lintConfig_1.getLintConfig)(); // eslint-disable-line no-unused-labels
+    LINT: return new lintConfig_1.LintConfiguration(); // eslint-disable-line no-unused-labels
 })(), i18n;
 const Parser = {
     config: 'default',
@@ -54,7 +54,7 @@ const Parser = {
         LINT: return lintConfig; // eslint-disable-line no-unused-labels
     },
     set lintConfig(config) {
-        LINT: lintConfig = (0, lintConfig_1.getLintConfig)(config); // eslint-disable-line no-unused-labels
+        LINT: lintConfig = new lintConfig_1.LintConfiguration(config); // eslint-disable-line no-unused-labels
     },
     /** @implements */
     get viewOnly() {
@@ -68,7 +68,6 @@ const Parser = {
     },
     /* NOT FOR BROWSER ONLY */
     configPaths: [],
-    lintCSS: true,
     /* NOT FOR BROWSER ONLY END */
     /** @implements */
     getConfig(config) {

package/dist/lib/lintConfig.d.ts

@@ -1,13 +1,24 @@
-import type { LintError, LintConfig, LintConfiguration as LintConfigurationBase } from '../base';
+import type { LintError, LintRuleConfig, LintRuleConfiguration as LintRuleConfigurationBase, LintConfig, LintConfiguration as LintConfigurationBase } from '../base';
+interface LintRuleConfiguration extends LintRuleConfigurationBase {
+}
+/** 语法规则设置 */
+declare class LintRuleConfiguration implements LintRuleConfigurationBase {
+    /** @param config 语法规则设置 */
+    constructor(config?: LintRuleConfig);
+    /** @implements */
+    getSeverity(rule: LintError.Rule, key?: string): LintError.Severity | false;
+}
+export interface LintConfiguration extends LintConfigurationBase {
+}
 /** 语法检查设置 */
 export declare class LintConfiguration implements LintConfigurationBase {
+    #private;
+    /** @implements */
+    get rules(): LintRuleConfiguration;
+    set rules(config: LintRuleConfig | undefined);
     /** @param config 语法检查设置 */
     constructor(config?: LintConfig);
     /** @implements */
-    getSeverity(this: LintConfigurationBase, rule: LintError.Rule, key?: string): LintError.Severity | false;
+    getSeverity(rule: LintError.Rule, key?: string): LintError.Severity | false;
 }
-/**
- * 获取语法检查设置
- * @param config 语法检查设置
- */
-export declare const getLintConfig: (config?: LintConfig) => LintConfiguration;
+export {};

package/dist/lib/lintConfig.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLintConfig = exports.LintConfiguration = void 0;
+exports.LintConfiguration = void 0;
 const base_1 = require("../base");
 const severities = new Set([0, 1, 2]), dict = new Map([
     [0, false],
     [1, 'warning'],
     [2, 'error'],
 ]);
-const defaultLintConfig = {
+const defaultLintRuleConfig = {
     'bold-header': [
         1,
         {
@@ -211,6 +211,13 @@ const defaultLintConfig = {
         },
     ],
 };
+Object.freeze(defaultLintRuleConfig);
+const defaultLintConfig = {
+    configurationComment: 'lint',
+    ignoreDisables: false,
+    fix: true,
+    computeEditInfo: true,
+};
 Object.freeze(defaultLintConfig);
 /**
  * 验证错误级别是否符合规范
@@ -235,17 +242,20 @@ const set = (obj, key, value) => {
     if (!base_1.rules.includes(key)) {
         throw new RangeError(`Unknown lint rule: ${key}`);
     }
+    else if (value === undefined) {
+        return false;
+    }
     else if (validateConfigValue(value)) {
         obj[key] = value;
         return true;
     }
     throw new RangeError(`Invalid lint config for ${key}: ${JSON.stringify(value)}`);
 };
-/** 语法检查设置 */
-class LintConfiguration {
-    /** @param config 语法检查设置 */
+/** 语法规则设置 */
+class LintRuleConfiguration {
+    /** @param config 语法规则设置 */
     constructor(config) {
-        Object.assign(this, structuredClone(defaultLintConfig));
+        Object.assign(this, structuredClone(defaultLintRuleConfig));
         if (!config) {
             return;
         }
@@ -262,10 +272,43 @@ class LintConfiguration {
         return key ? dict.get(value[1][key]) ?? dict.get(value[0]) : dict.get(value[0]);
     }
 }
+/** 语法检查设置 */
+class LintConfiguration {
+    #rules;
+    /** @implements */
+    get rules() {
+        return this.#rules;
+    }
+    set rules(config) {
+        this.#rules = new Proxy(new LintRuleConfiguration(config), {
+            set,
+            /** @ignore */
+            deleteProperty() {
+                return false;
+            },
+        });
+    }
+    /** @param config 语法检查设置 */
+    constructor(config) {
+        Object.assign(this, defaultLintConfig);
+        if (config
+            && !('rules' in config)
+            && Object.keys(config).some(key => base_1.rules.includes(key))) {
+            this.rules = config;
+        }
+        else {
+            const { rules: ruleConfig, ...other } = (config ?? {});
+            this.rules = ruleConfig;
+            for (const [key, value] of Object.entries(other)) {
+                if (value !== undefined && Object.prototype.hasOwnProperty.call(defaultLintConfig, key)) {
+                    this[key] = value;
+                }
+            }
+        }
+    }
+    /** @implements */
+    getSeverity(rule, key) {
+        return this.#rules.getSeverity(rule, key);
+    }
+}
 exports.LintConfiguration = LintConfiguration;
-/**
- * 获取语法检查设置
- * @param config 语法检查设置
- */
-const getLintConfig = (config) => new Proxy(new LintConfiguration(config), { set });
-exports.getLintConfig = getLintConfig;