@ripple-ts/language-server 0.2.162 → 0.2.164

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +65 -11
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # ripple-language-server
1
+ # @ripple-ts/language-server
2
2
 
3
3
  Language Server Protocol (LSP) implementation for Ripple. This package provides language intelligence features for
4
4
  Ripple files and can be integrated into any editor that supports LSP.
@@ -15,12 +15,12 @@ Ripple files and can be integrated into any editor that supports LSP.
15
15
  ## Installation
16
16
 
17
17
  ```bash
18
- npm install ripple-language-server -g
18
+ npm install @ripple-ts/language-server -g
19
19
  ```
20
20
 
21
- ### Editor Integration
21
+ ## Editor Integration
22
22
 
23
- This language server can be integrated into any editor that supports LSP:
23
+ This language server can be integrated into any editor that supports LSP. There are also specialized plugins for popular editors.
24
24
 
25
25
  #### VS Code
26
26
 
@@ -29,15 +29,69 @@ It uses this language server internally.
29
29
 
30
30
  #### WebStorm/IntelliJ
31
31
 
32
- 1. Install the [LSP4IJ plugin](https://plugins.jetbrains.com/plugin/23257-lsp4ij).
33
- 2. Add a new language server in it
34
- 3. Specify `ripple-language-server --stdio` as the command in it.
35
- 4. Go to `Mappings` —> `File name patterns` and add a new value with `File name patterns` set to `*.ripple` and `Language Id` set to `ripple.
32
+ 1. Install the language server:
33
+ ```bash
34
+ npm install @ripple-ts/language-server -g
35
+ ```
36
+ 2. Install the [LSP4IJ plugin](https://plugins.jetbrains.com/plugin/23257-lsp4ij).
37
+ 3. Add a new language server in it
38
+ 4. Specify `ripple-language-server --stdio` as the command in it.
39
+ 5. Go to `Mappings` —> `File name patterns` and add a new value with `File name patterns` set to `*.ripple` and `Language Id` set to `ripple.
36
40
 
37
- #### Neovim
41
+ #### Neovim (v0.11+)
38
42
 
39
- TODO Write instructions
43
+ Use the official plugin.
44
+
45
+ 1. Install [`nvim-treesitter`](https://github.com/nvim-treesitter/nvim-treesitter).
46
+ 2. Install the plugin.
47
+
48
+ <details>
49
+ <summary>with lazy.nvim</summary>
50
+
51
+ ```lua
52
+ {
53
+ "Ripple-TS/ripple",
54
+ dir = "packages/nvim-plugin",
55
+ config = true,
56
+ }
57
+ ```
58
+
59
+ </details>
60
+
61
+ If you're using another plugin manager and wish to share installation instructions, please consider opening a PR.
40
62
 
41
63
  #### Sublime Text
42
64
 
43
- TODO Write instructions
65
+ Until the plugin lands on Package Control you need to install it from the packaged release:
66
+
67
+ 1. Make sure [Package Control](https://packagecontrol.io/installation) is installed, then install the [LSP](https://packagecontrol.io/packages/LSP) package (`Tools → Command Palette… → Package Control: Install Package → LSP`).
68
+ 2. Clone this repository.
69
+ 3. Go into `packages/sublime-text-plugin/` directory and run:
70
+ ```bash
71
+ npm run build
72
+ ```
73
+ This will create a `Ripple.sublime-package` file in the same directory.
74
+ 4. In Sublime Text, open `Preferences → Browse Packages…`, go up one level, and open the `Installed Packages/` directory.
75
+ 5. Copy the `Ripple.sublime-package` file into `Installed Packages/` and restart Sublime Text.
76
+
77
+ Diagnostics, completions, and other features should work in `.ripple` files now.
78
+
79
+ ## Standalone Usage
80
+
81
+ You can use the language server in any other editor that supports LSP. You can install it globally:
82
+
83
+ ```bash
84
+ npm install -g @ripple-ts/language-server
85
+ ```
86
+
87
+ Then run the server with:
88
+
89
+ ```bash
90
+ ripple-language-server --stdio
91
+ ```
92
+
93
+ Or you can run it via `npx` without installing:
94
+
95
+ ```bash
96
+ npx @ripple-ts/language-server --stdio
97
+ ```
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@ripple-ts/language-server",
3
- "version": "0.2.162",
3
+ "version": "0.2.164",
4
4
  "description": "Language Server Protocol implementation for Ripple",
5
5
  "main": "index.js",
6
6
  "bin": {
7
- "@ripple-ts/language-server": "bin/language-server.js"
7
+ "ripple-language-server": "bin/language-server.js"
8
8
  },
9
9
  "author": "Dominic Gannaway",
10
10
  "license": "MIT",
@@ -18,7 +18,7 @@
18
18
  "volar-service-typescript": "0.0.65",
19
19
  "vscode-languageserver-textdocument": "^1.0.12",
20
20
  "vscode-uri": "^3.1.0",
21
- "@ripple-ts/typescript-plugin": "0.2.162"
21
+ "@ripple-ts/typescript-plugin": "0.2.164"
22
22
  },
23
23
  "peerDependencies": {
24
24
  "typescript": "^5.9.2"