Skip to content

Commit 00695da

Browse files
authored
Update to remark-language-server 3 (#130)
This also includes related dependencies to provide compatibility with unified 11. This also contains a new setting and related documentation changes.
1 parent a1f6909 commit 00695da

File tree

2 files changed

+53
-13
lines changed

2 files changed

+53
-13
lines changed

package.json

+13-3
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@
4040
"esbuild": "^0.20.0",
4141
"ovsx": "^0.9.0",
4242
"prettier": "^3.0.0",
43-
"remark-cli": "^11.0.0",
44-
"remark-language-server": "^2.0.0",
45-
"remark-preset-wooorm": "^9.0.0",
43+
"remark-cli": "^12.0.0",
44+
"remark-language-server": "^3.0.0",
45+
"remark-preset-wooorm": "^10.0.0",
4646
"typescript": "^5.0.0",
4747
"vscode-languageclient": "^9.0.0",
4848
"xo": "^0.58.0"
@@ -102,6 +102,16 @@
102102
}
103103
},
104104
"contributes": {
105+
"configuration": {
106+
"title": "remark",
107+
"properties": {
108+
"remark.requireConfig": {
109+
"type": "boolean",
110+
"default": false,
111+
"markdownDescription": "If true, only perform actions if a [configuration file](https://github.com/remarkjs/vscode-remark#configuration-file) is found."
112+
}
113+
}
114+
},
105115
"jsonValidation": [
106116
{
107117
"fileMatch": [

readme.md

+40-10
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,18 @@ Visual Studio Code extension to format and lint markdown files with remark.
1010

1111
## Contents
1212

13-
* [What is this?](#what-is-this)
14-
* [When should I use this?](#when-should-i-use-this)
15-
* [Install](#install)
16-
* [Use](#use)
17-
* [Formatting](#formatting)
18-
* [Plugins](#plugins)
19-
* [Compatibility](#compatibility)
20-
* [Security](#security)
21-
* [Contribute](#contribute)
22-
* [License](#license)
13+
* [What is this?](#what-is-this)
14+
* [When should I use this?](#when-should-i-use-this)
15+
* [Install](#install)
16+
* [Use](#use)
17+
* [Configuration file](#configuration-file)
18+
* [Settings](#settings)
19+
* [Formatting](#formatting)
20+
* [Plugins](#plugins)
21+
* [Compatibility](#compatibility)
22+
* [Security](#security)
23+
* [Contribute](#contribute)
24+
* [License](#license)
2325

2426
## What is this?
2527

@@ -72,6 +74,32 @@ Here’s an example that should produce problems you can use to verify:
7274
1) Hello, _Jupiter_ and *Neptune*!
7375
```
7476

77+
## Configuration file
78+
79+
`remark-language-server` uses the same configuration files as
80+
[`remark-cli`][remark-cli].
81+
These files are:
82+
83+
* `.remarkrc`
84+
* `.remarkrc.cjs`
85+
* `.remarkrc.js`
86+
* `.remarkrc.json`
87+
* `.remarkrc.mjs`
88+
* `.remarkrc.yaml`
89+
* `.remarkrc.yml`
90+
* `package.json`
91+
92+
Language clients should notify the language server if these files change.
93+
They are looked up starting at the folder where the checked markdown file
94+
exists.
95+
96+
## Settings
97+
98+
This extension supports the following settings:
99+
100+
* `remark.requireConfig` (`boolean`, default: `false`) — If true, only perform
101+
actions if a [configuration file][configuration-file] is found.
102+
75103
## Formatting
76104

77105
This extension can format markdown files.
@@ -141,6 +169,8 @@ abide by its terms.
141169

142170
[build]: https://github.com/remarkjs/vscode-remark/actions
143171

172+
[configuration-file]: #configuration-file
173+
144174
[downloads-badge]: https://img.shields.io/visual-studio-marketplace/d/unifiedjs.vscode-remark
145175

146176
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

0 commit comments

Comments
 (0)