Skip to content

Commit d7e6103

Browse files
vinistockvinistock
authored
Restore extension README and license (#1448)
1 parent d745ee6 commit d7e6103

File tree

6 files changed

+80
-28
lines changed

6 files changed

+80
-28
lines changed

Diff for: ‎.github/workflows/publish.yml

-2
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,6 @@ jobs:
119119
120120
- name: Copy files needed for release
121121
run: |
122-
cp LICENSE.txt vscode/LICENSE.txt
123-
cp README.md vscode/README.md
124122
cp CODE_OF_CONDUCT.md vscode/CODE_OF_CONDUCT.md
125123
cp TROUBLESHOOTING.md vscode/TROUBLESHOOTING.md
126124

Diff for: ‎LICENSE.txt

-21
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
2121
THE SOFTWARE.
22-
23-
================================================================================
24-
The following files and related configuration in vscode/package.json are based
25-
on a sequence of adaptions: vscode/grammars/ruby.cson.json,
26-
vscode/grammars/erb.cson.json, vscode/languages/erb.json.
27-
28-
Copyright (c) 2016 Peng Lv
29-
Copyright (c) 2017-2019 Stafford Brunk
30-
https://github.com/rubyide/vscode-ruby
31-
32-
Released under the MIT license
33-
https://github.com/rubyide/vscode-ruby/blob/main/LICENSE.txt
34-
35-
Copyright (c) 2014 GitHub Inc.
36-
https://github.com/atom/language-ruby
37-
38-
Released under the MIT license
39-
https://github.com/atom/language-ruby/blob/master/LICENSE.md
40-
41-
https://github.com/textmate/ruby.tmbundle
42-
https://github.com/textmate/ruby.tmbundle#license

Diff for: ‎vscode/LICENSE.txt

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2022-present, Shopify Inc.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.
22+
23+
================================================================================
24+
The following files and related configuration in package.json are based on a
25+
sequence of adaptions: grammars/ruby.cson.json, grammars/erb.cson.json,
26+
languages/erb.json.
27+
28+
Copyright (c) 2016 Peng Lv
29+
Copyright (c) 2017-2019 Stafford Brunk
30+
https://github.com/rubyide/vscode-ruby
31+
32+
Released under the MIT license
33+
https://github.com/rubyide/vscode-ruby/blob/main/LICENSE.txt
34+
35+
Copyright (c) 2014 GitHub Inc.
36+
https://github.com/atom/language-ruby
37+
38+
Released under the MIT license
39+
https://github.com/atom/language-ruby/blob/master/LICENSE.md
40+
41+
https://github.com/textmate/ruby.tmbundle
42+
https://github.com/textmate/ruby.tmbundle#license

Diff for: ‎VSCODE.md renamed to ‎vscode/README.md

+35-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,37 @@
1-
# Ruby LSP in VS Code
1+
<p align="center">
2+
<img alt="Ruby LSP logo" width="200" src="icon.png" />
3+
</p>
4+
5+
# Ruby LSP
6+
7+
The Ruby LSP is an implementation of the [language server protocol](https://microsoft.github.io/language-server-protocol/)
8+
for Ruby, used to improve rich features in editors.
9+
10+
## Features
11+
12+
![Ruby LSP demo](extras/ruby_lsp_demo.gif)
13+
14+
The Ruby LSP features include
15+
16+
- Semantic highlighting
17+
- Symbol search and code outline
18+
- RuboCop errors and warnings (diagnostics)
19+
- Format on save (with RuboCop or Syntax Tree)
20+
- Format on type
21+
- Debugging support
22+
- Running and debugging tests through VS Code's UI
23+
- Go to definition for classes, modules, constants and required files
24+
- Showing documentaton on hover for classes, modules and constants
25+
- Completion for classes, modules, constants and require paths
26+
- Fuzzy search classes, modules and constants anywhere in the project and its dependencies (workspace symbol)
27+
28+
Adding method support for definition, completion, hover and workspace symbol is planned, but not yet completed.
29+
30+
See complete information about features [here](https://shopify.github.io/ruby-lsp/RubyLsp/Requests.html).
31+
32+
If you experience issues, please see the [troubleshooting
33+
guide](https://github.com/Shopify/ruby-lsp/blob/main/TROUBLESHOOTING.md).
34+
235
## Usage
336

437
Search for `Shopify.ruby-lsp` in the extensions tab and click install.
@@ -31,7 +64,7 @@ test boilerplates. Find the full list [here](https://github.com/Shopify/ruby-lsp
3164
The Ruby LSP allows disabling specific features. To do so, open the
3265
language status center right next to the language mode Ruby and select `Manage` right next to enabled features.
3366

34-
![Ruby LSP status center](vscode/extras/ruby_lsp_status_center.png)
67+
![Ruby LSP status center](extras/ruby_lsp_status_center.png)
3568

3669
It's also possible to configure with more granularity code lens and inlay hint features, see the [features
3770
documentation](https://shopify.github.io/ruby-lsp/RubyLsp/Requests.html).

Diff for: ‎vscode/src/ruby.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ export class Ruby implements RubyInterface {
223223
if (major < 3) {
224224
throw new Error(
225225
`The Ruby LSP requires Ruby 3.0 or newer to run. This project is using ${this.rubyVersion}. \
226-
[See alternatives](https://github.com/Shopify/ruby-lsp/blob/main/VSCODE.md \
226+
[See alternatives](https://github.com/Shopify/ruby-lsp/blob/main/vscode/README.md \
227227
?tab=readme-ov-file#ruby-version-requirement)`,
228228
);
229229
}

Diff for: ‎vscode/src/rubyLsp.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ export class RubyLsp {
146146
if (answer === "See the multi-root workspace docs") {
147147
vscode.env.openExternal(
148148
vscode.Uri.parse(
149-
"https://github.com/Shopify/ruby-lsp/blob/main/VSCODE.md?tab=readme-ov-file#multi-root-workspaces",
149+
"https://github.com/Shopify/ruby-lsp/blob/main/vscode/README.md?tab=readme-ov-file#multi-root-workspaces",
150150
),
151151
);
152152
}
@@ -204,7 +204,7 @@ export class RubyLsp {
204204
vscode.commands.registerCommand(Command.FormatterHelp, () => {
205205
vscode.env.openExternal(
206206
vscode.Uri.parse(
207-
"https://github.com/Shopify/ruby-lsp/blob/main/VSCODE.md#formatting",
207+
"https://github.com/Shopify/ruby-lsp/blob/main/vscode/README.md#formatting",
208208
),
209209
);
210210
}),

0 commit comments

Comments
 (0)