proschi 0.1.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.
- package/LICENSE +21 -0
- package/README.md +33 -0
- package/dist/cli.cjs +957 -0
- package/dist/server.cjs +11223 -0
- package/grammar/proschi.tmLanguage.json +236 -0
- package/package.json +56 -0
- package/schema/proschi-diagram.schema.json +512 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 gvart and Proschi contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# proschi
|
|
2
|
+
|
|
3
|
+
Command-line checker and language server for
|
|
4
|
+
[Proschi](https://gvart.github.io/proschi/), a small text language for
|
|
5
|
+
microservice architectures and the request flows that run through them.
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm install -g proschi
|
|
9
|
+
proschi check docs/ # validate every *.proschi file below docs/
|
|
10
|
+
proschi parse checkout.proschi # the parsed diagram as JSON
|
|
11
|
+
proschi-language-server --stdio # for any editor with an LSP client
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Both commands run the parser of the web editor, so they report exactly what
|
|
15
|
+
the editor reports. Setup for VS Code, IntelliJ, Neovim, Helix, Sublime Text
|
|
16
|
+
and CI: [docs/EDITORS.md](https://github.com/gvart/proschi/blob/main/docs/EDITORS.md).
|
|
17
|
+
|
|
18
|
+
Also in this package:
|
|
19
|
+
|
|
20
|
+
- `grammar/proschi.tmLanguage.json`: TextMate grammar for syntax highlighting
|
|
21
|
+
- `schema/proschi-diagram.schema.json`: JSON Schema of `proschi parse` output
|
|
22
|
+
|
|
23
|
+
## Development
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
npm ci
|
|
27
|
+
npm test # builds, then runs the tests (CLI, server over stdio, grammar, schema)
|
|
28
|
+
npm run typecheck
|
|
29
|
+
npm run package:vscode # dist/proschi.vsix
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
`npm run build` also regenerates the JSON Schema; a test fails if the committed
|
|
33
|
+
copy is out of date.
|