@archkit/core 0.1.0 → 0.2.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/README.md +36 -0
- package/package.json +4 -4
package/README.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# @archkit/core
|
|
2
|
+
|
|
3
|
+
Shared core types for the Arch ecosystem.
|
|
4
|
+
|
|
5
|
+
## What it provides
|
|
6
|
+
|
|
7
|
+
- Node and edge model types used across Arch packages
|
|
8
|
+
- Graph container interfaces for parser and graph services
|
|
9
|
+
- Source location and metadata contracts
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
pnpm add @archkit/core
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Quick usage
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
import type { ArchNode, ArchEdge, GraphData } from '@archkit/core'
|
|
21
|
+
|
|
22
|
+
const node: ArchNode = {
|
|
23
|
+
id: 'function:src/index.ts#run',
|
|
24
|
+
type: 'function',
|
|
25
|
+
name: 'run',
|
|
26
|
+
filePath: 'src/index.ts',
|
|
27
|
+
loc: { startLine: 1, endLine: 10 },
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
const graph: GraphData = { nodes: [node], edges: [] }
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## See also
|
|
34
|
+
|
|
35
|
+
- Main project docs: ../../README.md
|
|
36
|
+
- Architecture notes: ../../ARCHITECTURE.md
|
package/package.json
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@archkit/core",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
7
|
-
"url": "https://github.com/brent-broeckx/
|
|
7
|
+
"url": "https://github.com/brent-broeckx/archkit.git",
|
|
8
8
|
"directory": "packages/arch-core"
|
|
9
9
|
},
|
|
10
|
-
"homepage": "https://github.com/brent-broeckx/
|
|
10
|
+
"homepage": "https://github.com/brent-broeckx/archkit#readme",
|
|
11
11
|
"bugs": {
|
|
12
|
-
"url": "https://github.com/brent-broeckx/
|
|
12
|
+
"url": "https://github.com/brent-broeckx/archkit/issues"
|
|
13
13
|
},
|
|
14
14
|
"files": [
|
|
15
15
|
"dist"
|