openplanet-lsp 0.3.0 → 0.3.1

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 +70 -19
  2. package/package.json +8 -8
package/README.md CHANGED
@@ -1,10 +1,14 @@
1
1
  # openplanet-lsp
2
2
 
3
- Language Server Protocol implementation for OpenPlanet AngelScript.
3
+ Language Server Protocol implementation for **OpenPlanet AngelScript**
4
+ (Trackmania / OpenPlanet plugins).
4
5
 
5
6
  This npm package installs a small Node launcher plus an optional
6
7
  platform-specific native binary (`openplanet-lsp-*`).
7
8
 
9
+ ![openplanet-lsp check — pretty diagnostics](https://raw.githubusercontent.com/clankercode/lsp-openplanet/master/docs/images/check-demo.png)
10
+
11
+
8
12
  ## Install
9
13
 
10
14
  ```bash
@@ -13,34 +17,77 @@ npm install -g openplanet-lsp
13
17
  npm install --save-dev openplanet-lsp
14
18
  ```
15
19
 
16
- ## Usage
17
-
18
20
  ```bash
19
- openplanet-lsp # stdio LSP server
20
21
  openplanet-lsp --version
21
- openplanet-lsp check <path>
22
+ openplanet-lsp --help
23
+ ```
24
+
25
+ ## Use as an LSP
26
+
27
+ Runs as a **stdio** language server (no args):
28
+
29
+ ```bash
30
+ openplanet-lsp
31
+ ```
32
+
33
+ Point your editor’s LSP client at the `openplanet-lsp` binary. Workspace root
34
+ should be the plugin directory (the folder with `info.toml`).
35
+
36
+ **Neovim** (sketch):
37
+
38
+ ```lua
39
+ vim.lsp.start({
40
+ name = "openplanet-lsp",
41
+ cmd = { "openplanet-lsp" },
42
+ root_dir = vim.fs.root(0, { "info.toml", ".git" }),
43
+ })
44
+ ```
45
+
46
+ **Helix** (`languages.toml` sketch):
47
+
48
+ ```toml
49
+ [language-server.openplanet-lsp]
50
+ command = "openplanet-lsp"
51
+ ```
52
+
53
+ See the [full README on GitHub](https://github.com/clankercode/lsp-openplanet#use-as-an-lsp-editor)
54
+ for VS Code–style settings and more.
55
+
56
+ ## CLI
57
+
58
+ ```bash
59
+ # Diagnostics for a plugin tree (offline)
60
+ openplanet-lsp check .
61
+ openplanet-lsp check ./MyPlugin
62
+
63
+ # Self-update
22
64
  openplanet-lsp update --check
65
+ openplanet-lsp update --check --source github # or: crate | npm
66
+ openplanet-lsp update --status
23
67
  openplanet-lsp update
24
68
  ```
25
69
 
26
- `update` reads the latest version from the npm registry, writes status to
27
- `~/.config/openplanet-lsp/update-status.json`, and (without `--check`) runs the
28
- install-method-specific upgrade command when one is known (npm / pnpm / yarn /
29
- bun global or local, or cargo).
70
+ Status looks like:
71
+
72
+ ```text
73
+ current: 0.3.0 (install type: npm-global)
74
+ latest: 0.3.0 (source checked: npm)
75
+ status: up to date
76
+ ```
30
77
 
31
78
  ## Supported platforms
32
79
 
33
- | Platform package | OS | Arch |
34
- |----------------------------------|---------|-------|
35
- | `openplanet-lsp-linux-x64` | Linux | x64 |
36
- | `openplanet-lsp-linux-arm64` | Linux | arm64 |
37
- | `openplanet-lsp-darwin-x64` | macOS | x64 |
38
- | `openplanet-lsp-darwin-arm64` | macOS | arm64 |
39
- | `openplanet-lsp-win32-x64` | Windows | x64 |
40
- | `openplanet-lsp-win32-arm64` | Windows | arm64 |
80
+ | Platform package | OS | Arch |
81
+ |-----------------------------|---------|-------|
82
+ | `openplanet-lsp-linux-x64` | Linux | x64 |
83
+ | `openplanet-lsp-linux-arm64`| Linux | arm64 |
84
+ | `openplanet-lsp-darwin-x64` | macOS | x64 |
85
+ | `openplanet-lsp-darwin-arm64` | macOS | arm64 |
86
+ | `openplanet-lsp-win32-x64` | Windows | x64 |
87
+ | `openplanet-lsp-win32-arm64`| Windows | arm64 |
41
88
 
42
- GitHub release archives (same binaries) are also published at:
43
- https://github.com/clankercode/lsp-openplanet/releases
89
+ Also: [GitHub Releases](https://github.com/clankercode/lsp-openplanet/releases) ·
90
+ [crates.io](https://crates.io/crates/openplanet-lsp)
44
91
 
45
92
  ## Programmatic
46
93
 
@@ -48,3 +95,7 @@ https://github.com/clankercode/lsp-openplanet/releases
48
95
  const { resolveBinaryPath } = require("openplanet-lsp");
49
96
  console.log(resolveBinaryPath());
50
97
  ```
98
+
99
+ ## License
100
+
101
+ Unlicense OR CC0-1.0 (public domain dedication).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "openplanet-lsp",
3
- "version": "0.3.0",
3
+ "version": "0.3.1",
4
4
  "description": "Language Server Protocol implementation for OpenPlanet AngelScript",
5
5
  "keywords": [
6
6
  "openplanet",
@@ -18,7 +18,7 @@
18
18
  "bugs": {
19
19
  "url": "https://github.com/clankercode/lsp-openplanet/issues"
20
20
  },
21
- "license": "MIT",
21
+ "license": "Unlicense OR CC0-1.0",
22
22
  "author": "clankercode",
23
23
  "type": "commonjs",
24
24
  "bin": {
@@ -37,11 +37,11 @@
37
37
  "postinstall": "node ./lib/check-platform.js"
38
38
  },
39
39
  "optionalDependencies": {
40
- "openplanet-lsp-darwin-arm64": "0.3.0",
41
- "openplanet-lsp-darwin-x64": "0.3.0",
42
- "openplanet-lsp-linux-arm64": "0.3.0",
43
- "openplanet-lsp-linux-x64": "0.3.0",
44
- "openplanet-lsp-win32-arm64": "0.3.0",
45
- "openplanet-lsp-win32-x64": "0.3.0"
40
+ "openplanet-lsp-darwin-arm64": "0.3.1",
41
+ "openplanet-lsp-darwin-x64": "0.3.1",
42
+ "openplanet-lsp-linux-arm64": "0.3.1",
43
+ "openplanet-lsp-linux-x64": "0.3.1",
44
+ "openplanet-lsp-win32-arm64": "0.3.1",
45
+ "openplanet-lsp-win32-x64": "0.3.1"
46
46
  }
47
47
  }