Standardize readme across built-in extensions #54098
This commit is contained in:
parent
9e04481439
commit
f89c16c04c
11 changed files with 101 additions and 10 deletions
|
@ -1,6 +1,15 @@
|
|||
# CSS Language Features
|
||||
# Language Features for CSS, SCSS and LESS files.
|
||||
|
||||
This extension offers CSS/SCSS/Less support in VS Code.
|
||||
**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled.
|
||||
|
||||
## Features
|
||||
|
||||
This extension provides rich language support to CSS/SCSS/LESS files.
|
||||
- auto-completion
|
||||
- linting
|
||||
- diagnostics
|
||||
- extra information on hover
|
||||
- navigation to definition and references
|
||||
|
||||
## Development
|
||||
|
||||
|
@ -19,7 +28,9 @@ This extension offers CSS/SCSS/Less support in VS Code.
|
|||
|
||||
### Contribute to vscode-css-languageservice
|
||||
|
||||
[Microsoft/vscode-css-languageservice](https://github.com/Microsoft/vscode-css-languageservice) contains the language smarts for CSS/SCSS/Less, and this extension wraps the service into a Language Server for VS Code. If you want to fix CSS/SCSS/Less issues or make improvements, you should make changes at [Microsoft/vscode-css-languageservice](https://github.com/Microsoft/vscode-css-languageservice).
|
||||
[Microsoft/vscode-css-languageservice](https://github.com/Microsoft/vscode-css-languageservice) contains the language smarts for CSS/SCSS/Less.
|
||||
This extension wraps the css language service into a Language Server for VS Code.
|
||||
If you want to fix CSS/SCSS/Less issues or make improvements, you should make changes at [Microsoft/vscode-css-languageservice](https://github.com/Microsoft/vscode-css-languageservice).
|
||||
|
||||
However, within this extension, you can run a development version of `vscode-css-languageservice` to debug code or test language features interactively:
|
||||
|
||||
|
|
|
@ -1,5 +1,7 @@
|
|||
# Emmet integration in Visual Studio Code
|
||||
|
||||
**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled.
|
||||
|
||||
## Features
|
||||
|
||||
See [Emmet in Visual Studio Code](https://code.visualstudio.com/docs/editor/emmet)
|
||||
|
|
|
@ -1,2 +1,7 @@
|
|||
# Git integration for Visual Studio Code
|
||||
|
||||
**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled.
|
||||
|
||||
## Features
|
||||
|
||||
Read [Git support in VS Code](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support) to learn about features of this extension.
|
|
@ -1,6 +1,8 @@
|
|||
# Grunt - The JavaScript Task Runner
|
||||
|
||||
**Notice** This is a an extension that is bundled with Visual Studio Code.
|
||||
**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled.
|
||||
|
||||
## Features
|
||||
|
||||
This extension supports running [Grunt](https://gruntjs.com/) tasks defined in a `gruntfile.js` file as [VS Code tasks](https://code.visualstudio.com/docs/editor/tasks). Grunt tasks with the name 'build', 'compile', or 'watch' are treated as build tasks.
|
||||
|
||||
|
|
|
@ -1,6 +1,8 @@
|
|||
# Gulp - Automate and enhance your workflow
|
||||
|
||||
**Notice** This is a an extension that is bundled with Visual Studio Code.
|
||||
**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled.
|
||||
|
||||
## Features
|
||||
|
||||
This extension supports running [Gulp](https://gulpjs.com/) tasks defined in a `gulpfile.{js,ts}` file as [VS Code tasks](https://code.visualstudio.com/docs/editor/tasks). Gulp tasks with the name 'build', 'compile', or 'watch' are treated as build tasks.
|
||||
|
||||
|
|
51
extensions/html-language-features/README.md
Normal file
51
extensions/html-language-features/README.md
Normal file
|
@ -0,0 +1,51 @@
|
|||
# Language Features for HTML.
|
||||
|
||||
**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled.
|
||||
|
||||
## Features
|
||||
|
||||
This extension provides rich language support to HTML files.
|
||||
- auto-completion
|
||||
- linting
|
||||
- diagnostics
|
||||
- extra information on hover
|
||||
- navigation to definition and references
|
||||
- formatting
|
||||
|
||||
## Development
|
||||
|
||||
- Clone [Microsoft/vscode](https://github.com/microsoft/vscode)
|
||||
- Run `yarn` at `/`, this will install
|
||||
- Dependencies for `/extension/html-language-features/`
|
||||
- Dependencies for `/extension/html-language-features/server/`
|
||||
- devDependencies such as `gulp`
|
||||
- Open `/extensions/html-language-features/` as the workspace in VS Code
|
||||
- Run the [`Launch Extension`](https://github.com/Microsoft/vscode/blob/master/extensions/html-language-features/.vscode/launch.json) debug target in the Debug View. This will:
|
||||
- Launch the `preLaunchTask` task to compile the extension
|
||||
- Launch a new VS Code instance with the `html-language-features` extension loaded
|
||||
- You should see a notification saying the development version of `html-language-features` overwrites the bundled version of `html-language-features`
|
||||
- Test the behavior of this extension by editing html files
|
||||
- Run `Reload Window` command in the launched instance to reload the extension
|
||||
|
||||
### Contribute to vscode-html-languageservice
|
||||
|
||||
[Microsoft/vscode-html-languageservice](https://github.com/Microsoft/vscode-html-languageservice) contains the language smarts for html.
|
||||
This extension wraps the html language service into a Language Server for VS Code.
|
||||
If you want to fix html issues or make improvements, you should make changes at [Microsoft/vscode-html-languageservice](https://github.com/Microsoft/vscode-html-languageservice).
|
||||
|
||||
However, within this extension, you can run a development version of `vscode-html-languageservice` to debug code or test language features interactively:
|
||||
|
||||
#### Linking `vscode-html-languageservice` in `html-language-features/server/`
|
||||
|
||||
- Clone [Microsoft/vscode-html-languageservice](https://github.com/Microsoft/vscode-html-languageservice)
|
||||
- Run `yarn` in `vscode-html-languageservice`
|
||||
- Run `yarn link` in `vscode-html-languageservice`. This will compile and link `vscode-html-languageservice`
|
||||
- In `html-language-features/server/`, run `npm link vscode-html-languageservice`
|
||||
|
||||
#### Testing the development version of `vscode-html-languageservice`
|
||||
|
||||
- Open both `vscode-html-languageservice` and this extension in a single workspace with [multi-root workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces) feature
|
||||
- Run `yarn watch` at `html-languagefeatures/server/` to recompile this extension with the linked version of `vscode-html-languageservice`
|
||||
- Make some changes in `vscode-html-languageservice`
|
||||
- Now when you run `Launch Extension` debug target, the launched instance will use your development version of `vscode-html-languageservice`. You can interactively test the language features.
|
||||
- You can also run the `Debug Extension and Language Server` debug target, which will launch the extension and attach the debugger to the language server. After successful attach, you should be able to hit breakpoints in both `vscode-html-languageservice` and `html-language-features/server/`
|
|
@ -1,6 +1,8 @@
|
|||
# Jake - JavaScript build tool
|
||||
|
||||
**Notice** This is a an extension that is bundled with Visual Studio Code.
|
||||
**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled.
|
||||
|
||||
## Features
|
||||
|
||||
This extension supports running [Jake](http://jakejs.com/) tasks defined in a `Jakefile.js` file as [VS Code tasks](https://code.visualstudio.com/docs/editor/tasks). Jake tasks with the name 'build', 'compile', or 'watch' are treated as build tasks.
|
||||
|
||||
|
|
11
extensions/json-language-features/README.md
Normal file
11
extensions/json-language-features/README.md
Normal file
|
@ -0,0 +1,11 @@
|
|||
# Language Features for JSON files.
|
||||
|
||||
**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled.
|
||||
|
||||
## Features
|
||||
|
||||
This extension provides language support to JSON files.
|
||||
- auto-completion
|
||||
- diagnostics
|
||||
- extra information on hover
|
||||
- formatting
|
|
@ -1,5 +1,7 @@
|
|||
# Merge Conflict
|
||||
|
||||
See [documentation](https://code.visualstudio.com/docs/editor/versioncontrol#_merge-conflicts).
|
||||
**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled.
|
||||
|
||||
**Notice** This is a an extension that is bundled with Visual Studio Code.
|
||||
## Features
|
||||
|
||||
Read [Merge Conflicts in VS Code](https://code.visualstudio.com/docs/editor/versioncontrol#_merge-conflicts) to learn about features of this extension.
|
||||
|
|
|
@ -1,6 +1,8 @@
|
|||
# Node npm
|
||||
|
||||
**Notice** This is a an extension that is bundled with Visual Studio Code.
|
||||
**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled.
|
||||
|
||||
## Features
|
||||
|
||||
This extension supports running npm scripts defined in the `package.json` as [tasks](https://code.visualstudio.com/docs/editor/tasks). Scripts with the name 'build', 'compile', or 'watch'
|
||||
are treated as build tasks.
|
||||
|
|
|
@ -233,7 +233,8 @@ class Extension implements IExtension {
|
|||
|
||||
if (this.type === LocalExtensionType.System) {
|
||||
return TPromise.as(`# ${this.displayName || this.name}
|
||||
**Notice** This is a an extension that is bundled with Visual Studio Code.
|
||||
**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled.
|
||||
## Features
|
||||
${this.description}
|
||||
`);
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue