Pick up latest markdown language service and clean up server package #164516
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| # Markdown Language Server | ||
|
|
||
| > **❗ Import** This is still in development. While the language server is being used by VS Code, it has not yet been tested with other clients. | ||
|
|
||
| The Markdown language server powers VS Code's built-in markdown support, providing tools for writing and browsing Markdown files. It runs as a separate executable and implements the [language server protocol](https://microsoft.github.io/language-server-protocol/overview). | ||
|
|
||
| This server uses the [Markdown Language Service](https://github.com/microsoft/vscode-markdown-languageservice) to implement almost all of the language features. You can use that library if you need a library for working with Markdown instead of a full language server. | ||
|
|
||
|
|
||
| ## Server capabilities | ||
|
|
||
| - [Completions](https://microsoft.github.io/language-server-protocol/specification#textDocument_completion) for Markdown links. | ||
|
|
||
| - [Folding](https://microsoft.github.io/language-server-protocol/specification#textDocument_foldingRange) of Markdown regions, block elements, and header sections. | ||
|
|
||
| - [Smart selection](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_selectionRange) for inline elements, block elements, and header sections. | ||
|
|
||
| - [Document Symbols](https://microsoft.github.io/language-server-protocol/specification#textDocument_documentSymbol) for quick navigation to headers in a document. | ||
|
There was a problem hiding this comment. Nit: casing on this link text is inconsistent with other links |
||
|
|
||
| - [Workspace Symbols](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#workspace_symbol) for quick navigation to headers in the workspace | ||
|
|
||
| - [Document links](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_documentLink) for making Markdown links in a document clickable. | ||
|
|
||
| - [Find all references](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_references) to headers and links across all Markdown files in the workspace. | ||
|
|
||
| - [Go to definition](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_definition) from links to headers or link definitions. | ||
|
|
||
| - [Rename](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_rename) of headers and links across all Markdown files in the workspace. | ||
|
|
||
| - Find all references to a file. Uses a custom `markdown/getReferencesToFileInWorkspace` message. | ||
|
|
||
| - [Code Actions](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_codeAction) | ||
|
|
||
| - Organize link definitions source action. | ||
| - Extract link to definition refactoring. | ||
|
|
||
| - Updating links when a file is moved / renamed. Uses a custom `markdown/getEditForFileRenames` message. | ||
|
|
||
| - [Pull diagnostics (validation)](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_pullDiagnostics) for links. | ||
|
|
||
|
|
||
| ## Client requirements | ||
|
|
||
| ### Initialization options | ||
|
|
||
| The client can send the following initialization options to the server: | ||
|
|
||
| - `markdownFileExtensions` Array file extensions that should be considered as Markdown. These should not include the leading `.`. For example: `['md', 'mdown', 'markdown']`. | ||
|
|
||
| ### Settings | ||
|
|
||
| Clients may send a `workspace/didChangeConfiguration` notification to notify the server of settings changes. | ||
| The server supports the following settings: | ||
|
|
||
| - `markdown` | ||
| - `suggest` | ||
| - `paths` | ||
| - `enabled` — Enable/disable path suggestions. | ||
|
|
||
| - `occurrencesHighlight` | ||
| - `enabled` — Enable/disable highlighting of link occurrences. | ||
|
|
||
| - `validate` | ||
| - `enabled` — Enable/disable all validation. | ||
| - `referenceLinks` | ||
| - `enabled` — Enable/disable validation of reference links: `[text][ref]` | ||
| - `fragmentLinks` | ||
| - `enabled` — Enable/disable validation of links to fragments in the current files: `[text](#head)` | ||
| - `fileLinks` | ||
| - `enabled` — Enable/disable validation of links to file in the workspace. | ||
| - `markdownFragmentLinks` — Enable/disable validation of links to headers in other Markdown files. Use `inherit` to inherit the `fragmentLinks` setting. | ||
| - `ignoredLinks` — Array of glob patterns for files that should not be validated. | ||
| - `unusedLinkDefinitions` | ||
| - `enabled` — Enable/disable validation of unused link definitions. | ||
| - `duplicateLinkDefinitions` | ||
| - `enabled` — Enable/disable validation of duplicated link definitions. | ||
|
|
||
| ### Custom requests | ||
|
|
||
| To support all of the features of the language server, the client needs to implement a few custom request types. The definitions of these request types can be found in [`protocol.ts`](./src/protocol.ts) | ||
|
|
||
| #### `markdown/parse` | ||
|
|
||
| Get the tokens for a Markdown file. Clients are expected to use [Markdown-it](https://github.com/markdown-it/markdown-it) for this. | ||
|
|
||
| We require that clients bring their own version of Markdown-it so that they can customize/extend Markdown-it. | ||
|
|
||
| #### `markdown/fs/readFile` | ||
|
|
||
| Read the contents of a file in the workspace. | ||
|
|
||
| #### `markdown/fs/readDirectory` | ||
|
|
||
| Read the contents of a directory in the workspace. | ||
|
|
||
| #### `markdown/fs/stat` | ||
|
|
||
| Check if a given file/directory exists in the workspace. | ||
|
|
||
| #### `markdown/fs/watcher/create` | ||
|
|
||
| Create a file watcher. This is needed for diagnostics support. | ||
|
|
||
| #### `markdown/fs/watcher/delete` | ||
|
|
||
| Delete a previously created file watcher. | ||
|
|
||
| #### `markdown/findMarkdownFilesInWorkspace` | ||
|
|
||
| Get a list of all markdown files in the workspace. | ||
|
|
||
|
|
||
| ## Contribute | ||
|
|
||
| The source code of the Markdown language server can be found in the [VSCode repository](https://github.com/microsoft/vscode) at [extensions/markdown-language-features/server](https://github.com/microsoft/vscode/tree/master/extensions/markdown-language-features/server). | ||
|
|
||
| File issues and pull requests in the [VSCode GitHub Issues](https://github.com/microsoft/vscode/issues). See the document [How to Contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute) on how to build and run from source. | ||
|
There was a problem hiding this comment. Nit: "VSCode GitHub issues tracker" or remove "the" in front of the link text |
||
|
|
||
| Most of the functionality of the server is located in libraries: | ||
|
|
||
| - [vscode-markdown-languageservice](https://github.com/microsoft/vscode-markdown-languageservice) contains the implementation of all features as a reusable library. | ||
| - [vscode-languageserver-node](https://github.com/microsoft/vscode-languageserver-node) contains the implementation of language server for NodeJS. | ||
|
|
||
| Help on any of these projects is very welcome. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. | ||
|
|
||
| ## License | ||
|
|
||
| Copyright (c) Microsoft Corporation. All rights reserved. | ||
|
|
||
| Licensed under the [MIT](https://github.com/microsoft/vscode/blob/master/LICENSE.txt) License. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| { | ||
| "name": "vscode-markdown-languageserver", | ||
| "description": "Markdown language server", | ||
| "version": "0.2.0-alpha.4", | ||
| "author": "Microsoft Corporation", | ||
| "license": "MIT", | ||
| "engines": { | ||
| "node": "*" | ||
| }, | ||
| "main": "./out/node/main", | ||
| "browser": "./dist/browser/main", | ||
| "files": [ | ||
| "dist/**/*.js", | ||
| "out/**/*.js" | ||
| ], | ||
| "dependencies": { | ||
| "vscode-languageserver": "^8.0.2", | ||
| "vscode-languageserver-textdocument": "^1.0.5", | ||
| "vscode-languageserver-types": "^3.17.1", | ||
| "vscode-markdown-languageservice": "^0.2.0-alpha.4", | ||
| "vscode-nls": "^5.2.0", | ||
| "vscode-uri": "^3.0.3" | ||
| }, | ||
| "devDependencies": { | ||
| "@types/node": "16.x" | ||
| }, | ||
| "scripts": { | ||
| "compile": "gulp compile-extension:markdown-language-features-server", | ||
| "prepublishOnly": "npm run compile", | ||
| "watch": "gulp watch-extension:markdown-language-features-server" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: Important instead of import