mirror of
https://github.com/Microsoft/vscode
synced 2024-06-28 13:54:38 +00:00
Fix supported markdown-lint violations in markdown files (#190750)
docs: fix supported markdownlint violations
This commit is contained in:
Alpha Romer Coma
GitHub
parent
42ff46c880
commit
7ef754c2f6
|
|
@ -19,13 +19,14 @@ This dev container includes configuration for a development container for workin
|
|||
> **Note:** The Dev Containers extension requires the Visual Studio Code distribution of Code - OSS. See the [FAQ](https://aka.ms/vscode-remote/faq/license) for details.
|
||||
|
||||
4. Due to the size of the repository we strongly recommend cloning it on a Linux filesystem for better bind mount performance. On macOS we recommend using a Docker volume (press <kbd>F1</kbd> and select **Dev Containers: Clone Repository in Container Volume...**) and on Windows we recommend using a WSL folder:
|
||||
|
||||
- Make sure you are running a recent WSL version to get X11 and Wayland support.
|
||||
- Use the WSL extension for VS Code to open the cloned folder in WSL.
|
||||
- Press <kbd>F1</kbd> and select **Dev Containers: Reopen in Container**.
|
||||
|
||||
Next: **[Try it out!](#try-it)**
|
||||
|
||||
## Try it!
|
||||
## Try it
|
||||
|
||||
To start working with Code - OSS, follow these steps:
|
||||
|
||||
|
|
@ -50,6 +51,6 @@ Next, let's try debugging.
|
|||
|
||||
Enjoy!
|
||||
|
||||
# Notes
|
||||
## Notes
|
||||
|
||||
The container comes with VS Code Insiders installed. To run it from an Integrated Terminal use `VSCODE_IPC_HOOK_CLI= /usr/bin/code-insiders .`.
|
||||
|
|
|
|||
|
|
@ -14,21 +14,21 @@ If you already have VS Code and Docker installed, you can click the badge above
|
|||
|
||||
2. **Important**: Docker needs at least **4 Cores and 8 GB of RAM** to run a full build with **9 GB of RAM** being recommended. If you are on macOS, or are using the old Hyper-V engine for Windows, update these values for Docker Desktop by right-clicking on the Docker status bar item and going to **Preferences/Settings > Resources > Advanced**.
|
||||
|
||||
> **Note:** The [Resource Monitor](https://marketplace.visualstudio.com/items?itemName=mutantdino.resourcemonitor) extension is included in the container so you can keep an eye on CPU/Memory in the status bar.
|
||||
> **Note:** The [Resource Monitor](https://marketplace.visualstudio.com/items?itemName=mutantdino.resourcemonitor) extension is included in the container so you can keep an eye on CPU/Memory in the status bar.
|
||||
|
||||
3. Install [Visual Studio Code Stable](https://code.visualstudio.com/) or [Insiders](https://code.visualstudio.com/insiders/) and the [Dev Containers](https://aka.ms/vscode-remote/download/containers) extension.
|
||||
|
||||
|
||||
|
||||
|
||||
> **Note:** The Dev Containers extension requires the Visual Studio Code distribution of Code - OSS. See the [FAQ](https://aka.ms/vscode-remote/faq/license) for details.
|
||||
> **Note:** The Dev Containers extension requires the Visual Studio Code distribution of Code - OSS. See the [FAQ](https://aka.ms/vscode-remote/faq/license) for details.
|
||||
|
||||
4. Press <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> or <kbd>F1</kbd> and select **Dev Containers: Clone Repository in Container Volume...**.
|
||||
|
||||
> **Tip:** While you can use your local source tree instead, operations like `yarn install` can be slow on macOS or when using the Hyper-V engine on Windows. We recommend the "clone repository in container" approach instead since it uses "named volume" rather than the local filesystem.
|
||||
> **Tip:** While you can use your local source tree instead, operations like `yarn install` can be slow on macOS or when using the Hyper-V engine on Windows. We recommend the "clone repository in container" approach instead since it uses "named volume" rather than the local filesystem.
|
||||
|
||||
5. Type `https://github.com/microsoft/vscode` (or a branch or PR URL) in the input box and press <kbd>Enter</kbd>.
|
||||
|
||||
6. After the container is running, open a web browser and go to [http://localhost:6080](http://localhost:6080), or use a [VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/) to connect to `localhost:5901` and enter `vscode` as the password.
|
||||
6. After the container is running, open a web browser and go to [http://localhost:6080](http://localhost:6080), or use a [VNC Viewer][def] to connect to `localhost:5901` and enter `vscode` as the password.
|
||||
|
||||
Anything you start in VS Code, or the integrated terminal, will appear here.
|
||||
|
||||
|
|
@ -54,41 +54,42 @@ Next: **[Try it out!](#try-it)**
|
|||
|
||||
### Using VS Code with GitHub Codespaces
|
||||
|
||||
You may see improved VNC responsiveness when accessing a codespace from VS Code client since you can use a [VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/). Here's how to do it.
|
||||
You may see improved VNC responsiveness when accessing a codespace from VS Code client since you can use a [VNC Viewer][def]. Here's how to do it.
|
||||
|
||||
1. Install [Visual Studio Code Stable](https://code.visualstudio.com/) or [Insiders](https://code.visualstudio.com/insiders/) and the the [GitHub Codespaces extension](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces).
|
||||
1. Install [Visual Studio Code Stable](https://code.visualstudio.com/) or [Insiders](https://code.visualstudio.com/insiders/) and the the [GitHub Codespaces extension](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces).
|
||||
|
||||
> **Note:** The GitHub Codespaces extension requires the Visual Studio Code distribution of Code - OSS.
|
||||
> **Note:** The GitHub Codespaces extension requires the Visual Studio Code distribution of Code - OSS.
|
||||
|
||||
2. After the VS Code is up and running, press <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> or <kbd>F1</kbd>, choose **Codespaces: Create New Codespace**, and use the following settings:
|
||||
- `microsoft/vscode` for the repository.
|
||||
- Select any branch (e.g. **main**) - you can select a different one later.
|
||||
- Choose **Standard** (4-core, 8GB) as the size.
|
||||
|
||||
4. After you have connected to the codespace, you can use a [VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/) to connect to `localhost:5901` and enter `vscode` as the password.
|
||||
- `microsoft/vscode` for the repository.
|
||||
- Select any branch (e.g. **main**) - you can select a different one later.
|
||||
- Choose **Standard** (4-core, 8GB) as the size.
|
||||
|
||||
3. After you have connected to the codespace, you can use a [VNC Viewer][def] to connect to `localhost:5901` and enter `vscode` as the password.
|
||||
|
||||
> **Tip:** You may also need change your VNC client's **Picture Quality** setting to **High** to get a full color desktop.
|
||||
|
||||
5. Anything you start in VS Code, or the integrated terminal, will appear here.
|
||||
4. Anything you start in VS Code, or the integrated terminal, will appear here.
|
||||
|
||||
Next: **[Try it out!](#try-it)**
|
||||
|
||||
## Try it!
|
||||
## Try it
|
||||
|
||||
This container uses the [Fluxbox](http://fluxbox.org/) window manager to keep things lean. **Right-click on the desktop** to see menu options. It works with GNOME and GTK applications, so other tools can be installed if needed.
|
||||
|
||||
> **Note:** You can also set the resolution from the command line by typing `set-resolution`.
|
||||
> **Note:** You can also set the resolution from the command line by typing `set-resolution`.
|
||||
|
||||
To start working with Code - OSS, follow these steps:
|
||||
|
||||
1. In your local VS Code client, open a terminal (<kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>\`</kbd>) and type the following commands:
|
||||
|
||||
```bash
|
||||
yarn install
|
||||
bash scripts/code.sh
|
||||
```
|
||||
```bash
|
||||
yarn install
|
||||
bash scripts/code.sh
|
||||
```
|
||||
|
||||
2. After the build is complete, open a web browser or a [VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/) to connect to the desktop environment as described in the quick start and enter `vscode` as the password.
|
||||
2. After the build is complete, open a web browser or a [VNC Viewer][def] to connect to the desktop environment as described in the quick start and enter `vscode` as the password.
|
||||
|
||||
3. You should now see Code - OSS!
|
||||
|
||||
|
|
@ -98,8 +99,10 @@ Next, let's try debugging.
|
|||
|
||||
2. Go to your local VS Code client, and use the **Run / Debug** view to launch the **VS Code** configuration. (Typically the default, so you can likely just press <kbd>F5</kbd>).
|
||||
|
||||
> **Note:** If launching times out, you can increase the value of `timeout` in the "VS Code", "Attach Main Process", "Attach Extension Host", and "Attach to Shared Process" configurations in [launch.json](../../.vscode/launch.json). However, running `scripts/code.sh` first will set up Electron which will usually solve timeout issues.
|
||||
> **Note:** If launching times out, you can increase the value of `timeout` in the "VS Code", "Attach Main Process", "Attach Extension Host", and "Attach to Shared Process" configurations in [launch.json](../../.vscode/launch.json). However, running `scripts/code.sh` first will set up Electron which will usually solve timeout issues.
|
||||
|
||||
3. After a bit, Code - OSS will appear with the debugger attached!
|
||||
|
||||
Enjoy!
|
||||
|
||||
[def]: https://www.realvnc.com/en/connect/download/viewer/
|
||||
|
|
|
|||
|
|
@ -104,6 +104,6 @@ If you believe the bot got something wrong, please open a new issue and let us k
|
|||
If you are interested in writing code to fix issues,
|
||||
please see [How to Contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute) in the wiki.
|
||||
|
||||
# Thank You!
|
||||
## Thank You
|
||||
|
||||
Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,5 @@
|
|||
# Visual Studio Code - Open Source ("Code - OSS")
|
||||
|
||||
[](https://github.com/microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc)
|
||||
[](https://github.com/microsoft/vscode/issues?utf8=✓&q=is%3Aissue+is%3Aopen+label%3Abug)
|
||||
[](https://gitter.im/Microsoft/vscode)
|
||||
|
|
@ -60,9 +61,10 @@ VS Code includes a set of built-in extensions located in the [extensions](extens
|
|||
|
||||
This repository includes a Visual Studio Code Dev Containers / GitHub Codespaces development container.
|
||||
|
||||
- For [Dev Containers](https://aka.ms/vscode-remote/download/containers), use the **Dev Containers: Clone Repository in Container Volume...** command which creates a Docker volume for better disk I/O on macOS and Windows.
|
||||
- If you already have VS Code and Docker installed, you can also click [here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/vscode) to get started. This will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use.
|
||||
- For Codespaces, install the [GitHub Codespaces](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension in VS Code, and use the **Codespaces: Create New Codespace** command.
|
||||
* For [Dev Containers](https://aka.ms/vscode-remote/download/containers), use the **Dev Containers: Clone Repository in Container Volume...** command which creates a Docker volume for better disk I/O on macOS and Windows.
|
||||
* If you already have VS Code and Docker installed, you can also click [here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/vscode) to get started. This will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use.
|
||||
|
||||
* For Codespaces, install the [GitHub Codespaces](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension in VS Code, and use the **Codespaces: Create New Codespace** command.
|
||||
|
||||
Docker / the Codespace should have at least **4 Cores and 6 GB of RAM (8 GB recommended)** to run full build. See the [development container README](.devcontainer/README.md) for more information.
|
||||
|
||||
|
|
|
|||
14
SECURITY.md
14
SECURITY.md
|
|
@ -18,13 +18,13 @@ You should receive a response within 24 hours. If for some reason you do not, pl
|
|||
|
||||
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
|
||||
|
||||
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
|
||||
* Full paths of source file(s) related to the manifestation of the issue
|
||||
* The location of the affected source code (tag/branch/commit or direct URL)
|
||||
* Any special configuration required to reproduce the issue
|
||||
* Step-by-step instructions to reproduce the issue
|
||||
* Proof-of-concept or exploit code (if possible)
|
||||
* Impact of the issue, including how an attacker might exploit the issue
|
||||
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
|
||||
* Full paths of source file(s) related to the manifestation of the issue
|
||||
* The location of the affected source code (tag/branch/commit or direct URL)
|
||||
* Any special configuration required to reproduce the issue
|
||||
* Step-by-step instructions to reproduce the issue
|
||||
* Proof-of-concept or exploit code (if possible)
|
||||
* Impact of the issue, including how an attacker might exploit the issue
|
||||
|
||||
This information will help us triage your report more quickly.
|
||||
|
||||
|
|
|
|||
|
|
@ -10,4 +10,5 @@ The Monaco Editor is the code editor that powers [VS Code](https://github.com/mi
|
|||
This npm module contains the core editor functionality, as it comes from the [vscode repository](https://github.com/microsoft/vscode).
|
||||
|
||||
## License
|
||||
|
||||
[MIT](https://github.com/microsoft/vscode/blob/main/LICENSE.txt)
|
||||
|
|
|
|||
|
|
@ -14,7 +14,8 @@ The Git extension exposes an API, reachable by any other extension.
|
|||
2. Include `git-base.d.ts` in your extension's compilation.
|
||||
3. Get a hold of the API with the following snippet:
|
||||
|
||||
```ts
|
||||
const gitBaseExtension = vscode.extensions.getExtension<GitBaseExtension>('vscode.git-base').exports;
|
||||
const git = gitBaseExtension.getAPI(1);
|
||||
```
|
||||
```ts
|
||||
const gitBaseExtension = vscode.extensions.getExtension<GitBaseExtension>('vscode.git-base').exports;
|
||||
const git = gitBaseExtension.getAPI(1);
|
||||
|
||||
```
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ The Git extension exposes an API, reachable by any other extension.
|
|||
2. Include `git.d.ts` in your extension's compilation.
|
||||
3. Get a hold of the API with the following snippet:
|
||||
|
||||
```ts
|
||||
const gitExtension = vscode.extensions.getExtension<GitExtension>('vscode.git').exports;
|
||||
const git = gitExtension.getAPI(1);
|
||||
```
|
||||
```ts
|
||||
const gitExtension = vscode.extensions.getExtension<GitExtension>('vscode.git').exports;
|
||||
const git = gitExtension.getAPI(1);
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,10 +1,12 @@
|
|||
The file `JavaScript.tmLanguage.json` is derived from [TypeScriptReact.tmLanguage](https://github.com/microsoft/TypeScript-TmLanguage/blob/master/TypeScriptReact.tmLanguage).
|
||||
|
||||
To update to the latest version:
|
||||
|
||||
- `cd extensions/typescript` and run `npm run update-grammars`
|
||||
- don't forget to run the integration tests at `./scripts/test-integration.sh`
|
||||
|
||||
The script does the following changes:
|
||||
|
||||
- fileTypes .tsx -> .js & .jsx
|
||||
- scopeName scope.tsx -> scope.js
|
||||
- update all rule names .tsx -> .js
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@
|
|||
|
||||
## Features
|
||||
|
||||
See [JSON in Visual Studio Code](https://code.visualstudio.com/docs/languages/json) to learn about the features of this extension.
|
||||
See [JSON in Visual Studio Code](https://code.visualstudio.com/docs/languages/json) to learn about the features of this extension.
|
||||
|
|
|
|||
|
|
@ -11,6 +11,7 @@ The JSON Language server provides language-specific smarts for editing, validati
|
|||
### Server capabilities
|
||||
|
||||
The JSON language server supports requests on documents of language id `json` and `jsonc`.
|
||||
|
||||
- `json` documents are parsed and validated following the [JSON specification](https://tools.ietf.org/html/rfc7159).
|
||||
- `jsonc` documents additionally accept single line (`//`) and multi-line comments (`/* ... */`). JSONC is a VSCode specific file format, intended for VSCode configuration files, without any aspirations to define a new common file format.
|
||||
|
||||
|
|
@ -25,12 +26,12 @@ The server implements the following capabilities of the language server protocol
|
|||
- Semantic Selection for semantic selection for one or multiple cursor positions.
|
||||
- [Goto Definition](https://microsoft.github.io/language-server-protocol/specification#textDocument_definition) for $ref references in JSON schemas
|
||||
- [Diagnostics (Validation)](https://microsoft.github.io/language-server-protocol/specification#textDocument_publishDiagnostics) are pushed for all open documents
|
||||
- syntax errors
|
||||
- structural validation based on the document's [JSON schema](http://json-schema.org/).
|
||||
- syntax errors
|
||||
- structural validation based on the document's [JSON schema](http://json-schema.org/).
|
||||
|
||||
In order to load JSON schemas, the JSON server uses NodeJS `http` and `fs` modules. For all other features, the JSON server only relies on the documents and settings provided by the client through the LSP.
|
||||
|
||||
### Client requirements:
|
||||
### Client requirements
|
||||
|
||||
The JSON language server expects the client to only send requests and notifications for documents of language id `json` and `jsonc`.
|
||||
|
||||
|
|
@ -56,8 +57,8 @@ Clients may send a `workspace/didChangeConfiguration` notification to notify the
|
|||
The server supports the following settings:
|
||||
|
||||
- http
|
||||
- `proxy`: The URL of the proxy server to use when fetching schema. When undefined or empty, no proxy is used.
|
||||
- `proxyStrictSSL`: Whether the proxy server certificate should be verified against the list of supplied CAs.
|
||||
- `proxy`: The URL of the proxy server to use when fetching schema. When undefined or empty, no proxy is used.
|
||||
- `proxyStrictSSL`: Whether the proxy server certificate should be verified against the list of supplied CAs.
|
||||
|
||||
- json
|
||||
- `format`
|
||||
|
|
@ -72,6 +73,7 @@ The server supports the following settings:
|
|||
- `resultLimit`: The max number of color decorators and outline symbols to be computed (for performance reasons)
|
||||
- `jsonFoldingLimit`: The max number of folding ranges to be computed for json documents (for performance reasons)
|
||||
- `jsoncFoldingLimit`: The max number of folding ranges to be computed for jsonc documents (for performance reasons)
|
||||
|
||||
```json
|
||||
{
|
||||
"http": {
|
||||
|
|
@ -103,6 +105,7 @@ The server supports the following settings:
|
|||
[JSON schemas](http://json-schema.org/) are essential for code assist, hovers, color decorators to work and are required for structural validation.
|
||||
|
||||
To find the schema for a given JSON document, the server uses the following mechanisms:
|
||||
|
||||
- JSON documents can define the schema URL using a `$schema` property
|
||||
- The settings define a schema association based on the documents URL. Settings can either associate a schema URL to a file or path pattern, and they can directly provide a schema.
|
||||
- Additionally, schema associations can also be provided by a custom 'schemaAssociations' configuration call.
|
||||
|
|
@ -115,9 +118,9 @@ The `initializationOptions.handledSchemaProtocols` initialization option defines
|
|||
|
||||
```ts
|
||||
let clientOptions: LanguageClientOptions = {
|
||||
initializationOptions: {
|
||||
handledSchemaProtocols: ['file'] // language server should only try to load file URLs
|
||||
}
|
||||
initializationOptions: {
|
||||
handledSchemaProtocols: ['file'] // language server should only try to load file URLs
|
||||
}
|
||||
...
|
||||
}
|
||||
```
|
||||
|
|
@ -132,6 +135,7 @@ If `handledSchemaProtocols` is not set, the JSON language server will load the f
|
|||
Requests for schemas with URLs not handled by the server are forwarded to the client through an LSP request. This request is a JSON language server-specific, non-standardized, extension to the LSP.
|
||||
|
||||
Request:
|
||||
|
||||
- method: 'vscode/content'
|
||||
- params: `string` - The schema URL to request.
|
||||
- response: `string` - The content of the schema with the given URL
|
||||
|
|
@ -146,6 +150,7 @@ The server will, as a response, clear the schema content from the cache and relo
|
|||
In addition to the settings, schemas associations can also be provided through a notification from the client to the server. This notification is a JSON language server-specific, non-standardized, extension to the LSP.
|
||||
|
||||
Notification:
|
||||
|
||||
- method: 'json/schemaAssociations'
|
||||
- params: `ISchemaAssociations` or `ISchemaAssociation[]` defined as follows
|
||||
|
||||
|
|
@ -183,11 +188,14 @@ interface ISchemaAssociation {
|
|||
}
|
||||
|
||||
```
|
||||
|
||||
`ISchemaAssociations`
|
||||
- keys: a file names or file path (separated by `/`). `*` can be used as a wildcard.
|
||||
- values: An array of schema URLs
|
||||
|
||||
- keys: a file names or file path (separated by `/`). `*` can be used as a wildcard.
|
||||
- values: An array of schema URLs
|
||||
|
||||
Notification:
|
||||
|
||||
- method: 'json/schemaContent'
|
||||
- params: `string` the URL of the schema that has changed.
|
||||
|
||||
|
|
@ -226,6 +234,7 @@ The source code of the JSON language server can be found in the [VSCode reposito
|
|||
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.
|
||||
|
||||
Most of the functionality of the server is located in libraries:
|
||||
|
||||
- [jsonc-parser](https://github.com/microsoft/node-jsonc-parser) contains the JSON parser and scanner.
|
||||
- [vscode-json-languageservice](https://github.com/microsoft/vscode-json-languageservice) contains the implementation of all features as a re-usable library.
|
||||
- [vscode-languageserver-node](https://github.com/microsoft/vscode-languageserver-node) contains the implementation of language server for NodeJS.
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@
|
|||
|
||||
## Features
|
||||
|
||||
See [Markdown in Visual Studio Code](https://code.visualstudio.com/docs/languages/markdown) to learn about the features of this extension.
|
||||
See [Markdown in Visual Studio Code](https://code.visualstudio.com/docs/languages/markdown) to learn about the features of this extension.
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@ The Markdown language server powers VS Code's built-in markdown support, providi
|
|||
|
||||
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.
|
||||
|
|
@ -31,14 +30,13 @@ This server uses the [Markdown Language Service](https://github.com/microsoft/vs
|
|||
|
||||
- [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.
|
||||
- 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
|
||||
|
|
@ -53,27 +51,27 @@ Clients may send a `workspace/didChangeConfiguration` notification to notify the
|
|||
The server supports the following settings:
|
||||
|
||||
- `markdown`
|
||||
- `suggest`
|
||||
- `paths`
|
||||
- `enabled` — Enable/disable path suggestions.
|
||||
- `suggest`
|
||||
- `paths`
|
||||
- `enabled` — Enable/disable path suggestions.
|
||||
|
||||
- `occurrencesHighlight`
|
||||
- `enabled` — Enable/disable highlighting of link occurrences.
|
||||
- `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.
|
||||
- `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
|
||||
|
||||
|
|
@ -109,7 +107,6 @@ Delete a previously created file watcher.
|
|||
|
||||
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).
|
||||
|
|
@ -132,4 +129,3 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
|
|||
Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
|
||||
Licensed under the [MIT](https://github.com/microsoft/vscode/blob/master/LICENSE.txt) License.
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,6 @@ This extension provides basic preview for images, audio and video files.
|
|||
- `.webp`
|
||||
- `.avif`
|
||||
|
||||
|
||||
### Supported audio formats
|
||||
|
||||
- `.mp3`
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ The extension supports running a script as a task from a folder in the Explorer.
|
|||
|
||||
### Others
|
||||
|
||||
The extension fetches data from https://registry.npmjs.org and https://registry.bower.io to provide auto-completion and information on hover features on npm dependencies.
|
||||
The extension fetches data from <https://registry.npmjs.org> and <https://registry.bower.io> to provide auto-completion and information on hover features on npm dependencies.
|
||||
|
||||
## Settings
|
||||
|
||||
|
|
@ -40,5 +40,3 @@ The extension fetches data from https://registry.npmjs.org and https://registry.
|
|||
- `npm.scriptExplorerAction` - The default click action: `open` or `run`, the default is `open`.
|
||||
- `npm.enableRunFromFolder` - Enable running npm scripts from the context menu of folders in Explorer, the default is `false`.
|
||||
- `npm.scriptCodeLens.enable` - Enable/disable the code lenses to run a script, the default is `false`.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@
|
|||
|
||||
## Features
|
||||
|
||||
See [PHP in Visual Studio Code](https://code.visualstudio.com/docs/languages/php) to learn about the features of this extension.
|
||||
See [PHP in Visual Studio Code](https://code.visualstudio.com/docs/languages/php) to learn about the features of this extension.
|
||||
|
|
|
|||
|
|
@ -2,5 +2,4 @@
|
|||
|
||||
**Notice:** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled.
|
||||
|
||||
Provides a very basic browser preview using an iframe embedded in a [webview](). This extension is primarily meant to be used by other extensions for showing simple web content.
|
||||
|
||||
Provides a very basic browser preview using an iframe embedded in a [webviewW](). This extension is primarily meant to be used by other extensions for showing simple web content.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
The file `TypeScript.tmLanguage.json` and `TypeScriptReact.tmLanguage.json` are derived from [TypeScript.tmLanguage](https://github.com/microsoft/TypeScript-TmLanguage/blob/master/TypeScript.tmLanguage) and [TypeScriptReact.tmLanguage](https://github.com/microsoft/TypeScript-TmLanguage/blob/master/TypeScriptReact.tmLanguage).
|
||||
|
||||
To update to the latest version:
|
||||
|
||||
- `cd extensions/typescript` and run `npm run update-grammars`
|
||||
- don't forget to run the integration tests at `./scripts/test-integration.sh`
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,5 @@
|
|||
# vscode-wasm-typescript
|
||||
|
||||
Language server host for typescript using vscode's sync-api in the browser
|
||||
|
||||
## TODOs
|
||||
|
|
@ -22,33 +23,33 @@ Language server host for typescript using vscode's sync-api in the browser
|
|||
- LATER: Turns out you can skip the existing server by depending on tsserverlibrary instead of tsserver.
|
||||
- [x] figure out a webpack-native way to generate tsserver.web.js if possible
|
||||
- [x] path rewriting is pretty loosey-goosey; likely to be incorrect some of the time
|
||||
- invert the logic from TypeScriptServiceClient.normalizedPath for requests
|
||||
- invert the function from webServer.ts for responses (maybe)
|
||||
- something with getWorkspaceRootForResource (or anything else that checks `resouce.scheme`)
|
||||
- invert the logic from TypeScriptServiceClient.normalizedPath for requests
|
||||
- invert the function from webServer.ts for responses (maybe)
|
||||
- something with getWorkspaceRootForResource (or anything else that checks `resouce.scheme`)
|
||||
- [x] put files one level down from virtual root
|
||||
- [x] fill in missing environment files like lib.dom.d.ts
|
||||
- toResource's isWeb branch *probably* knows where to find this, just need to put it in the virtual FS
|
||||
- I guess during setup in serverProcess.browser.ts.
|
||||
- Not sure whether it needs to have the data or just a fs entry.
|
||||
- Wait, I don't know how files get added to the FS normally.
|
||||
- toResource's isWeb branch *probably* knows where to find this, just need to put it in the virtual FS
|
||||
- I guess during setup in serverProcess.browser.ts.
|
||||
- Not sure whether it needs to have the data or just a fs entry.
|
||||
- Wait, I don't know how files get added to the FS normally.
|
||||
- [x] cancellation should only retain one cancellation checker
|
||||
- the one that matches the current request id
|
||||
- but that means tracking (or retrieving from tsserver) the request id (aka seq?)
|
||||
- and correctly setting/resetting it on the cancellation token too.
|
||||
- I looked at the tsserver code. I think the web case is close to the single-pipe node case,
|
||||
- the one that matches the current request id
|
||||
- but that means tracking (or retrieving from tsserver) the request id (aka seq?)
|
||||
- and correctly setting/resetting it on the cancellation token too.
|
||||
- I looked at the tsserver code. I think the web case is close to the single-pipe node case,
|
||||
so I just require that requestId is set in order to call the *current* cancellation checker.
|
||||
- Any incoming message with a cancellation checker will overwrite the current one.
|
||||
- Any incoming message with a cancellation checker will overwrite the current one.
|
||||
- [x] Cancellation code in vscode is suspiciously prototypey.
|
||||
- Specifically, it adds the vscode-wasm cancellation to original cancellation code, but should actually switch to the former for web only.
|
||||
- looks like `isWeb()` is a way to check for being on the web
|
||||
- Specifically, it adds the vscode-wasm cancellation to original cancellation code, but should actually switch to the former for web only.
|
||||
- looks like `isWeb()` is a way to check for being on the web
|
||||
- [x] create multiple watchers
|
||||
- on-demand instead of watching everything and checking on watch firing
|
||||
- on-demand instead of watching everything and checking on watch firing
|
||||
- [x] get file watching to work
|
||||
- it could *already* work, I just don't know how to test it
|
||||
- look at extensions/markdown-language-features/src/client/fileWatchingManager.ts to see if I can use that
|
||||
- later: it is OK. its main difference is that you can watch files in not-yet-created directories, and it maintains
|
||||
- it could *already* work, I just don't know how to test it
|
||||
- look at extensions/markdown-language-features/src/client/fileWatchingManager.ts to see if I can use that
|
||||
- later: it is OK. its main difference is that you can watch files in not-yet-created directories, and it maintains
|
||||
a web of directory watches that then check whether the file is eventually created.
|
||||
- even later: well, it works even though it is similar to my code.
|
||||
- even later: well, it works even though it is similar to my code.
|
||||
I'm not sure what is different.
|
||||
- [x] copy fileWatchingManager.ts to web/ ; there's no sharing code between extensions
|
||||
- [x] Find out scheme the web actually uses instead of vscode-test-web (or switch over entirely to isWeb)
|
||||
|
|
@ -106,6 +107,7 @@ Language server host for typescript using vscode's sync-api in the browser
|
|||
- so I can just redo whatever that did and it'll be fine
|
||||
|
||||
### Done
|
||||
|
||||
- [x] need to update 0.2 -> 0.7.* API (once it's working properly)
|
||||
- [x] including reshuffling the webpack hack if needed
|
||||
- [x] need to use the settings recommended by Sheetal
|
||||
|
|
@ -113,7 +115,7 @@ Language server host for typescript using vscode's sync-api in the browser
|
|||
- [x] sync-api-client says fs is rooted at memfs:/sample-folder; the protocol 'memfs:' is confusing our file parsing I think
|
||||
- [x] nothing ever seems to find tsconfig.json
|
||||
- [x] messages aren't actually coming through, just the message from the first request
|
||||
- fixed by simplifying the listener setup for now
|
||||
- fixed by simplifying the listener setup for now
|
||||
- [x] once messages work, you can probably log by postMessage({ type: 'log', body: "some logging text" })
|
||||
- [x] implement realpath, modifiedtime, resolvepath, then turn semantic mode on
|
||||
- [x] file watching implemented with saved map of filename to callback, and forwarding
|
||||
|
|
@ -125,6 +127,7 @@ Language server host for typescript using vscode's sync-api in the browser
|
|||
## Notes
|
||||
|
||||
messages received by extension AND host use paths like ^/memfs/ts-nul-authority/sample-folder/file.ts
|
||||
|
||||
- problem: pretty sure the extension doesn't know what to do with that: it's not putting down error spans in file.ts
|
||||
- question: why is the extension requesting quickinfo in that URI format? And it works! (probably because the result is a tooltip, not an in-file span)
|
||||
- problem: weird concatenations with memfs:/ in the middle
|
||||
|
|
@ -140,15 +143,14 @@ but readFile is getting called with things like memfs:/sample-folder/memfs:/type
|
|||
watchDirectory with /sample-folder/^ and directoryExists with /sample-folder/^/memfs/ts-nul-authority/sample-folder/workspaces/
|
||||
watchFile with /sample-folder/memfs:/sample-folder/memfs:/lib.es2020.full.d.ts
|
||||
|
||||
### LATER:
|
||||
### LATER
|
||||
|
||||
OK, so the paths that tsserver has look like this: ^/scheme/mount/whatever.ts
|
||||
but the paths the filesystem has look like this: scheme:/whatever.ts (not sure about 'mount', that's only when cloning from the fs)
|
||||
so you have to shave off the scheme that the host combined with the path and put on the scheme that the vfs is using.
|
||||
|
||||
### LATER 2:
|
||||
### LATER 2
|
||||
|
||||
Some commands ask for getExecutingFilePath or getCurrentDirectory and cons up a path themselves.
|
||||
This works, because URI.from({ scheme, path }) matches what the fs has in it
|
||||
Problem: In *some* messages (all?), vscode then refers to /x.ts and ^/vscode-test-web/mount/x.ts (or ^/memfs/ts-nul-authority/x.ts)
|
||||
|
||||
|
|
|
|||
|
|
@ -103,4 +103,4 @@ Pop
|
|||
* Multiple definitions and terms are possible
|
||||
* Definitions can include multiple paragraphs too
|
||||
|
||||
*[ABBR]: Markdown plus abbreviations (produces an <abbr> tag)
|
||||
*[ABBR]: Markdown plus abbreviations (produces an <abbr> tag)
|
||||
|
|
|
|||
|
|
@ -1,18 +1,17 @@
|
|||
|
||||
## vscode-dts
|
||||
# vscode-dts
|
||||
|
||||
This is the place for the stable API and for API proposals.
|
||||
|
||||
|
||||
### Consume a proposal
|
||||
## Consume a proposal
|
||||
|
||||
1. find a proposal you are interested in
|
||||
1. add its name to your extensions `package.json#enabledApiProposals` property
|
||||
1. run `npx vscode-dts dev` to download the `d.ts` files into your project
|
||||
1. don't forget that extension using proposed API cannot be published
|
||||
1. learn more here: https://code.visualstudio.com/api/advanced-topics/using-proposed-api
|
||||
1. learn more here: <https://code.visualstudio.com/api/advanced-topics/using-proposed-api>
|
||||
|
||||
### Add a new proposal
|
||||
## Add a new proposal
|
||||
|
||||
1. create a _new_ file in this directory, its name must follow this pattern `vscode.proposed.[a-zA-Z]+.d.ts`
|
||||
1. creating the proposal-file will automatically update `src/vs/workbench/services/extensions/common/extensionsApiProposals.ts` (make sure to run `yarn watch`)
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
## Contents
|
||||
|
||||
This folder contains the various test runners for VSCode. Please refer to the documentation within for how to run them:
|
||||
|
||||
* `unit`: our suite of unit tests ([README](unit/README.md))
|
||||
* `integration`: our suite of API tests ([README](integration/browser/README.md))
|
||||
* `smoke`: our suite of automated UI tests ([README](smoke/README.md))
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ All integration tests run in a browser instance as specified by the command line
|
|||
|
||||
Add the `--debug` flag to see a browser window with the tests running.
|
||||
|
||||
**Note**: you can enable verbose logging of playwright library by setting a `DEBUG` environment variable before running the tests (https://playwright.dev/docs/debug#verbose-api-logs)
|
||||
**Note**: you can enable verbose logging of playwright library by setting a `DEBUG` environment variable before running the tests (<https://playwright.dev/docs/debug#verbose-api-logs>)
|
||||
|
||||
## Debug
|
||||
|
||||
|
|
|
|||
|
|
@ -4,10 +4,10 @@ This directory contains scripts that are used to smoke test the Monaco Editor di
|
|||
|
||||
## Setup & Bundle
|
||||
|
||||
$test/monaco> yarn
|
||||
$test/monaco> yarn run bundle
|
||||
$test/monaco> yarn
|
||||
$test/monaco> yarn run bundle
|
||||
|
||||
## Compile and run tests
|
||||
|
||||
$test/monaco> yarn run compile
|
||||
$test/monaco> yarn test
|
||||
$test/monaco> yarn run compile
|
||||
$test/monaco> yarn test
|
||||
|
|
|
|||
|
|
@ -1,13 +1,15 @@
|
|||
# VS Code Smoke Tests Failures History
|
||||
|
||||
This file contains a history of smoke test failures which could be avoided if particular techniques were used in the test (e.g. binding test elements with HTML5 `data-*` attribute).
|
||||
|
||||
To better understand what can be employed in smoke test to ensure its stability, it is important to understand patterns that led to smoke test breakage. This markdown is a result of work on [this issue](https://github.com/microsoft/vscode/issues/27906).
|
||||
|
||||
# Log
|
||||
1. This following change led to the smoke test failure because DOM element's attribute `a[title]` was changed:
|
||||
[eac49a3](https://github.com/microsoft/vscode/commit/eac49a321b84cb9828430e9dcd3f34243a3480f7)
|
||||
## Log
|
||||
|
||||
This attribute was used in the smoke test to grab the contents of SCM part in status bar:
|
||||
[0aec2d6](https://github.com/microsoft/vscode/commit/0aec2d6838b5e65cc74c33b853ffbd9fa191d636)
|
||||
1. This following change led to the smoke test failure because DOM element's attribute `a[title]` was changed:
|
||||
[eac49a3](https://github.com/microsoft/vscode/commit/eac49a321b84cb9828430e9dcd3f34243a3480f7)
|
||||
|
||||
This attribute was used in the smoke test to grab the contents of SCM part in status bar:
|
||||
[0aec2d6](https://github.com/microsoft/vscode/commit/0aec2d6838b5e65cc74c33b853ffbd9fa191d636)
|
||||
|
||||
2. To be continued...
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Make sure you are on **Node v12.x**.
|
||||
|
||||
### Quick Overview
|
||||
## Quick Overview
|
||||
|
||||
```bash
|
||||
# Build extensions in the VS Code repo (if needed)
|
||||
|
|
@ -57,7 +57,7 @@ xattr -d com.apple.quarantine <path to server with web folder zip>
|
|||
- `-f PATTERN` (alias `-g PATTERN`) filters the tests to be run. You can also use pretty much any mocha argument;
|
||||
- `--headless` will run playwright in headless mode when `--web` is used.
|
||||
|
||||
**Note**: you can enable verbose logging of playwright library by setting a `DEBUG` environment variable before running the tests (https://playwright.dev/docs/debug#verbose-api-logs), for example to `pw:browser`.
|
||||
**Note**: you can enable verbose logging of playwright library by setting a `DEBUG` environment variable before running the tests (<https://playwright.dev/docs/debug#verbose-api-logs>), for example to `pw:browser`.
|
||||
|
||||
### Develop
|
||||
|
||||
|
|
|
|||
|
|
@ -33,10 +33,10 @@ Unit tests from layers `common` and `browser` are run inside `chromium`, `webkit
|
|||
|
||||
The following command will create a `coverage` folder in the `.build` folder at the root of the workspace:
|
||||
|
||||
**OS X and Linux**
|
||||
### OS X and Linux
|
||||
|
||||
./scripts/test.sh --coverage
|
||||
|
||||
**Windows**
|
||||
### Windows
|
||||
|
||||
scripts\test --coverage
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user