@archkit/context 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.
Files changed (2) hide show
  1. package/README.md +32 -0
  2. package/package.json +6 -6
package/README.md ADDED
@@ -0,0 +1,32 @@
1
+ # @archkit/context
2
+
3
+ Context compilation for Arch.
4
+
5
+ ## What it does
6
+
7
+ - Ranks relevant symbols for a query
8
+ - Expands related call/import paths
9
+ - Selects bounded snippets and files for context sharing
10
+ - Produces deterministic context bundles
11
+
12
+ ## Install
13
+
14
+ ```bash
15
+ pnpm add @archkit/context
16
+ ```
17
+
18
+ ## Quick usage
19
+
20
+ ```ts
21
+ import { ContextCompiler } from '@archkit/context'
22
+
23
+ const compiler = new ContextCompiler()
24
+ const bundle = await compiler.compile(process.cwd(), { query: 'authentication' })
25
+
26
+ console.log(bundle.entrypoints)
27
+ ```
28
+
29
+ ## See also
30
+
31
+ - Main project docs: ../../README.md
32
+ - Architecture notes: ../../ARCHITECTURE.md
package/package.json CHANGED
@@ -1,15 +1,15 @@
1
1
  {
2
2
  "name": "@archkit/context",
3
- "version": "0.1.0",
3
+ "version": "0.2.0",
4
4
  "license": "MIT",
5
5
  "repository": {
6
6
  "type": "git",
7
- "url": "https://github.com/brent-broeckx/arch.git",
7
+ "url": "https://github.com/brent-broeckx/archkit.git",
8
8
  "directory": "packages/arch-context"
9
9
  },
10
- "homepage": "https://github.com/brent-broeckx/arch#readme",
10
+ "homepage": "https://github.com/brent-broeckx/archkit#readme",
11
11
  "bugs": {
12
- "url": "https://github.com/brent-broeckx/arch/issues"
12
+ "url": "https://github.com/brent-broeckx/archkit/issues"
13
13
  },
14
14
  "files": [
15
15
  "dist"
@@ -27,8 +27,8 @@
27
27
  }
28
28
  },
29
29
  "dependencies": {
30
- "@archkit/core": "0.1.0",
31
- "@archkit/graph": "0.1.0"
30
+ "@archkit/core": "0.2.0",
31
+ "@archkit/graph": "0.2.0"
32
32
  },
33
33
  "scripts": {
34
34
  "build": "tsc -p tsconfig.json",