Touch ups to LSP and Tools packages (#830)

zth · aspeddro · web-flow · commit 4890db4fa607 · 2023-11-03T09:24:37.000+01:00
* name changes and other touch ups * add sample zero cost variant version of docgen representation * Polish: LSP and Tools package (#833) * update ci, readme and contributing.md * fix * add Cli.resi and rescript.json * fixes * restore some changes --------- Co-authored-by: Pedro Castro <aspeddro@gmail.com>
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -192,7 +192,9 @@ Analysis bin is what we currently call the OCaml code that does deeper language
 
 We're happy to gather more resources over time here, including more in-depth getting started guides.
 
-## Release
+## Releasing the VSCode extension and standalone LSP package
+
+_This below will automatically release the LSP package as well._
 
 1. Bump the version to an _even minor_ version number in `package.json` and `server/package.json` and their lockfiles. It's very important that it's an even minor like `1.8.0`, and not `1.7.0`. This is because even minors are reserved for actual releases, and uneven minors for pre-releases. Commit and push the version bump.
 2. Make sure @ryyppy is aware of your changes. He needs to sync them over to the vim plugin.
@@ -208,4 +210,8 @@ If that somehow does not work, you can do the above steps manually:
 2. Go to the appropriate [VSCode Marketplace Publisher](https://marketplace.visualstudio.com/manage/publishers/chenglou92), select the three dots next to the extension name, and choose `Update`. Upload your `.vsix` there.
 3. Not done! Make a new manual release [here](https://github.com/rescript-lang/rescript-vscode/releases), and make sure you attach the generated `.vsix` onto that new release as well. This is for folks who don't use the VSCode marketplace.
 
-For beta releases, ask folks to try the `.vsix` from CI directly.
+For beta releases, ask folks to use the pre-release version installable from the VSCode Marketplace.
+
+## Releasing the `@rescript/tools` package
+
+The tools package is released by bumping the version in `tools/package.json`, running `npm i` in the `tools/` folder, and then pushing those changes with the commit message `publish tools`.
diff --git a/README.md b/README.md
@@ -176,16 +176,6 @@ A screenshot of the result:
 
 ![Shows the end result in VSCode, with ReScript related files nested under eachother appropriately.](https://user-images.githubusercontent.com/1457626/168123647-400e2f09-31e3-45a2-b74b-190c7c207446.png)
 
-## ⌨️ Use with Other Editors
-
-This repo also contains a language server that can power other editors. **However, the language server in this project is a pure implementation detail. We don't guarantee its stability for other editors' consumption** apart from Vim and Sublime Text.
-
-Still, if you'd like to use this language-server with other editors:
-
-- Get the release binaries from the Github Releases page.
-- Unzip the `.vsix` and get the `server` folder. That's the only folder you need.
-- The language server will be at `server/out/server.js`. Call it through node, and optionally pass `--stdio` if your editor doesn't support the default JSONRPC.
-
 ## 📰 Changelog
 
 See [CHANGELOG](CHANGELOG.md)
diff --git a/client/package.json b/client/package.json
@@ -4,7 +4,7 @@
   "version": "0.0.0",
   "description": "ReScript's language-client",
   "keywords": [],
-  "author": "chenglou",
+  "author": "ReScript Team",
   "license": "MIT",
   "dependencies": {
     "vscode-languageclient": "8.1.0-next.5"
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
 	"name": "rescript-vscode",
 	"displayName": "ReScript",
 	"description": "ReScript language support (official)",
-	"author": "chenglou",
+	"author": "ReScript Team",
 	"license": "MIT",
 	"version": "1.20.0",
 	"repository": {
diff --git a/server/README.md b/server/README.md
@@ -15,7 +15,7 @@ resciptls --stdio
 ```sh
 ReScript Language Server
 
-Usage: rescriptls [options]
+Usage: rescript-ls [options]
 
 Options:
 
diff --git a/server/package-lock.json b/server/package-lock.json
diff --git a/server/package.json b/server/package.json
@@ -2,10 +2,10 @@
 	"name": "@rescript/lsp",
 	"description": "LSP server for ReScript",
 	"version": "1.20.0",
-	"author": "chenglou",
+	"author": "ReScript Team",
 	"license": "MIT",
 	"bin": {
-		"rescriptls": "./out/cli.js"
+		"rescript-ls": "./out/cli.js"
 	},
 	"keywords": [
 		"ReScript",
diff --git a/server/src/cli.ts b/server/src/cli.ts
@@ -6,7 +6,7 @@ const args = process.argv.slice(2)
 
 const help = `ReScript Language Server
 
-Usage: rescriptls [options]
+Usage: rescript-ls [options]
 
 Options:
 
diff --git a/tools/README.md b/tools/README.md
@@ -9,27 +9,27 @@ npm install --save-dev @rescript/tools
 ## CLI Usage
 
 ```sh
-restools --help
+rescript-tools --help
 ```
 
 ### Generate documentation
 
 Print JSON:
 
 ```sh
-restools doc src/EntryPointLibFile.res
+rescript-tools doc src/EntryPointLibFile.res
 ```
 
 Write JSON:
 
 ```sh
-restools doc src/EntryPointLibFile.res > doc.json
+rescript-tools doc src/EntryPointLibFile.res > doc.json
 ```
 
 ### Reanalyze
 
 ```sh
-restools reanalyze --help
+rescript-tools reanalyze --help
 ```
 
 ## Decode JSON
diff --git a/tools/package-lock.json b/tools/package-lock.json
diff --git a/tools/package.json b/tools/package.json
@@ -2,10 +2,10 @@
 	"name": "@rescript/tools",
 	"description": "ReScript Tools",
 	"version": "0.1.0",
-	"author": "chenglou",
+	"author": "ReScript Team",
 	"license": "MIT",
 	"bin": {
-		"restools": "./src/Cli.bs.js"
+		"rescript-tools": "./src/Cli.bs.js"
 	},
 	"keywords": [
 		"ReScript",
@@ -17,6 +17,7 @@
 		"src/*.res",
 		"src/*.resi",
 		"analysis_binaries/",
+		"rescript.json",
 		"README.md"
 	],
 	"engines": {
diff --git a/tools/rescript.json b/tools/rescript.json
@@ -3,8 +3,7 @@
   "version": "0.1.0",
   "sources": [
     {
-      "dir": "src",
-      "public": ["RescriptTools"]
+      "dir": "src"
     }
   ],
   "suffix": ".bs.js",
diff --git a/tools/src/Cli.res b/tools/src/Cli.res
@@ -43,13 +43,13 @@ let docHelp = `ReScript Tools
 
 Output documentation to standard output
 
-Usage: restools doc <FILE>
+Usage: rescript-tools doc <FILE>
 
-Example: restools doc ./path/to/EntryPointLib.res`
+Example: rescript-tools doc ./path/to/EntryPointLib.res`
 
 let help = `ReScript Tools
 
-Usage: restools [command]
+Usage: rescript-tools [command]
 
 Commands:
 
diff --git a/tools/src/Cli.resi b/tools/src/Cli.resi
@@ -0,0 +1 @@
+
diff --git a/tools/src/Tools_Docgen.res b/tools/src/Tools_Docgen.res
@@ -3,20 +3,20 @@ type field = {
   docstrings: array<string>,
   signature: string,
   optional: bool,
-  deprecated: option<string>,
+  deprecated?: string,
 }
 
 type constructor = {
   name: string,
   docstrings: array<string>,
   signature: string,
-  deprecated: option<string>,
+  deprecated?: string,
 }
 
 @tag("kind")
 type detail =
-  | @as("record") Record(array<field>)
-  | @as("variant") Variant(array<constructor>)
+  | @as("record") Record({items: array<field>})
+  | @as("variant") Variant({items: array<constructor>})
 
 @tag("kind")
 type rec item =
@@ -26,17 +26,17 @@ type rec item =
       docstrings: array<string>,
       signature: string,
       name: string,
-      deprecated: option<string>,
+      deprecated?: string,
     })
   | @as("type")
   Type({
       id: string,
       docstrings: array<string>,
       signature: string,
       name: string,
-      deprecated: option<string>,
+      deprecated?: string,
       /** Additional documentation for constructors and record fields, if available. */
-      detail: option<detail>,
+      detail?: detail,
     })
   | @as("module") Module(docsForModule)
   | @as("moduleAlias")
@@ -49,7 +49,7 @@ type rec item =
 and docsForModule = {
   id: string,
   docstrings: array<string>,
-  deprecated: option<string>,
+  deprecated?: string,
   name: string,
   items: array<item>,
 }
@@ -86,7 +86,7 @@ let decodeDepreacted = item => {
 
 let decodeRecordFields = fields => {
   open Js.Json
-  let fields = fields->Js.Array2.map(field => {
+  let items = fields->Js.Array2.map(field => {
     switch field {
     | Object(doc) => {
         let name = doc->decodeStringByField("name")
@@ -98,32 +98,32 @@ let decodeRecordFields = fields => {
         | _ => assert(false)
         }
 
-        {name, docstrings, signature, optional, deprecated}
+        {name, docstrings, signature, optional, ?deprecated}
       }
 
     | _ => assert(false)
     }
   })
-  Record(fields)
+  Record({items: items})
 }
 
 let decodeConstructorFields = fields => {
   open Js.Json
-  let fields = fields->Js.Array2.map(field => {
+  let items = fields->Js.Array2.map(field => {
     switch field {
     | Object(doc) => {
         let name = doc->decodeStringByField("name")
         let docstrings = doc->decodeDocstrings
         let signature = doc->decodeStringByField("signature")
         let deprecated = doc->decodeDepreacted
 
-        {name, docstrings, signature, deprecated}
+        {name, docstrings, signature, ?deprecated}
       }
 
     | _ => assert(false)
     }
   })
-  Variant(fields)
+  Variant({items: items})
 }
 
 let decodeDetail = detail => {
@@ -151,7 +151,7 @@ let rec decodeValue = item => {
   let name = item->decodeStringByField("name")
   let deprecated = item->decodeDepreacted
   let docstrings = item->decodeDocstrings
-  Value({id, docstrings, signature, name, deprecated})
+  Value({id, docstrings, signature, name, ?deprecated})
 }
 and decodeType = item => {
   let id = item->decodeStringByField("id")
@@ -163,7 +163,7 @@ and decodeType = item => {
   | Some(field) => decodeDetail(field)->Some
   | None => None
   }
-  Type({id, docstrings, signature, name, deprecated, detail})
+  Type({id, docstrings, signature, name, ?deprecated, ?detail})
 }
 and decodeModuleAlias = item => {
   open Js.Json
@@ -186,7 +186,7 @@ and decodeModule = item => {
   | Some(Array(items)) => items->Js.Array2.map(item => decodeItem(item))
   | _ => assert(false)
   }
-  Module({id, name, docstrings, deprecated, items})
+  Module({id, name, docstrings, ?deprecated, items})
 }
 and decodeItem = item => {
   open Js.Json
diff --git a/tools/src/Tools_Docgen.resi b/tools/src/Tools_Docgen.resi
@@ -3,37 +3,37 @@ type field = {
   docstrings: array<string>,
   signature: string,
   optional: bool,
-  deprecated: option<string>,
+  deprecated?: string,
 }
 type constructor = {
   name: string,
   docstrings: array<string>,
   signature: string,
-  deprecated: option<string>,
+  deprecated?: string,
 }
-type detail = Record(array<field>) | Variant(array<constructor>)
+type detail = Record({items: array<field>}) | Variant({items: array<constructor>})
 type rec item =
   | Value({
       id: string,
       docstrings: array<string>,
       signature: string,
       name: string,
-      deprecated: option<string>,
+      deprecated?: string,
     })
   | Type({
       id: string,
       docstrings: array<string>,
       signature: string,
       name: string,
-      deprecated: option<string>,
-      detail: option<detail>,
+      deprecated?: string,
+      detail?: detail,
     })
   | Module(docsForModule)
   | ModuleAlias({id: string, docstrings: array<string>, name: string, items: array<item>})
 and docsForModule = {
   id: string,
   docstrings: array<string>,
-  deprecated: option<string>,
+  deprecated?: string,
   name: string,
   items: array<item>,
 }
diff --git a/tools/src/Tools_Docgen2.res b/tools/src/Tools_Docgen2.res
