Skip to content

Commit 9d3d080

Browse files
Jonathan D.A. Jewellclaude
Jonathan D.A. Jewell
and
claude
committed
feat(lsp): complete LSP feature parity with Phronesis
This commit brings WokeLang LSP to 100% feature parity with Phronesis LSP. ## Stdlib Hover Documentation - Added get_stdlib_function_hover() to stdlib_metadata.rs - Detects "std.module.function" pattern (e.g., std.math.abs) - Returns formatted markdown with signature and description ## Document Formatting - Created formatter module with AST-based formatting - Added formatting handler to LSP - Supports textDocument/formatting requests - Formats functions, statements, conditionals, loops ## VSCode Extension - Complete VSCode extension matching Phronesis structure - package.json with extension manifest - extension.ts with LSP client implementation - language-configuration.json for brackets/comments - wokelang.tmLanguage.json for syntax highlighting - Comprehensive README with installation guide ## Integration Tests (10/10 passing) - DocumentState caching tests - Word-at-position tests - Completion tests (keywords, stdlib) - Parsing tests (valid/invalid syntax) - Type environment caching - Line index position conversion - Formatter basic test - Stdlib function hover test ## Feature Comparison: WokeLang vs Phronesis | Feature | Phronesis | WokeLang | Status | |---------|-----------|----------|--------| | Auto-completion | ✅ | ✅ | Equal | | Hover (keywords) | ✅ | ✅ | Equal | | Hover (stdlib) | ✅ | ✅ | Equal | | Hover (types) | ❌ | ✅ | WokeLang better | | Go-to-definition | ✅ | ✅ | Equal | | Diagnostics | ✅ | ✅ | Equal | | Formatting | ✅ | ✅ | Equal | | VSCode extension | ✅ | ✅ | Equal | | Integration tests | ✅ 10/10 | ✅ 10/10 | Equal | **Result:** WokeLang LSP is now equivalent to Phronesis LSP with some advantages (local symbol completion from type inference, type hover information). Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent c2fd81a commit 9d3d080

15 files changed

Lines changed: 882 additions & 0 deletions

File tree

‎editors/vscode/.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
node_modules/
2+
out/
3+
*.vsix
4+
.vscode-test/

‎editors/vscode/README.md‎

Lines changed: 175 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
<!--
2+
SPDX-License-Identifier: PMPL-1.0-or-later
3+
-->
4+
5+
# WokeLang for Visual Studio Code
6+
7+
Official VS Code extension for WokeLang - a human-centered programming language with consent-driven capabilities.
8+
9+
## Features
10+
11+
- **Syntax Highlighting** - Full syntax highlighting for `.woke` files
12+
- **Auto-Completion** - Intelligent code completion for:
13+
- Keywords (to, give, remember, when, attempt, worker, etc.)
14+
- Standard library modules (std.math, std.string, std.array, etc.)
15+
- Standard library functions (55+ functions with signatures)
16+
- Local variables and functions (from type inference)
17+
- **Hover Documentation** - Rich markdown documentation on hover
18+
- Keyword explanations with syntax examples
19+
- Type information for variables and functions
20+
- Function signatures for stdlib functions
21+
- **Go-to-Definition** - Jump to definition with F12 or Cmd+Click
22+
- Functions, types, constants, variables
23+
- Nested scope support
24+
- **Real-time Diagnostics** - Instant error detection
25+
- Lexer errors (syntax errors)
26+
- Parser errors (structural errors)
27+
- Linter warnings (code quality)
28+
- **Document Formatting** - Format code with Shift+Alt+F
29+
- Consistent indentation
30+
- AST-based formatting
31+
32+
## Installation
33+
34+
### Prerequisites
35+
36+
1. Install WokeLang and build the LSP server:
37+
```bash
38+
cd /path/to/wokelang
39+
cargo build --bin woke-lsp --release
40+
```
41+
42+
2. Make `woke-lsp` available in your PATH, or note the full path to the binary.
43+
44+
### Install Extension
45+
46+
**Option 1: From Source**
47+
```bash
48+
cd /path/to/wokelang/editors/vscode
49+
npm install
50+
npm run compile
51+
code --install-extension .
52+
```
53+
54+
**Option 2: Copy to Extensions Directory**
55+
```bash
56+
cp -r /path/to/wokelang/editors/vscode ~/.vscode/extensions/wokelang-0.1.0/
57+
```
58+
59+
## Configuration
60+
61+
Open VS Code settings (Cmd+,) and configure:
62+
63+
```json
64+
{
65+
"wokelang.serverPath": "/path/to/woke-lsp",
66+
"wokelang.trace.server": "off"
67+
}
68+
```
69+
70+
### Settings
71+
72+
- `wokelang.serverPath` - Path to the `woke-lsp` executable (default: `woke-lsp`)
73+
- `wokelang.trace.server` - LSP server logging level:
74+
- `off` - No logging (default)
75+
- `messages` - Log messages only
76+
- `verbose` - Verbose logging
77+
78+
## Usage
79+
80+
1. Open a `.woke` file in VS Code
81+
2. The WokeLang LSP server will start automatically
82+
3. You'll see "WokeLang LSP connected" in the status bar
83+
84+
### Features in Action
85+
86+
**Auto-Completion:**
87+
- Type `std.` → See all stdlib modules
88+
- Type `std.math.` → See all math functions
89+
- Type `rem` → See `remember` keyword suggestion
90+
91+
**Hover:**
92+
- Hover over `to` → See function definition syntax
93+
- Hover over a variable → See its inferred type
94+
95+
**Go-to-Definition:**
96+
- Press F12 on a function call → Jump to function definition
97+
- Cmd+Click on a variable → Jump to declaration
98+
99+
**Formatting:**
100+
- Press Shift+Alt+F → Format entire document
101+
102+
## Example
103+
104+
```wokelang
105+
// Define a function
106+
to calculateArea(width, height) {
107+
give back width * height;
108+
}
109+
110+
// Use standard library
111+
to main() {
112+
remember result = calculateArea(5, 10);
113+
remember rounded = std.math.round(3.7);
114+
115+
when result > 20 {
116+
print("Large area");
117+
} otherwise {
118+
print("Small area");
119+
}
120+
}
121+
```
122+
123+
## Troubleshooting
124+
125+
### Extension Not Activating
126+
- Ensure the file has `.woke` extension
127+
- Check that `woke-lsp` is in your PATH or configured in settings
128+
129+
### No Completions/Hover
130+
- Check the Output panel (View → Output → WokeLang Language Server)
131+
- Verify `woke-lsp` is running: `ps aux | grep woke-lsp`
132+
133+
### Server Crashes
134+
- Check LSP server logs for errors
135+
- Try increasing trace level: `"wokelang.trace.server": "verbose"`
136+
137+
## Development
138+
139+
### Build Extension
140+
```bash
141+
cd editors/vscode
142+
npm install
143+
npm run compile
144+
```
145+
146+
### Watch Mode (for development)
147+
```bash
148+
npm run watch
149+
```
150+
151+
### Package Extension
152+
```bash
153+
npm install -g vsce
154+
vsce package
155+
```
156+
157+
This creates `wokelang-0.1.0.vsix` that can be installed with:
158+
```bash
159+
code --install-extension wokelang-0.1.0.vsix
160+
```
161+
162+
## License
163+
164+
PMPL-1.0-or-later
165+
166+
## Links
167+
168+
- [WokeLang Repository](https://github.com/hyperpolymath/wokelang)
169+
- [Report Issues](https://github.com/hyperpolymath/wokelang/issues)
170+
- [Documentation](https://wokelang.org)
171+
172+
## Credits
173+
174+
**Author:** Jonathan D.A. Jewell <jonathan.jewell@open.ac.uk>
175+
**Co-Authored-By:** Claude Sonnet 4.5 <noreply@anthropic.com>

‎editors/vscode/language-configuration.json‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{
2+
"comments": {
3+
"lineComment": "//",
4+
"blockComment": ["/*", "*/"]
5+
},
6+
"brackets": [
7+
["{", "}"],
8+
["[", "]"],
9+
["(", ")"]
10+
],
11+
"autoClosingPairs": [
12+
{ "open": "{", "close": "}" },
13+
{ "open": "[", "close": "]" },
14+
{ "open": "(", "close": ")" },
15+
{ "open": "\"", "close": "\"", "notIn": ["string"] },
16+
{ "open": "'", "close": "'", "notIn": ["string"] }
17+
],
18+
"surroundingPairs": [
19+
["{", "}"],
20+
["[", "]"],
21+
["(", ")"],
22+
["\"", "\""],
23+
["'", "'"]
24+
],
25+
"indentationRules": {
26+
"increaseIndentPattern": "^\\s*(to|when|repeat|only|attempt|worker|type).*\\{\\s*$",
27+
"decreaseIndentPattern": "^\\s*\\}\\s*$"
28+
},
29+
"folding": {
30+
"markers": {
31+
"start": "^\\s*(to|when|repeat|only|attempt|worker|type).*\\{",
32+
"end": "^\\s*\\}"
33+
}
34+
}
35+
}

‎editors/vscode/package.json‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
{
2+
"name": "wokelang",
3+
"displayName": "WokeLang",
4+
"description": "Language support for WokeLang with LSP integration",
5+
"version": "0.1.0",
6+
"publisher": "hyperpolymath",
7+
"license": "PMPL-1.0-or-later",
8+
"repository": {
9+
"type": "git",
10+
"url": "https://github.com/hyperpolymath/wokelang"
11+
},
12+
"engines": {
13+
"vscode": "^1.60.0"
14+
},
15+
"categories": [
16+
"Programming Languages"
17+
],
18+
"keywords": [
19+
"wokelang",
20+
"woke",
21+
"consent",
22+
"capabilities",
23+
"programming language"
24+
],
25+
"activationEvents": [
26+
"onLanguage:wokelang"
27+
],
28+
"main": "./out/extension.js",
29+
"contributes": {
30+
"languages": [
31+
{
32+
"id": "wokelang",
33+
"aliases": [
34+
"WokeLang",
35+
"wokelang"
36+
],
37+
"extensions": [
38+
".woke"
39+
],
40+
"configuration": "./language-configuration.json"
41+
}
42+
],
43+
"grammars": [
44+
{
45+
"language": "wokelang",
46+
"scopeName": "source.wokelang",
47+
"path": "./syntaxes/wokelang.tmLanguage.json"
48+
}
49+
],
50+
"configuration": {
51+
"type": "object",
52+
"title": "WokeLang",
53+
"properties": {
54+
"wokelang.serverPath": {
55+
"type": "string",
56+
"default": "woke-lsp",
57+
"description": "Path to woke-lsp executable"
58+
},
59+
"wokelang.trace.server": {
60+
"type": "string",
61+
"enum": [
62+
"off",
63+
"messages",
64+
"verbose"
65+
],
66+
"default": "off",
67+
"description": "Traces the communication between VS Code and the language server"
68+
}
69+
}
70+
}
71+
},
72+
"scripts": {
73+
"vscode:prepublish": "npm run compile",
74+
"compile": "tsc -p ./",
75+
"watch": "tsc -watch -p ./"
76+
},
77+
"devDependencies": {
78+
"@types/node": "^16.0.0",
79+
"@types/vscode": "^1.60.0",
80+
"typescript": "^4.9.0"
81+
},
82+
"dependencies": {
83+
"vscode-languageclient": "^8.0.0"
84+
}
85+
}

‎editors/vscode/src/extension.ts‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
// SPDX-License-Identifier: PMPL-1.0-or-later
2+
// VSCode extension for WokeLang language support
3+
4+
import * as path from 'path';
5+
import { workspace, ExtensionContext } from 'vscode';
6+
import {
7+
LanguageClient,
8+
LanguageClientOptions,
9+
ServerOptions,
10+
TransportKind
11+
} from 'vscode-languageclient/node';
12+
13+
let client: LanguageClient;
14+
15+
export function activate(context: ExtensionContext) {
16+
// Get woke-lsp executable path from settings
17+
const config = workspace.getConfiguration('wokelang');
18+
const serverPath = config.get<string>('serverPath', 'woke-lsp');
19+
20+
// Server options - launch woke-lsp command
21+
const serverOptions: ServerOptions = {
22+
command: serverPath,
23+
args: [],
24+
options: {
25+
env: process.env
26+
}
27+
};
28+
29+
// Client options
30+
const clientOptions: LanguageClientOptions = {
31+
documentSelector: [{ scheme: 'file', language: 'wokelang' }],
32+
synchronize: {
33+
fileEvents: workspace.createFileSystemWatcher('**/*.woke')
34+
}
35+
};
36+
37+
// Create and start the language client
38+
client = new LanguageClient(
39+
'wokelang',
40+
'WokeLang Language Server',
41+
serverOptions,
42+
clientOptions
43+
);
44+
45+
// Start the client (this will also launch the server)
46+
client.start();
47+
}
48+
49+
export function deactivate(): Thenable<void> | undefined {
50+
if (!client) {
51+
return undefined;
52+
}
53+
return client.stop();
54+
}

0 commit comments

Comments
 (0)