@brainervirus/workit-core 6.0.0 → 6.0.1
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 +16 -34
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,42 +1,24 @@
|
|
|
1
1
|
# @brainervirus/workit-core
|
|
2
2
|
|
|
3
3
|
[](https://github.com/BrainerVirus/workit/actions/workflows/ci.yml)
|
|
4
|
-
[](
|
|
4
|
+
[](https://www.npmjs.com/package/@brainervirus/workit-core)
|
|
5
|
+
[](https://github.com/BrainerVirus/workit/blob/main/LICENSE)
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
The shared core of [Workit](https://github.com/BrainerVirus/workit): task event store, run ledger,
|
|
8
|
+
policy, checks, forge and stack logic, host-hook protocol, and the single
|
|
9
|
+
source of the eleven method skills. Every host adapter and the CLI bundle it.
|
|
8
10
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
You consume `@brainervirus/workit-core` directly only when:
|
|
14
|
-
|
|
15
|
-
- Building a new host adapter (e.g. a future `codex/` adapter) that maps a host's native surfaces to the shared `src/core/` logic.
|
|
16
|
-
- Reading the canonical source of workflow behavior: task and policy engine, approval flow, commit/PR, changelog, YouTrack, doctor, and diagnostics.
|
|
17
|
-
|
|
18
|
-
## Layout and ownership
|
|
11
|
+
End users do not install this package; install the CLI or a host plugin (see
|
|
12
|
+
the [root README](https://github.com/BrainerVirus/workit#quickstart)). Use it directly only to build a
|
|
13
|
+
new host adapter.
|
|
19
14
|
|
|
20
15
|
| Path | Contents |
|
|
21
16
|
| --- | --- |
|
|
22
|
-
| `src
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
## Exports
|
|
31
|
-
|
|
32
|
-
- Main entry: `./src/core.ts`.
|
|
33
|
-
- Subpath exports: `./src/*.ts` (e.g. `@brainervirus/workit-core/src/core/task-store`), plus `./package.json`.
|
|
34
|
-
- Setup, doctor, upgrade, uninstall and host-install code lives in `@brainervirus/workit-cli` (`src/admin/`), not here, so host hooks and plugins never bundle it.
|
|
35
|
-
|
|
36
|
-
## Package scripts
|
|
37
|
-
|
|
38
|
-
```bash
|
|
39
|
-
bun run typecheck # tsc --noEmit
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
Core has no build step — the adapters bundle it at build time. See the root [README](../../README.md) for the full development, CI, and versioning notes.
|
|
17
|
+
| `src/` | Store, ledger, checks, forge, stack, grants, hooks (`src/hooks/`), task/policy engine (`src/core/`) |
|
|
18
|
+
| `skills/` | The `workit-*` method skills; adapters ship generated copies |
|
|
19
|
+
| `scripts/` | Installers, launchers and release helpers |
|
|
20
|
+
| `templates/` | Contract and issue-update templates |
|
|
21
|
+
|
|
22
|
+
Exports: `./src/core.ts` and `./src/*.ts` subpaths. Setup, doctor, upgrade and
|
|
23
|
+
uninstall live in `@brainervirus/workit-cli`. There is no build step; adapters
|
|
24
|
+
bundle core. Development: [AGENTS.md](https://github.com/BrainerVirus/workit/blob/main/AGENTS.md).
|
package/package.json
CHANGED