Skip to content

Commit 22ce969

Browse files
Cleaned Extensions README files (conwnet#190)
* Cleaned extensions/dart-web README file Removed Debugging, Running, etc. Documentation * Cleaned extensions/julia-web README file * Cleaned extensions/elm-web README file * Cleaned extensions/kotlin-web README file * Cleaned extensions/ocaml-web README file * Cleaned extensions/svelte-web README file * Cleaned extensions/vetur-web README file * Cleaned extensions/vlang-web README file
1 parent 4f44d47 commit 22ce969

8 files changed

Lines changed: 43 additions & 616 deletions

File tree

extensions/dart-web/README.md

Lines changed: 4 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,12 @@
77

88
# At present only languages features is reserved
99

10+
# I have deleted some files and only reserved the necessary code
11+
1012
## Introduction
1113

1214
Dart Code extends [VS Code](https://code.visualstudio.com/) with support for the
13-
[Dart](https://www.dartlang.org/) programming language, and provides tools for
14-
effectively editing, refactoring, running, and reloading [Flutter](https://flutter.dev/)
15+
[Dart](https://www.dartlang.org/) programming language and for [Flutter](https://flutter.dev/)
1516
mobile apps, and [AngularDart](https://angulardart.org) web apps.
1617

1718
## Installation
@@ -20,65 +21,10 @@ Dart Code can be [installed from the Visual Studio Code Marketplace](https://mar
2021

2122
## Features
2223

23-
- Edit and Debug Flutter mobile apps (launch using `F5` or the `Debug` menu)
24-
- Edit and Debug Dart command line apps (launch using `F5` or the `Debug` menu)
25-
- [Automatic hot reloads for Flutter](https://dartcode.org/docs/settings/#dartflutterhotreloadonsave)
26-
- [Refactorings and Code fixes (lightbulb)](https://dartcode.org/docs/refactorings-and-code-fixes/)
27-
- [Quickly switch between devices for Flutter](https://dartcode.org/docs/quickly-switching-between-flutter-devices/)
28-
- [Flutter Doctor command](https://dartcode.org/docs/commands/#flutter-run-flutter-doctor)
29-
- [Flutter Get Packages command](https://dartcode.org/docs/commands/#flutter-get-packages)
30-
- [Flutter Upgrade Packages command](https://dartcode.org/docs/commands/#flutter-upgrade-packages)
31-
- [Automatically gets packages when `pubspec.yaml` is saved](https://dartcode.org/docs/settings/#dartrunpubgetonpubspecchanges)
32-
- [Automatically finds SDKs from `PATH`](https://dartcode.org/docs/configuring-path-and-environment-variables/)
33-
- [Notification of new stable Dart SDK releases](https://dartcode.org/docs/settings/#dartcheckforsdkupdates)
34-
- [Sort Members command](https://dartcode.org/docs/commands/#dart-sort-members)
35-
- Support for debugging "just my code" or SDK/libraries too ([`dart.debugSdkLibraries`](https://dartcode.org/docs/settings/#dartdebugsdklibraries) and [`dart.debugExternalLibraries`](https://dartcode.org/docs/settings/#dartdebugexternallibraries))
36-
- [Prompts to get packages when out of date](https://dartcode.org/docs/settings/#dartprompttogetpackages)
3724
- Syntax highlighting
38-
- Code completion
39-
- Snippets
40-
- Realtime errors/warnings/TODOs
41-
- Documentation in hovers/tooltips
42-
- Go to Definition
43-
- Find References
44-
- Rename refactoring
45-
- Format document
46-
- Support for format-on-save (`editor.formatOnSave`)
47-
- Support for format-on-type (`editor.formatOnType`)
4825
- Workspace symbol search
4926
- Document symbol search
50-
- [Organize Imports command](https://dartcode.org/docs/commands/#dart-organize-imports)
51-
- [Pub Get Packages command](https://dartcode.org/docs/commands/#pub-get-packages)
52-
- [Pub Upgrade Packages command](https://dartcode.org/docs/commands/#pub-upgrade-packages)
53-
- [Type Hierarchy](https://dartcode.org/docs/commands/#dart-show-type-hierarchy)
54-
55-
## Extension Settings
56-
57-
A full list of settings is [available here](https://dartcode.org/docs/settings/).
58-
59-
## Frequently Asked Questions
60-
61-
A list of frequently asked questions is [available here](https://dartcode.org/faq/).
62-
63-
## Key Bindings
64-
65-
A list of useful key bindings is [available here](https://dartcode.org/docs/key-bindings/).
66-
67-
## Refactorings and Code Fixes
68-
69-
A full list of supported refactors is [available here](https://dartcode.org/docs/refactorings-and-code-fixes/).
70-
71-
## Analytics
72-
73-
This extension reports some analytics such as:
74-
75-
- Extension load and analysis times
76-
- Whether you have disabled some settings (such as showing TODOs in Problems Window or Closing Labels)
77-
- Frequency of use of features like Hot Reload, Hot Restart and Open Observatory
78-
- Crashes in the Dart analysis server
79-
- Platform and Dart/Flutter SDK versions
80-
81-
Reporting can be disabled via the [`dart.allowAnalytics` setting](https://dartcode.org/docs/settings/#dartallowanalytics).
27+
- Snippets
8228

8329
## Release Notes
8430

extensions/elm-web/README.md

Lines changed: 7 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -1,103 +1,18 @@
1+
# This extension is a fork from [elm-language-client-vscode](https://github.com/elm-tooling/elm-language-client-vscode) for github1s.
2+
3+
# At present only languages features is reserved
4+
5+
# I have deleted some files and only reserved the necessary code
6+
17
# Elm Plugin for Visual Studio Code (VSCode)
28

39
[![Version](https://vsmarketplacebadge.apphb.com/version/Elmtooling.elm-ls-vscode.svg)](https://marketplace.visualstudio.com/items?itemName=Elmtooling.elm-ls-vscode)
410
[![Downloads](https://vsmarketplacebadge.apphb.com/downloads-short/Elmtooling.elm-ls-vscode.svg)](https://marketplace.visualstudio.com/items?itemName=Elmtooling.elm-ls-vscode)
511
[![Rating](https://vsmarketplacebadge.apphb.com/rating-star/Elmtooling.elm-ls-vscode.svg)](https://marketplace.visualstudio.com/items?itemName=Elmtooling.elm-ls-vscode)
612
![Compile](https://github.com/elm-tooling/elm-language-client-vscode/workflows/Compile/badge.svg)
713

8-
# This extension is a fork from [elm-language-client-vscode](https://github.com/elm-tooling/elm-language-client-vscode) for github1s.
9-
1014
Supports elm 0.19 and up
1115

12-
## Install
13-
14-
1. Install VSCode from [here](https://code.visualstudio.com/)
15-
2. Follow [this link](https://marketplace.visualstudio.com/items?itemName=Elmtooling.elm-ls-vscode) to install the plugin
16-
3. Make sure you have [nodejs](https://nodejs.org/) and therefore npm installed
17-
4. Make sure you have [Elm](https://guide.elm-lang.org/install/elm.html) installed
18-
5. Install elm-test and elm-format by running `npm install -g elm-test elm-format` in a terminal
19-
2016
## Highlighted Features
2117

22-
- Errors and informations when changing code and when saving (Control + S)
23-
- Format on save (Control + S)
24-
- Suggests completions and snippets (Control + Space)
25-
26-
## Additional Features
27-
28-
- Lists all references to a type alias, module, custom type or function (Alt + Shift + F12)
29-
- Jump to the definition of a type alias, module, custom type or function
30-
- Shows type annotations and documentation on hover for type alia, module, custom type or function
31-
- Rename a type alias, module, custom type or function (F2)
32-
- Browse file by symbols (Control + Shift + O)
33-
- Browse workspace by symbols (Control + Shift + R)
34-
- Codelenses show how many times you calling a function and if it's exposed or not
35-
- Code folding
36-
- Type inference
37-
- Some more
38-
39-
## Extension Settings
40-
41-
This extension contributes the following settings:
42-
43-
- `elmLS.trace.server`: Enable/disable trace logging of client and server communication
44-
- `elmLS.elmPath`: The path to your elm executable.
45-
- `elmLS.elmFormatPath`: The path to your elm-format executable.
46-
- `elmLS.elmTestPath`: The path to your elm-test executable.
47-
- `elmLS.disableElmLSDiagnostics`: Disable linting diagnostics from the language server.
48-
- `elmLS.skipInstallPackageConfirmation`: Skip confirmation for the Install Package code action.
49-
- `elmLS.onlyUpdateDiagnosticsOnSave`: Only update compiler diagnostics on save, not on document change.
50-
51-
## Configuration
52-
53-
Create an [elm-tooling.json](https://github.com/lydell/elm-tooling.json) file next to your `elm.json` to configure your project.
54-
55-
Currently there’s just one thing that you can configure: entrypoints. We run `elm make` to get errors. Without this `elm make` is run on the current file only. To get errors for the entire project you can specify your entrypoint files – basically, those with `main =` in them. Then the language server will run `elm make` on those instead.
56-
57-
Example:
58-
59-
```json
60-
{
61-
"entrypoints": ["./src/Main.elm"]
62-
}
63-
```
64-
65-
The entrypoints are relative to the directory where your `elm.json` and `elm-tooling.json` is and must start with `./`.
66-
67-
Check out the [elm-tooling](https://github.com/lydell/elm-tooling.json/tree/main/cli#readme) CLI for creating and validating your `elm-tooling.json`!
68-
69-
## FAQ
70-
71-
- How to get a logfile?
72-
73-
- `F1` -> Type `Output: Focus on Output View` -> In the now open panel, use the drop down on the right to choose `Elm (your project name)`
74-
75-
- Most features don't seem to work for me?
76-
77-
- This tool needs a valid elm project, please check if you have an `elm.json`. You can easily initialize your project with `elm init`. If it still does work, please try if you get the same behavior with the [elm-spa-example](https://github.com/rtfeldman/elm-spa-example/).
78-
79-
- What's the relation to the language server?
80-
81-
- This [vscode extension](https://marketplace.visualstudio.com/items?itemName=Elmtooling.elm-ls-vscode) is including the [elm-language-server](https://github.com/elm-tooling/elm-language-server) which enables most of the used features.
82-
83-
- Why do I need to install `elm`, `elm-test` and `elm-format`?
84-
85-
- You will need to install `elm` and `elm-test` to get all diagnostics and `elm-format` for formatting. If your setup fails to find the global installations of those, you can use the settings panel in VSCode to set the paths to the executable manually. Alternatively you can also just install these to your local npm `package.json`.
86-
87-
- I don't like the inserted lines for "X references" (CodeLenses)
88-
89-
- You can configure VSCode to not show them, just look for "Editor: Code Lens" in your settings.
90-
91-
- I'm using glsl and the extension is not helpful
92-
93-
- You need to additionally install [vscode-glsllint](https://github.com/hsimpson/vscode-glsllint)
94-
95-
## Contributing / Debugging
96-
97-
```shell
98-
git clone --recursive git@github.com:elm-tooling/elm-language-client-vscode.git
99-
cd elm-language-client-vscode
100-
npm install
101-
```
102-
103-
Open VSCode with this project (`code .`) and press `F5` to start debugging the plugin.
18+
- Syntax Highlighting

extensions/julia-web/README.md

Lines changed: 4 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# This extension is a fork from [julia-vscode](https://github.com/julia-vscode/julia-vscode) for github1s.
22

3+
# At present only languages features is reserved
4+
5+
# I have deleted some files and only reserved the necessary code
6+
37
# Julia
48

59
[![Build Status](https://dev.azure.com/julia-vscode/julia-vscode/_apis/build/status/julia-vscode.julia-vscode?branchName=master)](https://dev.azure.com/julia-vscode/julia-vscode/_build/latest?definitionId=1&branchName=master)
@@ -23,39 +27,14 @@ This [VS Code](https://code.visualstudio.com) extension provides support for the
2327
search box, then select the extension named `Julia` and click the install button.
2428
You might have to restart VS Code after this step.
2529

26-
### Configure the Julia extension
27-
28-
If you have installed Julia into a standard location on Mac or Windows, or
29-
if the Julia binary is on your `PATH`, the Julia VS Code extension should
30-
automatically find your Julia installation and you should not need to
31-
configure anything.
32-
33-
If the extension does not find your Julia installation automatically, or
34-
if you want to use a different Julia installation than the default one,
35-
you can set the `julia.executablePath` to point to the Julia executable
36-
that the extension should use. In that case the
37-
extension will always use that version of Julia. To edit your configuration
38-
settings, execute the `Preferences: Open User Settings` command (you can
39-
also access it via the menu `File->Preferences->Settings`), and
40-
then make sure your user settings include the `julia.executablePath`
41-
setting. The format of the string should follow your platform specific
42-
conventions, and be aware that the backlash `\` is the escape character
43-
in JSON, so you need to use `\\` as the path separator character on Windows.
4430

4531
## Features
4632

4733
The extension currently provides:
4834

4935
- syntax highlighting
50-
- [snippets: latex and user-shared snippets](https://github.com/julia-vscode/julia-vscode/wiki/Snippets)
51-
- [Julia specific commands](https://github.com/julia-vscode/julia-vscode/wiki/Commands)
52-
- [integrated Julia REPL](https://github.com/julia-vscode/julia-vscode/wiki/REPL)
53-
- [code completion](https://github.com/julia-vscode/julia-vscode/wiki/IntelliSense)
54-
- [hover help](https://github.com/julia-vscode/julia-vscode/wiki/Information#hover-help)
5536
- [a linter](https://github.com/julia-vscode/julia-vscode/wiki/Information#linter)
5637
- [code navigation](https://github.com/julia-vscode/julia-vscode/wiki/Navigation)
57-
- tasks for running tests, builds, benchmarks and build documentation
58-
- a debugger
5938
- a plot gallery
6039
- a grid viewer for tabular data
6140
- integrated support for Weave.jl

extensions/kotlin-web/README.md

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,22 @@
1-
[![](https://vsmarketplacebadge.apphb.com/version-short/mathiasfrohlich.Kotlin.svg)](https://marketplace.visualstudio.com/items?itemName=mathiasfrohlich.Kotlin)
2-
[![](https://vsmarketplacebadge.apphb.com/installs-short/mathiasfrohlich.Kotlin.svg)](https://marketplace.visualstudio.com/items?itemName=mathiasfrohlich.Kotlin)
3-
[![](https://vsmarketplacebadge.apphb.com/rating-short/mathiasfrohlich.Kotlin.svg)](https://marketplace.visualstudio.com/items?itemName=mathiasfrohlich.Kotlin)
4-
51
# This extension is a fork from [vscode-kotlin](https://github.com/mathiasfrohlich/vscode-kotlin) for github1s
62

73
# At present only languages features is reserved
84

95
# I have deleted some files and only reserved the necessary code
106

7+
[![](https://vsmarketplacebadge.apphb.com/version-short/mathiasfrohlich.Kotlin.svg)](https://marketplace.visualstudio.com/items?itemName=mathiasfrohlich.Kotlin)
8+
[![](https://vsmarketplacebadge.apphb.com/installs-short/mathiasfrohlich.Kotlin.svg)](https://marketplace.visualstudio.com/items?itemName=mathiasfrohlich.Kotlin)
9+
[![](https://vsmarketplacebadge.apphb.com/rating-short/mathiasfrohlich.Kotlin.svg)](https://marketplace.visualstudio.com/items?itemName=mathiasfrohlich.Kotlin)
10+
1111
# Kotlin Language
1212

1313
Syntax support for the Kotlin programming language.
14-
This extension adds basic features to help make writing Kotlin much more pleasant in VSCode
14+
This extension adds basic features to help make reading Kotlin much more pleasant in VSCode
1515

1616
## Features
1717

1818
- Syntax highlighting
1919
- Code snippets
20-
- Region code folding
21-
22-
## Installation
23-
24-
You can install the plugin by searching for [Kotlin Language extension](https://marketplace.visualstudio.com/items?itemName=mathiasfrohlich.Kotlin) in the extensions market place, or by entering
25-
26-
```
27-
ext install kotlin language
28-
```
29-
30-
in to the command palette.
3120

3221
## Contributing
3322

extensions/ocaml-web/README.md

Lines changed: 6 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,16 @@
1-
# VSCode OCaml Platform
2-
3-
[![Main workflow](https://img.shields.io/github/workflow/status/ocamllabs/vscode-ocaml-platform/Main%20workflow?branch=master)](https://github.com/ocamllabs/vscode-ocaml-platform/actions?query=workflow%3A%22Main+workflow%22+branch%3Amaster)
4-
51
# This extension is a fork from [vscode-ocaml-platform](https://github.com/ocamllabs/vscode-ocaml-platform) for github1s.
62

7-
Visual Studio Code extension for OCaml and relevant tools.
8-
9-
_Please report any bugs you encounter._
10-
11-
## Quick start
12-
13-
1. Install this extension from
14-
[the VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=ocamllabs.ocaml-platform)
15-
(or by entering `ext install ocamllabs.ocaml-platform` at the command palette
16-
<kbd>Ctrl</kbd>+<kbd>P</kbd> (<kbd>Cmd</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> on
17-
MacOS)
18-
2. Open a OCaml/ReasonML project (`File > Add Folder to Workspace...`)
19-
3. Install [OCaml-LSP](https://github.com/ocaml/ocaml-lsp) with
20-
[opam](https://github.com/ocaml/opam) or [esy](https://github.com/esy/esy).
21-
E.g. `opam install ocaml-lsp-server`
22-
23-
### Windows
24-
25-
Install [OCaml for Windows](https://fdopen.github.io/opam-repository-mingw/) and
26-
make sure the `ocaml-env` program is accessible on the PATH (`ocaml-env` is in
27-
the `usr/local/bin` folder relative to the installation directory).
28-
29-
### ReScript / BuckleScript
30-
31-
The new ReScript syntax (`res` and `resi` files) is not supported, you should
32-
use [rescript-vscode](https://github.com/rescript-lang/rescript-vscode) instead.
33-
34-
ReasonML, as an alternative syntax for OCaml, is supported out-of-the-box, as
35-
long as `reason` is installed in your environment.
36-
37-
If you're looking for a way to use OCaml or ReasonML syntax in a ReScript
38-
project, you'll need to install `ocaml-lsp` in your environment. We recommend
39-
using Esy for this:
3+
# At present only languages features is reserved
404

41-
1. Install esy
5+
# I have deleted some files and only reserved the necessary code
426

43-
```bash
44-
npm install esy --global
45-
```
46-
47-
2. Add `esy.json` to the project root with following content:
7+
# VSCode OCaml Platform
488

49-
```json
50-
{
51-
"dependencies": {
52-
"@opam/ocaml-lsp-server": "*",
53-
"@opam/ocamlfind-secondary": "*",
54-
"@opam/reason": "*",
55-
"ocaml": "4.6.x"
56-
}
57-
}
58-
```
9+
[![Main workflow](https://img.shields.io/github/workflow/status/ocamllabs/vscode-ocaml-platform/Main%20workflow?branch=master)](https://github.com/ocamllabs/vscode-ocaml-platform/actions?query=workflow%3A%22Main+workflow%22+branch%3Amaster)
5910

60-
3. Install and build packages
11+
Visual Studio Code extension for OCaml and relevant tools.
6112

62-
```bash
63-
esy
64-
```
13+
_Please report any bugs you encounter._
6514

6615
## Features
6716

@@ -87,42 +36,3 @@ esy
8736
- OCamllex
8837
- Task Provider
8938
- Dune
90-
91-
## Configuration
92-
93-
This extension provides options in VSCode's configuration settings. You can find
94-
the settings under `File > Preferences > Settings`.
95-
96-
| Name | Description | Default |
97-
| ---------------------------------- | ------------------------------------------------------------------------------------------------------- | ------- |
98-
| `ocaml.sandbox` | Determines where to find the sandbox for a given project | `null` |
99-
| `ocaml.dune.autoDetect` | Controls whether dune tasks should be automatically detected. | `true` |
100-
| `ocaml.trace.server` | Controls the logging output of the language server. Valid settings are `off`, `messages`, or `verbose`. | `off` |
101-
| `ocaml.useOcamlEnv` | Controls whether to use ocaml-env for opam commands from OCaml for Windows. | `true` |
102-
| `ocaml.terminal.shell.linux` | The path of the shell that the sandbox terminal uses on Linux | `null` |
103-
| `ocaml.terminal.shell.osx` | The path of the shell that the sandbox terminal uses on macOS | `null` |
104-
| `ocaml.terminal.shell.windows` | The path of the shell that the sandbox terminal uses on Windows | `null` |
105-
| `ocaml.terminal.shellArgs.linux` | The command line arguments that the sandbox terminal uses on Linux | `null` |
106-
| `ocaml.terminal.shellArgs.osx` | The command line arguments that the sandbox terminal uses on macOS | `null` |
107-
| `ocaml.terminal.shellArgs.windows` | The command line arguments that the sandbox terminal uses on Window | `null` |
108-
109-
If `ocaml.terminal.shell.*` or `ocaml.terminal.shellArgs.*` is `null`, the
110-
configured VSCode shell and shell arguments will be used instead.
111-
112-
## Commands
113-
114-
You can execute it by entering the following command at the command palette
115-
<kbd>Ctrl</kbd>+<kbd>P</kbd> (<kbd>Cmd</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> on
116-
MacOS).
117-
118-
| Name | Description | Keyboard Shortcuts | Menu Contents |
119-
| ---------------------------- | ------------------------------------------- | ------------------ | ------------- |
120-
| `ocaml.select-sandbox` | Select sandbox for this workspace | | |
121-
| `ocaml.server.restart` | Restart language server | | |
122-
| `ocaml.open-terminal` | Open a terminal (current sandbox) | | |
123-
| `ocaml.open-terminal-select` | Open a terminal (select a sandbox) | | |
124-
| `ocaml.current-dune-file` | Open Dune File (located in the same folder) | | |
125-
126-
## Requirements
127-
128-
- [ocaml/ocaml-lsp](https://github.com/ocaml/ocaml-lsp)

0 commit comments

Comments
 (0)