https://github.com/bhsd-harry/vscode-extension-wikiparser
VSCode language server for MediaWiki Wikitext
https://github.com/bhsd-harry/vscode-extension-wikiparser
language-server mediawiki visual-studio-code-extension vscode-extension wikitext
Last synced: 15 days ago
JSON representation
VSCode language server for MediaWiki Wikitext
- Host: GitHub
- URL: https://github.com/bhsd-harry/vscode-extension-wikiparser
- Owner: bhsd-harry
- License: gpl-3.0
- Created: 2024-11-10T06:59:48.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-04-04T10:10:54.000Z (22 days ago)
- Last Synced: 2025-04-11T06:13:46.442Z (15 days ago)
- Topics: language-server, mediawiki, visual-studio-code-extension, vscode-extension, wikitext
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=Bhsd.vscode-extension-wikiparser
- Size: 2.7 MB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# WikiParser Language Server
[](https://marketplace.visualstudio.com/items?itemName=Bhsd.vscode-extension-wikiparser)
[](https://github.com/bhsd-harry/vscode-extension-wikiparser/actions/workflows/codeql.yml)
[](https://github.com/bhsd-harry/vscode-extension-wikiparser/actions/workflows/node.js.yml)
[](https://app.codacy.com/gh/bhsd-harry/vscode-extension-wikiparser/dashboard)
This is a language server extension for Visual Studio Code that provides language supports for the [Wikitext](https://www.mediawiki.org/wiki/Wikitext) language.
## Installation
You can install this extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=Bhsd.vscode-extension-wikiparser).
## Features
### Linting and quick fixes, offered by [WikiLint](https://npmjs.com/package/wikilint)
### Auto-completion
### Color preview
### Code navigation
### Followable wiki and external links
### Symbol renaming
### Code folding
### Outline view
### Hover
### Help with parser function signatures
### Inlay hints
*Available since version 1.1.1*
## Configuration
| Configuration | Description | Default |
| :----- | :---------- | :------ |
| `wikiparser.articlePath` | Specify the article path of the wiki site.
Also set the parser configuration automatically for all language editions of Wikipedia. | |
| `wikiparser.config` | Manually specifiy the path to the parser configuration file. | |
| `wikiparser.linter.enable` | Enable diagnostics. | `true` |
| `wikiparser.linter.severity` | Display or hide warnings. | `errors only` |
| `wikiparser.linter.lilypond` | Specify the path to the LilyPond executable to lint ``. | |
| `wikiparser.completion` | Enable auto-completion. | `true` |
| `wikiparser.color` | Enable color decorators. | `true` |
| `wikiparser.hover` | Enable hover information. | `true` |
| `wikiparser.inlay` | Enable inlay hints for anonymous template/module parameters. | `true` |
| `wikiparser.signature` | Enable parser function signature help. | `true` |
## Usage
This extension does not activate automatically. The server exists as an asset at the location: `server/dist/server.js`. You can call this asset from any extension, for example:
```js
const path = require('path'),
{extensions} = require('vscode'),
{LanguageClient} = require('vscode-languageclient/node');
const {extensionPath} = extensions.getExtension('Bhsd.vscode-extension-wikiparser');
new LanguageClient(
'WikiParser Language Server',
{
run: {module: path.join(extensionPath, 'server', 'dist', 'server.js')},
},
{
documentSelector: [
{scheme: 'file', language: 'wikitext'},
{scheme: 'untitled', language: 'wikitext'},
],
},
).start();
```
If the [Wikitext](https://marketplace.visualstudio.com/items?itemName=RoweWilsonFrederiskHolme.wikitext) extension is installed, this extension will automatically activate by setting the `wikitext.wikiparser.enable` configuration to `true`.