@contextforge/core 0.1.9 → 0.1.10

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 +60 -0
  2. package/package.json +26 -2
package/README.md ADDED
@@ -0,0 +1,60 @@
1
+ # ContextForge Core
2
+
3
+ Website: https://contextforge.org
4
+
5
+ `@contextforge/core` contains the detection, registry, sync, doctor, config, lockfile, and generation logic used by the ContextForge CLI.
6
+
7
+ Most users should run the CLI:
8
+
9
+ ```bash
10
+ npx @contextforge/cli init
11
+ ```
12
+
13
+ ## What Core Handles
14
+
15
+ - Detects project stacks such as Next.js, TypeScript, Tailwind, shadcn/ui, Prisma, Drizzle, Vitest, Jest, and Playwright.
16
+ - Fetches the official remote registry.
17
+ - Resolves pack manifests and pack files.
18
+ - Installs instruction content under `.contextforge`.
19
+ - Writes and migrates `.contextforge/config.json`.
20
+ - Writes `.contextforge/lock.json`.
21
+ - Generates small root pointer files for `AGENTS.md` and `CLAUDE.md`.
22
+ - Runs `doctor` checks for missing files, stale packs, and mismatched project state.
23
+
24
+ ## Official Registry
25
+
26
+ ```txt
27
+ https://registry.contextforge.org/index.json
28
+ ```
29
+
30
+ ## Generated Layout
31
+
32
+ Core writes prompt content under `.contextforge`:
33
+
34
+ ```txt
35
+ .contextforge/
36
+ config.json
37
+ lock.json
38
+ agents/
39
+ codex/<pack>.md
40
+ claude/<pack>.md
41
+ cursor/<pack>.md
42
+ copilot/<pack>.md
43
+ skills/
44
+ <pack>/SKILL.md
45
+ ```
46
+
47
+ Root `AGENTS.md` and `CLAUDE.md` files are pointer files only. They tell agents to read `.contextforge`.
48
+
49
+ ## Links
50
+
51
+ - Website: https://contextforge.org
52
+ - Main repo: https://github.com/Alone-Y154/ContextForge
53
+ - Registry repo: https://github.com/Alone-Y154/ContextForge-registry
54
+ - npm CLI: https://www.npmjs.com/package/@contextforge/cli
55
+ - npm Core: https://www.npmjs.com/package/@contextforge/core
56
+ - Registry: https://registry.contextforge.org/index.json
57
+
58
+ ## License
59
+
60
+ MIT
package/package.json CHANGED
@@ -1,7 +1,30 @@
1
1
  {
2
2
  "name": "@contextforge/core",
3
- "version": "0.1.9",
3
+ "version": "0.1.10",
4
+ "description": "Core detection, registry, sync, and generation logic for ContextForge.",
4
5
  "type": "module",
6
+ "homepage": "https://contextforge.org",
7
+ "license": "MIT",
8
+ "repository": {
9
+ "type": "git",
10
+ "url": "git+https://github.com/Alone-Y154/ContextForge.git",
11
+ "directory": "packages/core"
12
+ },
13
+ "bugs": {
14
+ "url": "https://github.com/Alone-Y154/ContextForge/issues"
15
+ },
16
+ "keywords": [
17
+ "ai",
18
+ "agents",
19
+ "codex",
20
+ "claude-code",
21
+ "cursor",
22
+ "github-copilot",
23
+ "developer-tools",
24
+ "cli",
25
+ "prompt-engineering",
26
+ "typescript"
27
+ ],
5
28
  "main": "./dist/index.js",
6
29
  "types": "./dist/index.d.ts",
7
30
  "exports": {
@@ -11,7 +34,8 @@
11
34
  }
12
35
  },
13
36
  "files": [
14
- "dist"
37
+ "dist",
38
+ "README.md"
15
39
  ],
16
40
  "dependencies": {
17
41
  "fast-glob": "^3.3.3",