wikiparser-node 1.0.2-b → 1.0.3

package/README.en.md

@@ -0,0 +1,57 @@
+[![npm version](https://badge.fury.io/js/wikiparser-node.svg)](https://www.npmjs.com/package/wikiparser-node)
+[![CodeQL](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/codeql.yml/badge.svg)](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/codeql.yml)
+[![CI](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/node.js.yml/badge.svg)](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/node.js.yml)
+
+# Other Languages
+
+- [简体中文](./README.md)
+
+# Introduction
+
+wikiparser-node is an offline [Wikitext](https://www.mediawiki.org/wiki/Wikitext) parser developed by Bhsd for the [Node.js](https://nodejs.org/) environment. It can parse almost all wiki syntax and generate an [Abstract Syntax Tree (AST)](https://en.wikipedia.org/wiki/Abstract_syntax_tree). It also allows for easy querying and modification of the AST, and returns the modified wikitext.
+
+# Other Versions
+
+## Mini (also known as [wikilint](https://www.npmjs.com/package/wikilint))
+
+This version provides a [CLI](https://en.wikipedia.org/wiki/Command-line_interface), but only retains the parsing functionality and linting functionality. The parsed AST cannot be modified. It is used in the [eslint-plugin-wikitext](https://www.npmjs.com/package/eslint-plugin-wikitext) plugin.
+
+## Browser
+
+A browser-compatible version, which can be used for code highlighting or as a linting plugin in conjunction with the [CodeMirror5](https://codemirror.net/5/) editor. ([Usage example](https://bhsd-harry.github.io/wikiparser-node))
+
+# Installation
+
+## Node.js
+
+Please install the corresponding version as needed (`wikiparser-node` or `wikilint`), for example:
+
+```sh
+npm i wikiparser-node
+```
+
+or
+
+```sh
+npm i wikilint
+```
+
+## Browser
+
+You can download the code via CDN, for example:
+
+```html
+<script src="//cdn.jsdelivr.net/npm/wikiparser-node@browser/bundle/bundle.min.js"></script>
+```
+
+or
+
+```html
+<script src="//unpkg.com/wikiparser-node@browser/bundle/bundle.min.js"></script>
+```
+
+For more browser extensions, please refer to the corresponding [documentation](https://github.com/bhsd-harry/wikiparser-node/wiki/Browser.en).
+
+# Usage
+
+Please refer to the [Wiki](https://github.com/bhsd-harry/wikiparser-node/wiki/Home.en).

package/README.md

@@ -2,6 +2,10 @@
 [![CodeQL](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/codeql.yml/badge.svg)](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/codeql.yml)
 [![CI](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/node.js.yml/badge.svg)](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/node.js.yml)
 
+# Other Languages
+
+- [English](./README.en.md)
+
 # 简介
 
 wikiparser-node 是一款由 Bhsd 开发的基于 [Node.js](https://nodejs.org/) 环境的离线[维基文本](https://www.mediawiki.org/wiki/Wikitext)语法解析器，可以解析几乎全部的维基语法并生成[语法树](https://en.wikipedia.org/wiki/Abstract_syntax_tree)，还可以很方便地对语法树进行查询和修改，最后返回修改后的维基文本。
@@ -46,7 +50,7 @@ npm i wikilint
 <script src="//unpkg.com/wikiparser-node@browser/bundle/bundle.min.js"></script>
 ```
 
-更多浏览器端可用的插件请查阅对应文档。
+更多浏览器端可用的插件请查阅对应[文档](https://github.com/bhsd-harry/wikiparser-node/wiki/Browser)。
 
 # 使用方法
 

package/config/.schema.json

@@ -0,0 +1,160 @@
+{
+	"type": "object",
+	"properties": {
+		"ext": {
+			"description": "extension tags",
+			"type": "array",
+			"items": {
+				"type": "string",
+				"pattern": "^[a-z\\d_]+$"
+			}
+		},
+		"html": {
+			"description": "valid HTML tags",
+			"type": "array",
+			"items": {
+				"type": "array",
+				"items": {
+					"type": "string",
+					"pattern": "^[a-z\\d]+$"
+				}
+			},
+			"minItems": 3,
+			"maxItems": 3
+		},
+		"namespaces": {
+			"description": "formatted namespaces",
+			"type": "object",
+			"patternProperties": {
+				"^-?\\d+$": {
+					"type": "string"
+				}
+			},
+			"required": [
+				"6",
+				"10"
+			],
+			"additionalProperties": false
+		},
+		"nsid": {
+			"description": "namespace IDs",
+			"type": "object",
+			"additionalProperties": {
+				"type": "integer"
+			}
+		},
+		"parserFunction": {
+			"type": "array",
+			"items": [
+				{
+					"description": "case-insensitive parser functions",
+					"type": "object",
+					"additionalProperties": {
+						"type": "string"
+					}
+				},
+				{
+					"description": "case-sensitive parser functions",
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				},
+				{
+					"description": "msg and raw",
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				},
+				{
+					"description": "subst and safesubst",
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				}
+			],
+			"minItems": 4,
+			"maxItems": 4
+		},
+		"doubleUnderscore": {
+			"description": "behavior switches",
+			"type": "array",
+			"items": {
+				"type": "array",
+				"items": {
+					"type": "string"
+				}
+			},
+			"minItems": 2,
+			"maxItems": 2
+		},
+		"protocol": {
+			"description": "external link protocols",
+			"type": "string",
+			"pattern": "^[a-z:/]+(?:\\|[a-z:/]+)*$"
+		},
+		"interwiki": {
+			"type": "array",
+			"items": {
+				"type": "string"
+			}
+		},
+		"img": {
+			"description": "image-related magic words",
+			"type": "object",
+			"additionalProperties": {
+				"type": "string",
+				"pattern": "^[-a-z]+$"
+			}
+		},
+		"variants": {
+			"description": "variants for language conversion",
+			"type": "array",
+			"items": {
+				"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": [
+		"ext",
+		"html",
+		"namespaces",
+		"nsid",
+		"parserFunction",
+		"doubleUnderscore",
+		"protocol",
+		"interwiki",
+		"img",
+		"variants"
+	],
+	"additionalProperties": false
+}

package/config/llwiki.json

@@ -518,7 +518,41 @@
 		]
 	],
 	"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": [],
+	"interwiki": [
+		"arxiv",
+		"aswiki",
+		"cache",
+		"cmoegirl",
+		"commons",
+		"doi",
+		"google",
+		"googlegroups",
+		"gsnews",
+		"imdb",
+		"jawiki",
+		"komica",
+		"mediawikiwiki",
+		"metawikimedia",
+		"moegirl",
+		"mw",
+		"sifaswiki",
+		"sifwiki",
+		"wikia",
+		"wikibooks",
+		"wikidata",
+		"wikimedia",
+		"wikinews",
+		"wikiinfo",
+		"wikipedia",
+		"wikiquote",
+		"wikisource",
+		"wikispecies",
+		"wikiversity",
+		"wikivoyage",
+		"wikt",
+		"wiktionary",
+		"zhwiki"
+	],
 	"img": {
 		"thumbnail": "thumbnail",
 		"thumb": "thumbnail",

package/config/moegirl.json

@@ -611,7 +611,50 @@
 		]
 	],
 	"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": [],
+	"interwiki": [
+		"commons",
+		"mediawikiwiki",
+		"metawikimedia",
+		"mw",
+		"wikibooks",
+		"wikidata",
+		"wikimedia",
+		"wikinews",
+		"wikipedia",
+		"wikiquote",
+		"wikisource",
+		"wikispecies",
+		"wikiversity",
+		"wikivoyage",
+		"wikt",
+		"wiktionary",
+		"cc",
+		"cm",
+		"en",
+		"enmoe",
+		"enwp",
+		"fandom",
+		"ghia",
+		"huiji",
+		"ja",
+		"jamoe",
+		"jawp",
+		"library",
+		"meta",
+		"phab",
+		"pmid",
+		"shoutwiki",
+		"translatewiki",
+		"zh",
+		"zhmoe",
+		"zhmoegirl",
+		"zhtest",
+		"zhwp",
+		"文库",
+		"萌娘共享",
+		"萌娘文库",
+		"萌百"
+	],
 	"img": {
 		"thumbnail": "thumbnail",
 		"thumb": "thumbnail",