Skip to content

Commit 980ba2e

Browse files
committed
docs: add TOPOLOGY.md
1 parent e373421 commit 980ba2e

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

TOPOLOGY.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!-- SPDX-License-Identifier: MPL-2.0 -->
2+
<!-- (PMPL-1.0-or-later preferred; MPL-2.0 required for VS Code marketplace) -->
3+
<!-- Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk> -->
4+
# TOPOLOGY.md — vscode-k9
5+
6+
## Purpose
7+
8+
VS Code extension providing syntax highlighting, language configuration, and snippets for K9 contractile validator files. Supports both `.k9` (YAML-like Kennel format) and `.k9.ncl` (Nickel-based Yard/Hunt format). Published to the VS Code marketplace (MPL-2.0 required by platform).
9+
10+
## Module Map
11+
12+
```
13+
vscode-k9/
14+
├── syntaxes/ # TextMate grammars (K9 + Nickel variants)
15+
├── snippets/ # Code snippets for K9 patterns
16+
├── src/ # Extension TypeScript entry point
17+
├── icons/ # File type icons
18+
├── language-configuration.json # Config for .k9 (Kennel format)
19+
├── language-configuration-nickel.json # Config for .k9.ncl (Nickel format)
20+
├── package.json # VS Code extension manifest
21+
└── docs/ # Extension documentation
22+
```
23+
24+
## Data Flow
25+
26+
```
27+
[.k9 / .k9.ncl file opened] ──► [syntaxes/ grammar] ──► [syntax highlighting]
28+
└──► [snippets/] ──► [completions]
29+
└──► [language-configuration] ──► [bracket/comment behaviour]
30+
```

0 commit comments

Comments
 (0)