lint-wiki-dumps

0.9.1 verified Fri May 01 auth: no javascript

lint-wiki-dumps is a Node.js CLI tool (v0.9.1) for linting Wikitext articles from Wikipedia dumps by integrating WikiLint and optionally vscode-css-languageservice. It automates downloading the latest dump, parsing articles, and generating lint reports in both JSON and HTML formats. Unlike standalone WikiLint, this package handles dump retrieval and batch processing. The tool requires curl and Node.js ^20.19.2 || ^22.13.0. It is maintained by bhsd-harry.

Common errors

error Error: curl is not installed. Please install curl to use this tool. ↓

cause Missing system dependency curl.

fix

Install curl via your package manager (e.g., sudo apt install curl).

error Error: Failed to download dump for language 'xx'. Check internet connection and language code. ↓

cause Invalid language code or network issue.

fix

Use a valid Wikipedia language code (e.g., en, zh, de). Ensure internet connectivity.

Warnings

gotcha Requires curl installed on the system. Without curl, the tool will fail to download dumps. ↓

fix Install curl (e.g., apt install curl or brew install curl).

deprecated Node.js engine requirement: ^20.19.2 || ^22.13.0. Older versions like 18 are not supported. ↓

fix Use Node.js 20.19.2+ or 22.13.0+.

gotcha The tool downloads large Wikipedia dumps (hundreds of MB to GB). Ensure sufficient disk space and network bandwidth. ↓

fix Check available disk space before running.

gotcha The optional CSS linter (vscode-css-languageservice) is not automatically installed; must be added manually. ↓

fix Run npm install vscode-css-languageservice alongside lint-wiki-dumps.

Install

npm install lint-wiki-dumps

yarn add lint-wiki-dumps

pnpm add lint-wiki-dumps

Imports

main binary
wrong
```
npm i -g lint-wiki-dumps && lint-wiki-dumps
```
correct
```
npx lint-wiki-dumps <language> <downloadPath> [htmlPath] [jsonPath]
```
The package exposes a CLI binary; no programmatic API is exported. Use npx or install globally.

scan.sh

wrong

sh scan.sh ...

correct

bash scan.sh <language> <downloadPath> [htmlPath] [jsonPath]

The shell script is intended to be run with bash, not sh.

Quickstart

Installs the package and runs a lint on Chinese Wikipedia, generating HTML and JSON reports.

# Install the tool (requires curl)
npm install lint-wiki-dumps

# Run linting on Chinese Wikipedia (zh) with curl
# The tool will download the latest dump and lint articles
npx lint-wiki-dumps zh ~/Downloads/wikipedia-dumps ~/reports/zh-report.html ~/reports/zh-report.json

# Or use bash script directly
bash node_modules/lint-wiki-dumps/scan.sh zh ~/Downloads/wikipedia-dumps

# Optionally install CSS linter
npm install vscode-css-languageservice