Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update to remark-language-server 3 #130

Merged
merged 3 commits into from
Apr 16, 2024
Merged

Update to remark-language-server 3 #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6819726
Update to remark-language-server 3
remcohaszing Apr 16, 2024
1113b4e
Update settings and documentation
remcohaszing Apr 16, 2024
13492d4
Update link in the configuration schema
remcohaszing Apr 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@
"esbuild": "^0.20.0",
"ovsx": "^0.9.0",
"prettier": "^3.0.0",
"remark-cli": "^11.0.0",
"remark-language-server": "^2.0.0",
"remark-preset-wooorm": "^9.0.0",
"remark-cli": "^12.0.0",
"remark-language-server": "^3.0.0",
"remark-preset-wooorm": "^10.0.0",
"typescript": "^5.0.0",
"vscode-languageclient": "^9.0.0",
"xo": "^0.58.0"
Expand Down Expand Up @@ -102,6 +102,16 @@
}
},
"contributes": {
"configuration": {
"title": "remark",
"properties": {
"remark.requireConfig": {
"type": "boolean",
"default": false,
"markdownDescription": "If true, only perform actions if a [configuration file](https://github.com/remarkjs/vscode-remark#configuration-file) is found."
}
}
},
"jsonValidation": [
{
"fileMatch": [
Expand Down
50 changes: 40 additions & 10 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,18 @@ Visual Studio Code extension to format and lint markdown files with remark.

## Contents

* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [Formatting](#formatting)
* [Plugins](#plugins)
* [Compatibility](#compatibility)
* [Security](#security)
* [Contribute](#contribute)
* [License](#license)
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [Configuration file](#configuration-file)
* [Settings](#settings)
* [Formatting](#formatting)
* [Plugins](#plugins)
* [Compatibility](#compatibility)
* [Security](#security)
* [Contribute](#contribute)
* [License](#license)

## What is this?

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

## Configuration file

`remark-language-server` uses the same configuration files as
[`remark-cli`][remark-cli].
These files are:

* `.remarkrc`
* `.remarkrc.cjs`
* `.remarkrc.js`
* `.remarkrc.json`
* `.remarkrc.mjs`
* `.remarkrc.yaml`
* `.remarkrc.yml`
* `package.json`

Language clients should notify the language server if these files change.
They are looked up starting at the folder where the checked markdown file
exists.

## Settings

This extension supports the following settings:

* `remark.requireConfig` (`boolean`, default: `false`) — If true, only perform
actions if a [configuration file][configuration-file] is found.

## Formatting

This extension can format markdown files.
Expand Down Expand Up @@ -141,6 +169,8 @@ abide by its terms.

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

[configuration-file]: #configuration-file

[downloads-badge]: https://img.shields.io/visual-studio-marketplace/d/unifiedjs.vscode-remark

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
Expand Down
Loading