wikilint 1.1.0 → 2.0.0-beta.1

package/README.md

@@ -17,6 +17,7 @@ npx wikilint --config zhwiki --include *.wiki
 | `-c`, `--config` \<path or preset config\> | Choose parser's configuration | `default` |
 | `-h`, `--help` | Print available options | |
 | `-i`, `--include` | Parse for inclusion | no inclusion |
+| `-l`, `--lang` | Choose i18n language | English
 | `-q`, `--quiet` | Report errors only | errors and warnings |
-| `-s`, `--strict` | Exit `1` when there is an error or warning<br>Override `-q` or `--quiet` | Exit `1` only where there is an error |
+| `-s`, `--strict` | Exit when there is an error or warning<br>Override `-q` or `--quiet` | Exit `1` only where there is an error |
 | `-v`, `--version` | Print package version | |

package/config/.schema.json

@@ -95,6 +95,12 @@
 			"type": "string",
 			"pattern": "^[a-z:/]+(?:\\|[a-z:/]+)*$"
 		},
+		"interwiki": {
+			"type": "array",
+			"items": {
+				"type": "string"
+			}
+		},
 		"img": {
 			"description": "image-related magic words",
 			"type": "object",
@@ -110,6 +116,32 @@
 				"type": "string",
 				"pattern": "^[-a-z]+$"
 			}
+		},
+		"conversionTable": {
+			"description": "table of unidirectional conversions",
+			"type": "array",
+			"items": {
+				"type": "array",
+				"items": {
+					"type": "string",
+					"pattern": "^[^ <>[\\]{}|]+$"
+				},
+				"minItems": 2,
+				"maxItems": 2
+			}
+		},
+		"redirects": {
+			"description": "table of redirects",
+			"type": "array",
+			"items": {
+				"type": "array",
+				"items": {
+					"type": "string",
+					"pattern": "^[^ <>[\\]{}|]+$"
+				},
+				"minItems": 2,
+				"maxItems": 2
+			}
 		}
 	},
 	"required": [
@@ -120,6 +152,7 @@
 		"parserFunction",
 		"doubleUnderscore",
 		"protocol",
+		"interwiki",
 		"img",
 		"variants"
 	],

package/config/default.json

@@ -754,6 +754,7 @@
 		]
 	],
 	"protocol": "bitcoin:|ftp://|ftps://|geo:|git://|gopher://|http://|https://|irc://|ircs://|magnet:|mailto:|mms://|news:|nntp://|redis://|sftp://|sip:|sips:|sms:|ssh://|svn://|tel:|telnet://|urn:|worldwind://|xmpp:",
+	"interwiki": [],
 	"img": {
 		"thumbnail": "thumbnail",
 		"thumb": "thumbnail",

package/config/llwiki.json

@@ -518,6 +518,7 @@
 		]
 	],
 	"protocol": "bitcoin:|ftp://|ftps://|geo:|git://|gopher://|http://|https://|irc://|ircs://|magnet:|mailto:|mms://|news:|nntp://|redis://|sftp://|sip:|sips:|sms:|ssh://|svn://|tel:|telnet://|urn:|worldwind://|xmpp:",
+	"interwiki": [],
 	"img": {
 		"thumbnail": "thumbnail",
 		"thumb": "thumbnail",

package/config/minimum.json

@@ -0,0 +1,136 @@
+{
+	"ext": [],
+	"html": [
+		[
+			"b",
+			"bdi",
+			"del",
+			"i",
+			"ins",
+			"u",
+			"font",
+			"big",
+			"small",
+			"sub",
+			"sup",
+			"h1",
+			"h2",
+			"h3",
+			"h4",
+			"h5",
+			"h6",
+			"cite",
+			"code",
+			"em",
+			"s",
+			"strike",
+			"strong",
+			"tt",
+			"var",
+			"div",
+			"center",
+			"blockquote",
+			"ol",
+			"ul",
+			"dl",
+			"table",
+			"caption",
+			"pre",
+			"ruby",
+			"rb",
+			"rp",
+			"rt",
+			"rtc",
+			"p",
+			"span",
+			"abbr",
+			"dfn",
+			"kbd",
+			"samp",
+			"data",
+			"time",
+			"mark",
+			"tr",
+			"td",
+			"th",
+			"q",
+			"bdo"
+		],
+		[
+			"li",
+			"dt",
+			"dd"
+		],
+		[
+			"br",
+			"wbr",
+			"hr",
+			"meta",
+			"link",
+			"img"
+		]
+	],
+	"namespaces": {
+		"6": "File",
+		"10": "Template"
+	},
+	"nsid": {},
+	"parserFunction": [
+		{
+			"#language": "language",
+			"#special": "special",
+			"#speciale": "speciale",
+			"#tag": "tag",
+			"#formatdate": "formatdate",
+			"#invoke": "invoke",
+			"#while": "while",
+			"#dowhile": "dowhile",
+			"#loop": "loop",
+			"#forargs": "forargs",
+			"#fornumargs": "fornumargs",
+			"#if": "if",
+			"#ifeq": "ifeq",
+			"#switch": "switch",
+			"#ifexist": "ifexist",
+			"#ifexpr": "ifexpr",
+			"#iferror": "iferror",
+			"#time": "time",
+			"#timel": "timel",
+			"#expr": "expr",
+			"#rel2abs": "rel2abs",
+			"#titleparts": "titleparts",
+			"#categorytree": "categorytree",
+			"#urldecode": "urldecode",
+			"#choose": "choose",
+			"#var": "var",
+			"#varexists": "varexists",
+			"#var_final": "var_final",
+			"#vardefine": "vardefine",
+			"#vardefineecho": "vardefineecho",
+			"#widget": "widget",
+			"#regex": "regex",
+			"#related": "related",
+			"#cscore": "cscore"
+		},
+		[],
+		[
+			"msg",
+			"原始",
+			"raw"
+		],
+		[
+			"替代",
+			"subst",
+			"安全替代",
+			"safesubst"
+		]
+	],
+	"doubleUnderscore": [
+		[],
+		[]
+	],
+	"protocol": "bitcoin:|ftp://|ftps://|geo:|git://|gopher://|http://|https://|irc://|ircs://|magnet:|mailto:|mms://|news:|nntp://|redis://|sftp://|sip:|sips:|sms:|ssh://|svn://|tel:|telnet://|urn:|worldwind://|xmpp:",
+	"interwiki": [],
+	"img": {},
+	"variants": []
+}

package/config/moegirl.json

@@ -611,6 +611,7 @@
 		]
 	],
 	"protocol": "bitcoin:|ftp://|ftps://|geo:|git://|gopher://|http://|https://|irc://|ircs://|magnet:|mailto:|mms://|news:|nntp://|redis://|sftp://|sip:|sips:|sms:|ssh://|svn://|tel:|telnet://|urn:|worldwind://|xmpp:",
+	"interwiki": [],
 	"img": {
 		"thumbnail": "thumbnail",
 		"thumb": "thumbnail",

package/config/zhwiki.json

@@ -708,6 +708,7 @@
 		]
 	],
 	"protocol": "bitcoin:|ftp://|ftps://|geo:|git://|gopher://|http://|https://|irc://|ircs://|magnet:|mailto:|mms://|news:|nntp://|redis://|sftp://|sip:|sips:|sms:|ssh://|svn://|tel:|telnet://|urn:|worldwind://|xmpp:",
+	"interwiki": [],
 	"img": {
 		"thumbnail": "thumbnail",
 		"thumb": "thumbnail",

package/dist/bin/cli.js

@@ -0,0 +1,133 @@
+"use strict";
+/* eslint-disable n/no-process-exit */
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = require("fs");
+const path_1 = require("path");
+const Parser = require("../index");
+const man = `
+Available options:
+-c, --config <path or preset config>    Choose parser's configuration
+-h, --help                              Print available options
+-i, --include                           Parse for inclusion
+-l, --lang                              Choose i18n language
+-q, --quiet                             Report errors only
+-s, --strict                            Exit when there is an error or warning
+                                        Override -q or --quiet
+-v, --version                           Print package version
+`, preset = new Set(['default', 'zhwiki', 'moegirl', 'llwiki']), { argv } = process, files = [];
+let include = false, quiet = false, strict = false, exit = false, nErr = 0, nWarn = 0, option, config, lang;
+/**
+ * throw if `-c` or `--config` option is incorrect
+ * @throws `Error` unrecognized config input
+ */
+const throwOnConfig = () => {
+    if (!config || config.startsWith('-')) {
+        throw new Error('The option -c/--config must be followed by a path or a preset config');
+    }
+    else if (!config.includes('/') && !preset.has(config)) {
+        throw new Error(`Unrecognized preset config: ${config}`);
+    }
+};
+/**
+ * generate plural form if necessary
+ * @param n number of items
+ * @param word item name
+ */
+const plural = (n, word) => `${n} ${word}${n > 1 ? 's' : ''}`;
+/**
+ * color the severity
+ * @param severity problem severity
+ */
+const coloredSeverity = (severity) => `\x1B[${severity === 'error' ? 31 : 33}m${severity}\x1B[0m`.padEnd(16);
+for (let i = 2; i < argv.length; i++) {
+    option = argv[i];
+    switch (option) {
+        case '-c':
+        case '--config':
+            config = argv[++i];
+            throwOnConfig();
+            break;
+        case '-h':
+        case '--help':
+            console.log(man);
+            process.exit(0);
+            break;
+        case '-i':
+        case '--include':
+            include = true;
+            break;
+        case '-l':
+        case '--lang':
+            lang = argv[++i];
+            break;
+        case '-q':
+        case '--quiet':
+            quiet = true;
+            break;
+        case '-s':
+        case '--strict':
+            strict = true;
+            break;
+        case '-v':
+        case '--version': {
+            const { version } = require('../../package');
+            console.log(`wikilint v${version}`);
+            process.exit(0);
+            break;
+        }
+        default:
+            if (option.startsWith('--config=')) {
+                config = option.slice(9);
+                throwOnConfig();
+                break;
+            }
+            else if (option.startsWith('--lang=')) {
+                lang = option.slice(7);
+                break;
+            }
+            else if (option.startsWith('-')) {
+                throw new Error(`Unknown wikilint option: ${option}\n${man}`);
+            }
+            files.push(option);
+    }
+}
+if (files.length === 0) {
+    throw new Error('No target file is specified');
+}
+else if (config) {
+    Parser.config = config.includes('/') ? (0, path_1.resolve)(config) : `./config/${config}`;
+}
+if (lang) {
+    Parser.i18n = lang;
+}
+if (quiet && strict) {
+    quiet = false;
+    console.error('-s or --strict will override -q or --quiet\n');
+}
+for (const file of files) {
+    const wikitext = (0, fs_1.readFileSync)(file, 'utf8');
+    let problems = Parser.parse(wikitext, include).lint();
+    const errors = problems.filter(({ severity }) => severity === 'error'), { length: nLocalErr } = errors, nLocalWarn = problems.length - nLocalErr;
+    if (quiet) {
+        problems = errors;
+    }
+    else {
+        nWarn += nLocalWarn;
+    }
+    if (problems.length > 0) {
+        console.error('\x1B[4m%s\x1B[0m', (0, path_1.resolve)(file));
+        const { length: maxLineChars } = String(Math.max(...problems.map(({ startLine }) => startLine))), { length: maxColChars } = String(Math.max(...problems.map(({ startCol }) => startCol)));
+        for (const { message, severity, startLine, startCol } of problems) {
+            console.error(`  ${String(startLine).padStart(maxLineChars)}:${String(startCol).padEnd(maxColChars)}  ${coloredSeverity(severity)}  ${message}`);
+        }
+        console.error();
+    }
+    nErr += nLocalErr;
+    exit ||= Boolean(nLocalErr || strict && nLocalWarn);
+}
+if (nErr || nWarn) {
+    console.error('\x1B[1;31m%s\x1B[0m\n', `✖ ${plural(nErr + nWarn, 'problem')} (${plural(nErr, 'error')}, ${plural(nWarn, 'warning')})`);
+}
+if (exit) {
+    process.exitCode = 1;
+}

package/dist/index.d.ts

@@ -1,110 +1,51 @@
-import AstElement = require("./lib/element.js")
-import AstNode = require("./lib/node.js")
-import AstText = require("./lib/text.js")
-import Title = require("./lib/title.js")
-import ArgToken = require("./src/arg.js")
-import HiddenToken = require("./src/atom/hidden.js")
-import AtomToken = require("./src/atom/index.js")
-import AttributeToken = require("./src/attribute.js")
-import AttributesToken = require("./src/attributes.js")
-import ConverterToken = require("./src/converter.js")
-import ConverterFlagsToken = require("./src/converterFlags.js")
-import ConverterRuleToken = require("./src/converterRule.js")
-import ExtLinkToken = require("./src/extLink.js")
-import GalleryToken = require("./src/gallery.js")
-import HasNowikiToken = require("./src/hasNowiki/index.js")
-import PreToken = require("./src/hasNowiki/pre.js")
-import HeadingToken = require("./src/heading.js")
-import HtmlToken = require("./src/html.js")
-import ImageParameterToken = require("./src/imageParameter.js")
-import ImagemapToken = require("./src/imagemap.js")
-import ImagemapLinkToken = require("./src/imagemapLink.js")
-import Token = require("./src/index.js")
-import CategoryToken = require("./src/link/category.js")
-import FileToken = require("./src/link/file.js")
-import GalleryImageToken = require("./src/link/galleryImage.js")
-import LinkToken = require("./src/link/index.js")
-import MagicLinkToken = require("./src/magicLink.js")
-import ChooseToken = require("./src/nested/choose.js")
-import ComboboxToken = require("./src/nested/combobox.js")
-import NestedToken = require("./src/nested/index.js")
-import ReferencesToken = require("./src/nested/references.js")
-import CommentToken = require("./src/nowiki/comment.js")
-import DdToken = require("./src/nowiki/dd.js")
-import DoubleUnderscoreToken = require("./src/nowiki/doubleUnderscore.js")
-import HrToken = require("./src/nowiki/hr.js")
-import NowikiToken = require("./src/nowiki/index.js")
-import ListToken = require("./src/nowiki/list.js")
-import NoincludeToken = require("./src/nowiki/noinclude.js")
-import QuoteToken = require("./src/nowiki/quote.js")
-import OnlyincludeToken = require("./src/onlyinclude.js")
-import ParamTagToken = require("./src/paramTag/index.js")
-import InputboxToken = require("./src/paramTag/inputbox.js")
-import ParameterToken = require("./src/parameter.js")
-import SyntaxToken = require("./src/syntax.js")
-import TableToken = require("./src/table/index.js")
-import TdToken = require("./src/table/td.js")
-import TrToken = require("./src/table/tr.js")
-import ExtToken = require("./src/tagPair/ext.js")
-import IncludeToken = require("./src/tagPair/include.js")
-import TagPairToken = require("./src/tagPair/index.js")
-import TranscludeToken = require("./src/transclude.js")
-
+import type { Title } from './lib/title';
+import type { Token } from './internal';
+export interface Config {
+    ext: string[];
+    html: [string[], string[], string[]];
+    namespaces: Record<string, string>;
+    nsid: Record<string, number>;
+    parserFunction: [Record<string, string>, string[], string[], string[]];
+    doubleUnderscore: [string[], string[]];
+    protocol: string;
+    img: Record<string, string>;
+    variants: string[];
+    excludes?: string[];
+}
+export interface LintError {
+    message: string;
+    severity: 'error' | 'warning';
+    startIndex: number;
+    endIndex: number;
+    startLine: number;
+    startCol: number;
+    endLine: number;
+    endCol: number;
+}
+declare interface Parser {
+    /** @browser */
+    config: string | Config;
+    /** @browser */
+    i18n?: string | Record<string, string>;
+    /**
+     * 规范化页面标题
+     * @browser
+     * @param title 标题（含或不含命名空间前缀）
+     * @param defaultNs 命名空间
+     * @param include 是否嵌入
+     * @param halfParsed 是否是半解析状态
+     * @param decode 是否需要解码
+     * @param selfLink 是否允许selfLink
+     */
+    normalizeTitle(title: string, defaultNs?: number, include?: boolean, config?: Config, halfParsed?: boolean, decode?: boolean, selfLink?: boolean): Title;
+    /**
+     * 解析wikitext
+     * @browser
+     * @param include 是否嵌入
+     * @param maxStage 最大解析层级
+     */
+    parse(wikitext: string, include?: boolean, maxStage?: number, config?: Config): Token;
+}
+declare const Parser: Parser;
 export = Parser;
-declare const Parser: import('./../typings');
-
-declare namespace Parser {
-	export {
-		AstElement,
-		AstNode,
-		AstText,
-		Title,
-		ArgToken,
-		HiddenToken,
-		AtomToken,
-		AttributeToken,
-		AttributesToken,
-		ConverterToken,
-		ConverterFlagsToken,
-		ConverterRuleToken,
-		ExtLinkToken,
-		GalleryToken,
-		HasNowikiToken,
-		PreToken,
-		HeadingToken,
-		HtmlToken,
-		ImageParameterToken,
-		ImagemapToken,
-		ImagemapLinkToken,
-		Token,
-		CategoryToken,
-		FileToken,
-		GalleryImageToken,
-		LinkToken,
-		MagicLinkToken,
-		ChooseToken,
-		ComboboxToken,
-		NestedToken,
-		ReferencesToken,
-		CommentToken,
-		DdToken,
-		DoubleUnderscoreToken,
-		HrToken,
-		NowikiToken,
-		ListToken,
-		NoincludeToken,
-		QuoteToken,
-		OnlyincludeToken,
-		ParamTagToken,
-		InputboxToken,
-		ParameterToken,
-		SyntaxToken,
-		TableToken,
-		TdToken,
-		TrToken,
-		ExtToken,
-		IncludeToken,
-		TagPairToken,
-		TranscludeToken,
-	}
-}
+export type * from './internal';

package/dist/index.js

@@ -0,0 +1,80 @@
+"use strict";
+/* eslint n/exports-style: 0 */
+const fs = require("fs");
+const path = require("path");
+/**
+ * 从根路径require
+ * @param file 文件名
+ * @param dir 子路径
+ */
+const rootRequire = (file, dir) => require(file.startsWith('/') ? file : `../${file.includes('/') ? '' : dir}${file}`);
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+const Parser = {
+    config: 'default',
+    MAX_STAGE: 11,
+    /** @implements */
+    getConfig() {
+        if (typeof this.config === 'string') {
+            this.config = rootRequire(this.config, 'config/');
+            return this.getConfig();
+        }
+        return { ...this.config, excludes: [] };
+    },
+    /** @implements */
+    msg(msg, arg = '') {
+        if (typeof this.i18n === 'string') {
+            this.i18n = rootRequire(this.i18n, 'i18n/');
+            return this.msg(msg, arg);
+        }
+        return (this.i18n?.[msg] ?? msg).replace('$1', arg);
+    },
+    /** @implements */
+    normalizeTitle(title, defaultNs = 0, include = false, config = Parser.getConfig(), halfParsed = false, decode = false, selfLink = false) {
+        const { Title } = require('./lib/title');
+        if (halfParsed) {
+            return new Title(title, defaultNs, config, decode, selfLink);
+        }
+        const { Token } = require('./src');
+        const token = this.run(() => new Token(title, config).parseOnce(0, include).parseOnce()), titleObj = new Title(String(token), defaultNs, config, decode, selfLink);
+        return titleObj;
+    },
+    /** @implements */
+    parse(wikitext, include, maxStage = Parser.MAX_STAGE, config = Parser.getConfig()) {
+        const { Token } = require('./src');
+        let token;
+        this.run(() => {
+            token = new Token(wikitext.replace(/[\0\x7F]/gu, ''), config);
+            try {
+                token.parse(maxStage, include);
+            }
+            catch (e) {
+                if (e instanceof Error) {
+                    const file = path.join(__dirname, '..', 'errors', new Date().toISOString()), stage = token.getAttribute('stage');
+                    fs.writeFileSync(file, stage === this.MAX_STAGE ? wikitext : String(token));
+                    fs.writeFileSync(`${file}.err`, e.stack);
+                    fs.writeFileSync(`${file}.json`, JSON.stringify({
+                        stage, include: token.getAttribute('include'), config: this.config,
+                    }, null, '\t'));
+                }
+                throw e;
+            }
+        });
+        return token;
+    },
+    /** @implements */
+    run(callback) {
+        const result = callback();
+        return result;
+    },
+};
+const def = {}, immutable = new Set(['MAX_STAGE']), enumerable = new Set(['config', 'normalizeTitle', 'parse']);
+for (const key in Parser) {
+    if (immutable.has(key)) {
+        def[key] = { enumerable: false, writable: false };
+    }
+    else if (!enumerable.has(key)) {
+        def[key] = { enumerable: false };
+    }
+}
+Object.defineProperties(Parser, def);
+module.exports = Parser;

package/dist/internal.d.ts

@@ -0,0 +1,44 @@
+export type { AstNodes, } from './lib/node';
+export type * from './lib/text';
+export type * from './src';
+export type * from './src/onlyinclude';
+export type * from './src/nowiki/noinclude';
+export type * from './src/tagPair/include';
+export type * from './src/nowiki/comment';
+export type * from './src/atom';
+export type { AttributeToken } from './src/attribute';
+export type * from './src/attributes';
+export type * from './src/tagPair/ext';
+export type * from './src/hidden';
+export type * from './src/arg';
+export type * from './src/syntax';
+export type * from './src/parameter';
+export type * from './src/transclude';
+export type * from './src/heading';
+export type * from './src/html';
+export type { TdToken } from './src/table/td';
+export type * from './src/table/tr';
+export type * from './src/table';
+export type * from './src/nowiki/hr';
+export type * from './src/nowiki/doubleUnderscore';
+export type * from './src/link';
+export type * from './src/link/category';
+export type * from './src/imageParameter';
+export type * from './src/link/file';
+export type * from './src/link/galleryImage';
+export type * from './src/nowiki/quote';
+export type * from './src/magicLink';
+export type * from './src/extLink';
+export type * from './src/nowiki/dd';
+export type * from './src/nowiki/list';
+export type * from './src/converterFlags';
+export type * from './src/converterRule';
+export type * from './src/converter';
+export type * from './src/nowiki';
+export type * from './src/pre';
+export type * from './src/paramTag';
+export type * from './src/paramTag/inputbox';
+export type * from './src/nested';
+export type * from './src/gallery';
+export type * from './src/imagemapLink';
+export type * from './src/imagemap';