Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 37 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,48 @@

[![miniscript-languageserver](https://circleci.com/gh/ayecue/miniscript-languageserver.svg?style=svg)](https://circleci.com/gh/ayecue/miniscript-languageserver)

Language server related tooling.

## Contains

- [Core](https://github.com/ayecue/miniscript-languageserver/tree/main/packages/core)
- [Browser Language Server](https://github.com/ayecue/miniscript-languageserver/tree/main/packages/browser)
- [Node Language Server](https://github.com/ayecue/miniscript-languageserver/tree/main/packages/node)
A [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) implementation for [MiniScript](https://miniscript.org) written in TypeScript. It provides IDE features such as autocompletion, hover documentation, go-to-definition, diagnostics, and more. For GreyScript-specific support, see [greybel-languageserver](../greybel-lsp).

## Features

* Autocompletion with type-aware suggestions
* Hover documentation for functions and variables
* Go-to-definition and symbol lookup
* Diagnostics (syntax errors and type warnings)
* Signature help for function calls
* Document and workspace symbol search
* Semantic token highlighting
* Code formatting via the built-in transpiler (beautify)
* Color picker support
* Folding ranges
* Configurable type analyzer strategy (dependency-based or workspace-wide)

## Packages

| Package | Description |
|---------|-------------|
| [core](packages/core) | Shared LSP feature implementations |
| [node](packages/node) | Node.js language server binary |
| [browser](packages/browser) | Browser-compatible language server |

## Install

```bash
npm install -g miniscript-languageserver
```

## How to use
## Usage

After installing globally the server can be started from the command line:

For more info on how to use the language server please take a look [here](https://github.com/ayecue/miniscript-languageserver/blob/main/packages/node/README.md).
```bash
miniscript-languageserver --stdio
```

Point your editor's LSP client at this command to enable MiniScript support. For detailed configuration options, see the [node package README](packages/node/README.md).

## Testing

```bash
npm test
```
36 changes: 18 additions & 18 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@
"esbuild-plugin-globals": "0.2.0",
"esbuild-plugin-polyfill-node": "0.3.0",
"glob": "^11.0.0",
"greybel-core": ">=2.6.0",
"greybel-transpiler": ">=3.8.0",
"greybel-core": ">=3.0.0",
"greybel-transpiler": ">=4.0.0",
"jest": "^27.4.5",
"lru-cache": "^11.1.0",
"miniscript-meta": ">=1.4.0",
"greybel-type-analyzer": "~1.1.0",
"greybel-type-analyzer": "~2.0.0",
"fast-toposort": "^0.1.1",
"mocha": "^10.7.3",
"non-blocking-schedule": "^0.2.0",
Expand Down
54 changes: 27 additions & 27 deletions packages/browser/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions packages/browser/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "miniscript-languageserver-browser",
"version": "2.1.1",
"version": "2.2.0",
"description": "Language server for MiniScript",
"main": "./index.js",
"scripts": {
Expand Down Expand Up @@ -64,11 +64,11 @@
"typescript": "^4.5.4"
},
"dependencies": {
"greybel-core": "~2.6.0",
"greybel-core": "~3.0.0",
"lru-cache": "^11.1.0",
"miniscript-meta": "~1.4.0",
"greybel-transpiler": "~3.8.1",
"greybel-type-analyzer": "~1.1.1",
"miniscript-languageserver-core": "^2.1.0"
"greybel-transpiler": "~4.0.0",
"greybel-type-analyzer": "~2.0.0",
"miniscript-languageserver-core": "~3.0.2"
}
}
40 changes: 20 additions & 20 deletions packages/core/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions packages/core/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "miniscript-languageserver-core",
"version": "2.1.0",
"version": "3.0.2",
"description": "Core functionality of language server for MiniScript",
"main": "./dist/index.js",
"typings": "./dist/index.d.ts",
Expand Down Expand Up @@ -60,10 +60,10 @@
"typescript": "^4.5.4"
},
"peerDependencies": {
"greybel-core": ">=2.6.0",
"greybel-transpiler": ">=3.8.0",
"greybel-core": ">=3.0.0",
"greybel-transpiler": ">=4.0.0",
"miniscript-meta": ">=1.4.0",
"greybel-type-analyzer": ">=1.1.0"
"greybel-type-analyzer": ">=2.0.0"
},
"dependencies": {
"color-convert": "^2.0.1",
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/context.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ function createConfig(preset?: IConfigurationRequest): IConfiguration {
autocomplete: preset?.autocomplete ?? true,
hoverdocs: preset?.hoverdocs ?? true,
diagnostic: preset?.diagnostic ?? true,
strictMode: preset?.strictMode ?? false,
transpiler: {
beautify: {
keepParentheses: preset?.transpiler?.beautify?.keepParentheses ?? true,
Expand Down
Loading