caos-language-server 0.1.4 → 0.1.6

package/README.md

@@ -1,114 +1,37 @@
-# CAOS Language Server
+# caos-language-server
 
-This language server implements the Language Server protocol for handling **CAOS** language files  
-*\*Workspaces are scoped to a specific CAOS variant*
+Language Server Protocol implementation for the Creatures CAOS language and catalogue files. It provides diagnostics, completions, hover documentation, formatting, semantic tokens, inlay hints, symbols, definitions, references, and rename support.
 
-## Features
-- CAOS syntax error highlighting
-  - Invalid command
-  - Unclosed control blocks (i.e. `DOIF`, `ENUM`)
-  - Out of variant commands and variables
-  - Missing parameters
-  - Very basic type checking
-  - Semantic tokens for use in custom highlighting
-- Code completion
-    - Commands scoped to type (i.e. Command, R/L value)
-    - Subroutine Name
-    - Simple game/name variable name completions (does not scope or restrict `NAME` variables to agent class)
-    - Named value completion (i.e. type `hung`, select 'Hunger for Protein' and completion inserts corresponding numeric value)
-- Hover documentation
-- Inlay Hints (can be disabled)
-    - Known value names (i.e. Show drive name for corresponding numeric value)
-    - Bitflag breakdown (i.e. Append inlay hint `(activatable, mousable)` after `attr 3`)
-    - Parameter names (minimum number of parameters before showing hint is configurable)
-    - Command return values
-- Basic code formatting
+## Install
 
-## Extension Settings
-This extension contributes the following settings:
+```sh
+npm install caos-language-server
+```
 
-### General
-* `caosScript.maxNumberOfProblems`: Set maximum number of errors to report
-* `caosScript.variant`: Workspace CAOS variant. Can be **[C1,C2,CV,C3,DS]**. Default **DS**
-* `caosScript.formatting.indentComments`: Indent comments inline with commands except when comment is at start of line
-* ### Inlay Hints
-* `caosScript.inlayHints.bitFlagValues`: Show inlay hints for bitflag value
-* `caosScript.inlayHints.parameterHints.showParameterHints`: Show parameter names before arguments
-* `caosScript.inlayHints.parameterHints.minimumParameterCount`: Hide inlay hints for commands with less than this number of parameters
-* `caosScript.inlayHints.setvParameterHints`: Show parameter names before SETV like command arguments
-* `caosScript.inlayHints.genusName`: Show genus name for known family/genus combinations
-* `caosScript.inlayHints.valueName`: Show value name for known integer and string values
-* `caosScript.inlayHints.eventScriptName`: Show event script name for known event numbers
-* `caosScript.inlayHints.ddePictDimensions`: Show `DDE: PICT` command dimensions from dimension characters
-* `caosScript.inlayHints.c1ClasValue`: Show parsed family, genus, and specie from C1 CLAS value
-* `caosScript.inlayHints.rvalueReturnValue`: Show return type for rvalue commands
-* `caosScript.inlayHints.equality.bitFlagValues`: Show Bitflag value on opposing side of equality operator
-* `caosScript.inlayHints.equalityValueName`: Show value name for know integer and string values on opposing side of EQ
+## Use with an editor client
 
-## Semantic Tokens
-Some CAOS file elements have additional semantic token selectors on them which allows
-for more specific styling
-### Main Tokens
-* `command`: root level command name tokens
-* `rvalue`: rvalue command name tokens
-* `lvalue`: command tokens when command is used as lvalue
-### Token Modifiers
-* `command-prefix`: First token in a multi-word command
-* `command-suffix`: Last token in a three word command
-* `c1-string`: A C1 style bracket string
-* `quote-string`: A C2e style quoted string
-* `byte-string`: A byte string for things like ANIM
-* `not-found`: For a command that cannot be found in context
-* `vaxx`: for VAxx and VARx variables
-* `ovxx`: for OVxx and OBVx variables
-* `mvxx`: For MVxx variables
-* `returns-number`: Decorates command words for commands that return a number
-* `returns-string`: Decorates command words for commands returning a string
-* `returns-variable`: Decorates command word for commands returning a variable
-* `returns-agent`: Decorates command word for commands returning an agent
-* `agent-constructor`: Decorates agent constructor commands like those starting with `new:`
+The package exposes a `caos-language-server` executable and a Node/browser server bundle. It is designed to be launched by an LSP-compatible client, such as the accompanying `caos-vscode-client` package.
 
-### How to theme semantic tokens
-You can these tokens in settings by using
-```JSON
-{
-  "editor.semanticTokenColorCustomizations": {
-    "[Default Dark+]": {
-      "*.returns-string:caos": "#ff0011"
-    }
-  }
-}
+```sh
+npx caos-language-server
 ```
 
-## Known Issues
-
-- Occasionally completion becomes confused.
-  - Suggests commands instead of R/L values unexpectedly 
-  - Suggests known values for values already completed previously
-  - Fails to show suggestions for named values
-- Navigation fails from `SUBR` names to their usages
-
-## Release Notes
+The Node server uses the transport configured by `vscode-languageserver` for its host integration. Editor clients should launch the executable through their LSP client library instead of treating it as a command-line tool with a human-readable interface.
 
-### 0.1.0
+## Configuration
 
-Initial release
+Clients may provide CAOS settings through the LSP configuration mechanism. The primary setting is:
 
-## Roadmap
+```json
+{
+  "caosScript": {
+    "variant": "DS"
+  }
+}
+```
 
-* **Rename support:**
-    * subroutine (`SUBR`) names
-    * `GAME`/`EAME`/`NAME` variable names
-* **CAOS2Pray**
-  * Completions
-    * File name
-    * Known tags
-    * Commands
-  * Highlighting
-  * Compilation
-* **PRAY file support**
-  * Completions
-  * Error checking
+Supported variants are `C1`, `C2`, `CV`, `C3`, `DS`, and `DS:CE`.
 
 ## License
-[MIT](https://choosealicense.com/licenses/mit/)
+
+MIT