WikiParser-Node

Other Languages

• 简体中文

Introduction

WikiParser-Node is an offline Wikitext parser developed by Bhsd for the Node.js environment. It can parse almost all wiki syntax and generate an Abstract Syntax Tree (AST) (Try it online). It also allows for easy querying and modification of the AST, and returns the modified Wikitext.

Although WikiParser-Node is not primarily designed to convert Wikitext to HTML, it provides pragmatic HTML rendering for many situations. Here is a list of example HTML pages from MediaWiki.org rendered using this package.

WikiParser-Node has been extensively tested against the official MediaWiki PHP parser tests with ~3,000 test cases, covering various edge cases and peculiarities of Wikitext. These tests are available here.

Why WikiParser-Node

• Round-trip editing for bots and automation: parse Wikitext into an AST, query and modify nodes, then write back valid Wikitext.
• LSP and linting ready for Node.js tooling: powers WikiLint and Wikitext LSP.
• Browser/editor integration: works with CodeMirror, Monaco, and MediaWiki's official CodeMirror extension.
• Large-scale usage evidence: full-dump parsing and linting on English Wikipedia scale is practical on consumer hardware.
• Transparent quality signals: CI, CodeQL, public parser-test results, and coverage are all visible in this repository.

Used by

Other Versions

WikiLint

This version provides a CLI, but only retains the parsing and linting functionality. At the cost of losing AST modification capabilities, it executes 2.4x faster. It powers the Wikitext LSP, which provides multiple language services for editors such as VS Code, Sublime Text, and Helix.

A list of available linting rules can be found here.

Browser-compatible

A browser-compatible version, which can be used for code highlighting or as a LSP plugin in conjunction with editors such as CodeMirror and Monaco (Usage example). It has been integrated into the MediaWiki official CodeMirror extension since Release 1.45.

WikiParser-Template

A lightweight version that only supports parsing and manipulation of templates. This version is designed for use cases where only template processing is needed, such as certain types of bots or web tools (e.g., GANReviewTool) that focus on template manipulation.

Installation

Node.js

Please install the corresponding version as needed (WikiParser-Node or WikiLint), for example:

npm i wikiparser-node

or

npm i wikilint

Optional dependencies

You can install any of the following optional packages to enable advanced features:

| Package | Purpose | | :-: | --- | | mathoid-texvcjs | Diagnostics and HTML conversion support for <math> and <chem> extension tags | | stylelint | Diagnostics for style attributes | | vscode-css-languageservice | CSS language support for style attributes | | vscode-html-languageservice | Language support for HTML tags | | vscode-json-languageservice | JSON language support for <templatedata>, <mapframe> and <maplink> tags | | ajv + ajv-errors | HTML conversion support for <templatedata> extension tags | | katex | HTML conversion support for <math> and <chem> extension tags | | prismjs + prism-wiki | Syntax highlighting of <syntaxhighlight> extension tags |

# Full LanguageService features for `Parser.createLanguageService()`
npm i mathoid-texvcjs stylelint vscode-css-languageservice vscode-html-languageservice vscode-json-languageservice

# Full HTML conversion support for `Parser.toHtml()`
npm i ajv ajv-errors katex mathoid-texvcjs prismjs prism-wiki

Browser

You can download the code via CDN, for example:

<script src="//cdn.jsdelivr.net/npm/wikiparser-node"></script>

or

<script src="//unpkg.com/wikiparser-node/bundle/bundle-lsp.min.js"></script>

For more browser extensions, please refer to the corresponding documentation.

Usage

CLI usage

For MediaWiki sites with the CodeMirror extension installed, such as different language editions of Wikipedia and other Wikimedia Foundation-hosted sites, you can use the following command to obtain the parser configuration:

npx getParserConfig <site> <script path> [user] [force]
# For example:
npx getParserConfig frwiki https://fr.wikipedia.org/w [email protected]

The generated configuration file will be saved in the config directory. You can then use the site name for Parser.config.

// For example:
Parser.config = "frwiki";

API usage

Please refer to the Wiki. In particular, there are some usage examples that demonstrate how to use this package to complete various tasks.

Round-trip editing quickstart (TypeScript)

import Parser from "wikiparser-node";
import type {TranscludeToken} from "wikiparser-node";

Parser.config = "enwiki";
const root = Parser.parse("{{Infobox|name=Old}}\nText"),
	template = root.querySelector<TranscludeToken>("template#Template:Infobox");
template?.setValue("name", "New");
const wikitext = String(root);
assert.strictEqual(wikitext, "{{Infobox|name=New}}\nText");

Performance

A full database dump (*.xml.bz2) scan of English Wikipedia's ~19 million articles (parsing and linting) on a personal MacBook Air takes about 5 hours.

Performance comparison between WikiParser-Node and WikiLint

| Version | Average time per article | Max time per article | | :-: | :-: | :-: | | WikiParser-Node | 3.6ms | 2.8s | | WikiLint | 1.5ms | 0.75s |

Best fit

• MediaWiki bot workflows that require robust AST manipulation and round-trip-safe edits.
• Node.js pipelines for linting and refactoring Wikitext.
• LSP-based language tooling.
• Browser-side editing helpers, and gadgets/user scripts that require Wikitext parsing.

Known issues

The following limitations are documented for transparency.

Parser

1. Memory leaks may occur in rare cases.
2. Invalid page names with unicode characters are treated like valid ones (Example).
3. Preformatted text with a leading space is only processed by Token#toHtml.

HTML conversion

Extension

1. Many extensions are not supported.
2. Sub-referencing is not supported.
3. Special cases involving templates inside the link parameter of a gallery image (Example).

Transclusion

1. Some parser functions are not supported, notably #formatdate, #time and #invoke.
2. New lines in {{localurl:}} are not handled correctly (Example).

Heading

1. RTL support in the table of contents (TOC) (Example).

HTML tag

1. Style sanitization is sometimes different (Example).

Table

1. <caption> elements are wrapped in <tbody> elements (Example).
2. Unclosed HTML tags in the table fostered content (Example).
3. <tr> elements should not be fostered (Example).
4. Link text containing !! in a table header (Example).

Link

1. Link trail is not supported (Example).
2. Block elements inside a link should break it into multiple links (Example).
3. Invalid or missing images (Examples 1, 2).
4. Link starting with ../ on a subpage (Example).
5. Duplicate file namespace prefixes should be invalid (Example).
6. File redirects (Example).
7. Figure caption should not be nested inside inline elements (Example).
8. Seemingly broken file link syntax in a table (Example).

External link

1. No percent-encoding in displayed free external links (Example).

Block element

1. Incomplete <p> wrapping when there are block elements (e.g., <pre>, <div> or even closing tags).
2. Mixed lists (Example).

Language conversion

1. Automatic language conversion is not supported.
2. Support for manual language conversion is minimal (Example).
3. Language conversion should prevent <p> wrapping (Examples 1, 2).

Miscellaneous

1. Illegal HTML entities (Example).