devsense-php-ls 1.0.17357 → 1.0.17363

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 +16 -13
  2. package/package.json +26 -8
package/README.md CHANGED
@@ -4,11 +4,13 @@ This package provides language server for PHP.
4
4
 
5
5
  ## 🧠 Language Server
6
6
 
7
- The language server executable is a binary platform specific file installed as a dependency, located at `node_modules/devsense-php-ls-$os-$cpu/dist/devsense.php.ls`.
7
+ The language server is provided as a platform-specific binary executable file, located in `node_modules/devsense-php-ls-${os}-${cpu}/dist/devsense.php.ls`.
8
+
9
+ The functionality is provided to end-users under a freemium model. See _🔐 Activation_ section below for details.
8
10
 
9
11
  ## 🧬 Protocol
10
12
 
11
- Upon starting, the language server is controlled using the Language Server Protocol according to https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/ through STDIN/STDOUT.
13
+ The language server is controlled using the Language Server Protocol according to https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/ through STDIN/STDOUT.
12
14
 
13
15
  There are several additions:
14
16
 
@@ -17,14 +19,15 @@ There are several additions:
17
19
  ```json
18
20
  {
19
21
  "initializationOptions": {
20
- "0": "<license signature>",
22
+ "0": "{JSON SIGNATURE}",
23
+ "clientFeatures": [],
21
24
  // VSCode settings and their values listed on
22
25
  // https://docs.devsense.com/vscode/configuration/
23
26
  // "setting-id": "value",
24
27
  },
25
28
 
26
- // process of the client so
27
- // LS will automatically kill itself if client exits
29
+ // process ID of client allowing
30
+ // LS to automatically kill itself if client exits
28
31
  "processId": 123456,
29
32
 
30
33
  // ...
@@ -35,32 +38,32 @@ There are several additions:
35
38
 
36
39
  ## 🔐 Activation
37
40
 
38
- The language server provides free features and premium features which needs to be activated.
41
+ The language server provides free features and premium features which needs to be activated by end-user.
39
42
 
40
- **_Note to developers:_** To unlock the premium features of this package, please follow the steps below:
43
+ **_Note to developers:_** To unlock the premium features of this package, instruct end-users to follow the steps below:
41
44
 
42
45
  1. **Purchase a License:**
43
- User needs to purchase license on our official purchase page: [https://www.devsense.com/purchase](https://www.devsense.com/purchase)
46
+ User needs to purchase license on official purchase page: [https://www.devsense.com/purchase](https://www.devsense.com/purchase)
44
47
 
45
48
  2. **Generate License Signature:**
46
- User will go to the following page to validate license to receive the license **SIGNATURE**: [https://www.devsense.com/purchase/validation](https://www.devsense.com/purchase/validation)
49
+ User will follow the link below to validate license and receive the **{JSON SIGNATURE}**: [https://www.devsense.com/purchase/validation](https://www.devsense.com/purchase/validation)
47
50
 
48
51
  3. **Activate Premium Features**
49
- Pass the license signature into the language server's `initialize` method, `"initializationOptions"` property:
52
+ Pass the entire {JSON SIGNATURE} into the language server's `initialize` method, `"initializationOptions"."0"` property:
50
53
  ```json
51
54
  {
52
55
  "initializationOptions": {
53
- "0": "<SIGNATURE>",
56
+ "0": "{JSON SIGNATURE}",
54
57
  ...
55
58
  },
56
59
  ...
57
60
  }`
58
61
  ```
59
62
 
60
- Or store the license signature into environment variable `DEVSENSE_PHP_LS_LICENSE`.
63
+ Or store the {JSON SIGNATURE} into environment variable `DEVSENSE_PHP_LS_LICENSE`.
61
64
 
62
65
  ```shell
63
- SET DEVSENSE_PHP_LS_LICENSE="<SIGNATURE>"
66
+ SET DEVSENSE_PHP_LS_LICENSE="{JSON SIGNATURE}"
64
67
  ```
65
68
 
66
69
  If you encounter any issues during the activation process, please refer to our documentation or contact support.
package/package.json CHANGED
@@ -1,7 +1,17 @@
1
1
  {
2
2
  "name": "devsense-php-ls",
3
- "version": "1.0.17357",
3
+ "version": "1.0.17363",
4
4
  "description": "Devsense PHP Language Server",
5
+ "homepage": "https://www.devsense.com/",
6
+ "funding": "https://www.devsense.com/purchase?from=npm",
7
+ "repository": {
8
+ "type": "git",
9
+ "url": "https://github.com/DEVSENSE/phptools-docs/"
10
+ },
11
+ "bugs": {
12
+ "url": "https://github.com/DEVSENSE/phptools-docs/issues"
13
+ },
14
+ "main": "./dist/index.js",
5
15
  "types": "dist/index.d.ts",
6
16
  "os": [
7
17
  "darwin",
@@ -15,20 +25,28 @@
15
25
  "author": "DEVSENSE",
16
26
  "license": "ISC",
17
27
  "keywords": [
18
- "cli",
19
28
  "php",
20
29
  "code analysis",
21
30
  "code fix",
22
31
  "code check",
32
+ "intellisense",
33
+ "completion",
34
+ "parameters",
35
+ "diagnostics",
36
+ "format",
37
+ "autocomplete",
38
+ "symbols",
39
+ "references",
23
40
  "linter",
41
+ "lsp",
24
42
  "language server"
25
43
  ],
26
44
  "optionalDependencies": {
27
- "devsense-php-ls-darwin-arm64": "^1.0.17357",
28
- "devsense-php-ls-darwin-x64": "^1.0.17357",
29
- "devsense-php-ls-linux-arm64": "^1.0.17357",
30
- "devsense-php-ls-linux-x64": "^1.0.17357",
31
- "devsense-php-ls-win32-arm64": "^1.0.17357",
32
- "devsense-php-ls-win32-x64": "^1.0.17357"
45
+ "devsense-php-ls-darwin-arm64": "^1.0.17363",
46
+ "devsense-php-ls-darwin-x64": "^1.0.17363",
47
+ "devsense-php-ls-linux-arm64": "^1.0.17363",
48
+ "devsense-php-ls-linux-x64": "^1.0.17363",
49
+ "devsense-php-ls-win32-arm64": "^1.0.17363",
50
+ "devsense-php-ls-win32-x64": "^1.0.17363"
33
51
  }
34
52
  }