@c4a/extract-rush 0.6.8 → 0.6.9

package/README.md

@@ -1,14 +1,60 @@
-# @c4a/extract-rush
+# Rush Workspace Structure for Context
 
-Deterministic Rush workspace indexing for package identity, tags, subspaces,
-entry signals, local dependency edges, decoupled dependencies, and nearest
-`OWNERS` boundaries. Product-specific categories remain the consumer's concern.
+[简体中文](./README.zh-CN.md)
+
+`@c4a/extract-rush` creates a deterministic structural index of a Rush
+workspace. It reports project identity, tags, subspaces, publish intent, entry
+signals, local dependency edges, decoupled dependencies, and nearest `OWNERS`
+boundaries.
+
+The index is evidence for a Context knowledge project; it is not a product
+taxonomy. A project decides which facts matter to its audience and maps them to
+candidates through `extractCustom()`. Context continues to own source identity,
+candidate freshness, review, approved knowledge, and package output.
+
+## Place in the knowledge workflow
+
+```text
+confirmed Rush repository boundary
+              ↓
+rush.json + package.json + OWNERS facts
+              ↓
+project-owned candidate mapping
+              ↓
+reviewed architecture / ownership / package knowledge
+```
+
+## Usage
 
 ```ts
 import { indexRushWorkspace } from "@c4a/extract-rush";
 
-const facts = await indexRushWorkspace(repositoryRoot, { tags: ["frontend"] });
+const facts = await indexRushWorkspace(repositoryRoot, {
+  tags: ["frontend"],
+});
 ```
 
-This optional package does not add a Context CLI phase. A knowledge project can
-map the returned facts to candidates in its own `extractCustom()` callback.
+With no tag filter, all projects are selected. `includeAll: true` explicitly
+selects every project. Results are sorted and stable, making them suitable for
+source fingerprints and repeatable candidate generation.
+
+The index includes:
+
+- Rush and package-manager versions;
+- package names and whether `package.json` identity matches `rush.json`;
+- project folders, subspaces, tags, and publish flags;
+- `main`, `module`, `types`, `exports`, and `bin` entry signals;
+- local dependency kinds and specifiers, including decoupled edges;
+- nearest repository-relative `OWNERS` file and normalized reviewers.
+
+This optional package does not add a public Agent entry or Context lifecycle
+phase. It remains a reusable structural library for project adapters.
+
+## Development
+
+```bash
+bun run --filter @c4a/extract-rush build
+bun run --filter @c4a/extract-rush typecheck
+bun run --filter @c4a/extract-rush test
+bun run --filter @c4a/extract-rush lint
+```

package/README.zh-CN.md

@@ -1,13 +1,56 @@
-# @c4a/extract-rush
+# Context Rush 工作区结构
 
-确定性索引 Rush 工作区中的包身份、标签、subspace、入口信号、本地依赖边、
-解耦依赖以及最近的 `OWNERS` 边界。业务分类由调用方自行维护。
+[English](./README.md)
+
+`@c4a/extract-rush` 为 Rush 工作区生成确定性结构索引。它报告项目身份、标签、
+subspace、发布意图、入口信号、本地依赖边、解耦依赖和最近的 `OWNERS` 边界。
+
+这些索引是 Context 知识项目的证据，不是产品分类。项目决定哪些事实对目标读者有
+价值，并通过 `extractCustom()` 映射为候选；来源身份、候选新鲜度、审核、正式知识
+和知识包产出继续由 Context 负责。
+
+## 在知识生产链中的位置
+
+```text
+已确认的 Rush 仓库边界
+           ↓
+rush.json + package.json + OWNERS 事实
+           ↓
+项目自有候选映射
+           ↓
+经过审核的架构 / 归属 / package 知识
+```
+
+## 使用
 
 ```ts
 import { indexRushWorkspace } from "@c4a/extract-rush";
 
-const facts = await indexRushWorkspace(repositoryRoot, { tags: ["frontend"] });
+const facts = await indexRushWorkspace(repositoryRoot, {
+  tags: ["frontend"],
+});
 ```
 
-这是可选包，不会给 Context CLI 增加阶段。知识项目可以在自己的
-`extractCustom()` 回调中把这些事实映射为候选。
+不提供 tag filter 时选择所有项目；`includeAll: true` 也会显式选择全部项目。结果
+经过排序并保持稳定，适合生成来源指纹和可重复的候选。
+
+索引包含：
+
+- Rush 和 package manager 版本；
+- package 名，以及 `package.json` 身份是否与 `rush.json` 一致；
+- project folder、subspace、tag 和 publish flag；
+- `main`、`module`、`types`、`exports` 和 `bin` 入口信号；
+- 本地依赖类型和 specifier，包括 decoupled edge；
+- 最近的 repo-relative `OWNERS` 文件和标准化 reviewer。
+
+这个可选包不会增加公开 Agent 入口或 Context 生命周期阶段，只作为项目 Adapter
+可以复用的结构库。
+
+## 开发
+
+```bash
+bun run --filter @c4a/extract-rush build
+bun run --filter @c4a/extract-rush typecheck
+bun run --filter @c4a/extract-rush test
+bun run --filter @c4a/extract-rush lint
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@c4a/extract-rush",
-  "version": "0.6.8",
+  "version": "0.6.9",
   "type": "module",
   "description": "Rush workspace structural index for Context",
   "license": "MIT",