@razdolbai/merls 1.3.1 → 1.3.2
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.
- package/.harper-dictionary.txt +2 -0
- package/README.md +31 -30
- package/examples/coc-settings.json +2 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,25 +1,25 @@
|
|
|
1
|
-
# merls
|
|
2
|
-
|
|
3
|
-
`merls` is a language server for **Merlin-style 6502 assembly** with **coc.nvim** as the primary editor target.
|
|
4
|
-
|
|
1
|
+
# merls
|
|
2
|
+
|
|
3
|
+
`merls` is a language server for **Merlin-style 6502 assembly** with **coc.nvim** as the primary editor target.
|
|
4
|
+
|
|
5
5
|
## Status
|
|
6
6
|
|
|
7
7
|
The MVP LSP feature set for Merlin-style 6502 assembly is complete and published to npm as `@razdolbai/merls`. It provides core language server features and is ready to be used with editors like `coc.nvim`.
|
|
8
|
-
|
|
9
|
-
## Goals
|
|
10
|
-
|
|
11
|
-
-
|
|
12
|
-
-
|
|
13
|
-
- support Merlin-style 6502 source structure, symbols, directives, and expressions
|
|
14
|
-
-
|
|
15
|
-
|
|
16
|
-
## Scope
|
|
17
|
-
|
|
18
|
-
### In
|
|
8
|
+
|
|
9
|
+
## Goals
|
|
10
|
+
|
|
11
|
+
- Provide a standalone LSP server over stdio
|
|
12
|
+
- Work cleanly with coc.nvim through standard language-server configuration
|
|
13
|
+
- support Merlin-style 6502 source structure, symbols, directives, and expressions
|
|
14
|
+
- Deliver useful editing features before deeper assembler integration
|
|
15
|
+
|
|
16
|
+
## Scope
|
|
17
|
+
|
|
18
|
+
### In Scope
|
|
19
19
|
|
|
20
20
|
- 6502-only Merlin-style assembly
|
|
21
|
-
-
|
|
22
|
-
-
|
|
21
|
+
- Parser-based diagnostics for the MVP
|
|
22
|
+
- Core LSP features such as:
|
|
23
23
|
- diagnostics
|
|
24
24
|
- hover
|
|
25
25
|
- completion
|
|
@@ -29,13 +29,11 @@ The MVP LSP feature set for Merlin-style 6502 assembly is complete and published
|
|
|
29
29
|
- workspace symbols
|
|
30
30
|
- semantic tokens (syntax highlighting)
|
|
31
31
|
|
|
32
|
-
### Out of
|
|
32
|
+
### Out of Scope
|
|
33
33
|
|
|
34
34
|
- 65816 support
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
35
|
+
|
|
36
|
+
|
|
39
37
|
## Implementation
|
|
40
38
|
|
|
41
39
|
- **runtime:** Node.js
|
|
@@ -52,7 +50,7 @@ Install globally via npm:
|
|
|
52
50
|
npm install -g @razdolbai/merls
|
|
53
51
|
```
|
|
54
52
|
|
|
55
|
-
## Development
|
|
53
|
+
## Development Workflow
|
|
56
54
|
|
|
57
55
|
- `npm install`: install project dependencies
|
|
58
56
|
- `npm run build`: compile the TypeScript sources into `dist/`
|
|
@@ -60,14 +58,14 @@ npm install -g @razdolbai/merls
|
|
|
60
58
|
- `npm run dev`: run the TypeScript compiler in watch mode during bootstrap work
|
|
61
59
|
- `pwsh test/smoke/run-smoke.ps1`: run the headless Vim + coc.nvim smoke test (requires Vim with coc.nvim installed via vim-plug)
|
|
62
60
|
|
|
63
|
-
The packaged CLI
|
|
61
|
+
The packaged CLI entry point now lives at `dist/src/cli.js`.
|
|
64
62
|
|
|
65
|
-
## CLI
|
|
63
|
+
## CLI Contract
|
|
66
64
|
|
|
67
65
|
The supported stdio launch contract is `merls --stdio`.
|
|
68
66
|
|
|
69
67
|
|
|
70
|
-
## coc.nvim
|
|
68
|
+
## coc.nvim Target
|
|
71
69
|
|
|
72
70
|
The intended integration model is a standard `languageserver` entry in `coc-settings.json` that launches `merls` over stdio.
|
|
73
71
|
|
|
@@ -75,6 +73,7 @@ If you installed `merls` globally via npm, the `languageserver` shape is:
|
|
|
75
73
|
|
|
76
74
|
```json
|
|
77
75
|
{
|
|
76
|
+
"semanticTokens.enable": true,
|
|
78
77
|
"languageserver": {
|
|
79
78
|
"merls": {
|
|
80
79
|
"command": "merls",
|
|
@@ -85,21 +84,23 @@ If you installed `merls` globally via npm, the `languageserver` shape is:
|
|
|
85
84
|
".git"
|
|
86
85
|
],
|
|
87
86
|
"filetypes": [
|
|
88
|
-
"
|
|
87
|
+
"6502"
|
|
89
88
|
]
|
|
90
89
|
}
|
|
91
90
|
}
|
|
92
91
|
}
|
|
93
92
|
```
|
|
94
93
|
|
|
94
|
+
To enable semantic tokens for syntax highlighting, ensure `"semanticTokens.enable": true` is set in your `coc-settings.json` and that your Vim buffer is set to the matching filetype (e.g. `set filetype=6502`).
|
|
95
|
+
|
|
95
96
|
An example configuration lives in `examples/coc-settings.json`.
|
|
96
|
-
|
|
97
|
-
## Development
|
|
97
|
+
|
|
98
|
+
## Development Notes
|
|
98
99
|
|
|
99
100
|
- TDD is mandatory for implementation work in this repository.
|
|
100
101
|
- Core syntax, parsing, and document model logic is located in `src/asm/`.
|
|
101
102
|
- LSP handlers (hover, completion, diagnostics, etc.) are located in `src/lsp/`.
|
|
102
|
-
- The CLI
|
|
103
|
+
- The CLI entry point lives in `src/cli.ts` and compiles to `dist/src/cli.js`.
|
|
103
104
|
- The `test/fixtures/valid/` directory contains supported 6502 Merlin-style syntax samples.
|
|
104
105
|
- The `test/fixtures/invalid/` directory contains unsupported 65816-only syntax samples for negative testing.
|
|
105
106
|
- The integration test suite covers stdio `initialize`, the CLI contract, and core LSP features.
|