wikilint
TypeScript icon, indicating that this package has built-in type declarations

2.21.1 • Public • Published

npm version CodeQL CI Codacy Badge Istanbul coverage

WikiLint

This is a minimal version of WikiParser-Node. The WikiParser Language Server VSCode extension is written based on this package.

You can also directly lint Wikitext articles in the command line using this package:

npx wikilint --config zhwiki --include --lang zh-hans *.wiki

CLI Options

Option Description Default
-c, --config <path or preset config> Choose parser's configuration default
--cache Enable caching false
--cache-file <path> Specify cache file and enable caching .wikilintcache
--ext <extension> Specify file extension
Can be used multiple times
all files
--fix Automatically fix problems false
-h, --help Print available options
-i, --include Parse for inclusion false
--ignore <pattern> Ignore files matching the glob pattern
Can be used multiple times
-l, --lang <path or preset language> Choose i18n language English
-q, --quiet Report errors only errors and warnings
-r, --recursive Recursively lint files false
-s, --strict Exit when there is an error or warning
Override -q or --quiet
Exit 1 only where there is an error
-v, --version Print package version

Configuration

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> [force]
# For example:
npx getParserConfig jawiki https://ja.wikipedia.org/w

The generated configuration file will be saved in the config directory. You can then use the site name as the --config option.

# For example:
npx wikilint --config jawiki *.wiki

Package Sidebar

Install

npm i wikilint

Weekly Downloads

75

Version

2.21.1

License

GPL-3.0

Unpacked Size

813 kB

Total Files

183

Last publish

Collaborators

  • bhsd