@razdolbai/merls 0.1.0 → 1.0.0

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.
Files changed (2) hide show
  1. package/README.md +17 -12
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -42,6 +42,14 @@ This repository now has an initial Node.js and TypeScript workspace scaffold, a
42
42
  - **process model:** standalone stdio server
43
43
  - **development style:** TDD from the start
44
44
 
45
+ ## Installation
46
+
47
+ Install globally via npm:
48
+
49
+ ```sh
50
+ npm install -g @razdolbai/merls
51
+ ```
52
+
45
53
  ## Development workflow
46
54
 
47
55
  - `npm install`: install project dependencies
@@ -75,23 +83,14 @@ See `PLAN.md` for the full checklist.
75
83
 
76
84
  The intended integration model is a standard `languageserver` entry in `coc-settings.json` that launches `merls` over stdio.
77
85
 
78
- An initial example lives in `examples/coc-settings.json`. The current bootstrap flow is:
79
-
80
- 1. run `npm install`
81
- 2. run `npm run build`
82
- 3. point coc.nvim at `dist/src/cli.js --stdio`
83
-
84
- The bundled example uses `node` plus an absolute path to the packaged CLI, passes `--stdio`, uses `package.json` and `.git` as root markers, and currently targets the `asm` filetype.
85
-
86
- The intended `languageserver` shape is:
86
+ If you installed `merls` globally via npm, the `languageserver` shape is:
87
87
 
88
88
  ```json
89
89
  {
90
90
  "languageserver": {
91
91
  "merls": {
92
- "command": "node",
92
+ "command": "merls",
93
93
  "args": [
94
- "C:/path/to/merls/dist/src/cli.js",
95
94
  "--stdio"
96
95
  ],
97
96
  "rootPatterns": [
@@ -106,7 +105,13 @@ The intended `languageserver` shape is:
106
105
  }
107
106
  ```
108
107
 
109
- Replace the example path with the local checkout or installed package location on your machine.
108
+ For local development checkouts, an initial example lives in `examples/coc-settings.json`. The current bootstrap flow is:
109
+
110
+ 1. run `npm install`
111
+ 2. run `npm run build`
112
+ 3. point coc.nvim at `dist/src/cli.js --stdio`
113
+
114
+ The bundled example uses `node` plus an absolute path to the packaged CLI, passes `--stdio`, uses `package.json` and `.git` as root markers, and currently targets the `asm` filetype.
110
115
 
111
116
  ## Development notes
112
117
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@razdolbai/merls",
3
- "version": "0.1.0",
3
+ "version": "1.0.0",
4
4
  "description": "Language server for Merlin-style 6502 assembly.",
5
5
  "type": "commonjs",
6
6
  "bin": {