@ccdd/core 3.1.0 → 3.1.2
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 +5 -35
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
# CCDD
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/@ccdd/project)
|
|
4
|
+
[](https://cdd.boardsketch.com)
|
|
5
|
+
|
|
3
6
|
**Check that the pieces of your project fit together.**
|
|
4
7
|
|
|
5
8
|
A project has requirements, designs, tests, and implementations. CCDD connects these pieces to the checks that review them. An AI agent can compare a design with its requirements, a person can inspect an image, and a test runner can check an implementation.
|
|
@@ -10,40 +13,7 @@ You choose the materials, the review criteria, and the tools reviewers can use.
|
|
|
10
13
|
|
|
11
14
|
**Blue dashed lines: configuration. Orange solid lines: requests and reviews.**
|
|
12
15
|
|
|
13
|
-
|
|
14
|
-
flowchart LR
|
|
15
|
-
subgraph PROJECT["Your project"]
|
|
16
|
-
direction TB
|
|
17
|
-
REQUIREMENTS["Requirements"]
|
|
18
|
-
DESIGN["Design"]
|
|
19
|
-
TESTS["Tests"]
|
|
20
|
-
IMPLEMENTATION["Implementation"]
|
|
21
|
-
|
|
22
|
-
REQUIREMENTS -.->|"Design Critic"| DESIGN
|
|
23
|
-
REQUIREMENTS -.->|"Test Critic"| TESTS
|
|
24
|
-
DESIGN -.->|"Implementation Critic"| IMPLEMENTATION
|
|
25
|
-
TESTS -.->|"Implementation Critic"| IMPLEMENTATION
|
|
26
|
-
end
|
|
27
|
-
|
|
28
|
-
subgraph CCDD["CCDD"]
|
|
29
|
-
direction TB
|
|
30
|
-
ARTIFACTS["Artifact layer<br/>Materials and tools"]
|
|
31
|
-
VALIDATION["Validation<br/>Checks, reuse, and reviews"]
|
|
32
|
-
end
|
|
33
|
-
|
|
34
|
-
subgraph REVIEWERS["Reviewers"]
|
|
35
|
-
REVIEWER["AI agent<br/>Person<br/>Test runner"]
|
|
36
|
-
end
|
|
37
|
-
|
|
38
|
-
PROJECT -.->|"Register Artifacts and tools"| ARTIFACTS
|
|
39
|
-
PROJECT -.->|"Define Critics"| VALIDATION
|
|
40
|
-
PROJECT <-->|"Request / result"| VALIDATION
|
|
41
|
-
VALIDATION <-->|"Review / findings"| REVIEWER
|
|
42
|
-
ARTIFACTS <-->|"Access / observations"| REVIEWER
|
|
43
|
-
|
|
44
|
-
linkStyle 0,1,2,3,4,5 stroke:#3b82f6,stroke-width:2px
|
|
45
|
-
linkStyle 6,7,8 stroke:#f59e0b,stroke-width:3px
|
|
46
|
-
```
|
|
16
|
+
|
|
47
17
|
|
|
48
18
|
Three terms explain the picture:
|
|
49
19
|
|
|
@@ -53,7 +23,7 @@ Three terms explain the picture:
|
|
|
53
23
|
| **Critic** | A check with one target, reference materials, and a reviewer. | “Does this design meet these requirements?” |
|
|
54
24
|
| **Artifact tool** | A way for a reviewer to inspect an Artifact. | Read text, view an image, or open a desktop application. |
|
|
55
25
|
|
|
56
|
-
Each Critic declares its target and references. These relationships form a directed acyclic graph, or **DAG**: checks can branch and join, but cannot depend on themselves through a cycle.
|
|
26
|
+
Each Critic declares its target and references. These relationships form a directed acyclic graph, or **DAG**: checks can branch and join, but cannot depend on themselves through a cycle. Design and Tests connect to Implementation through separate Critic lines. Requirements are an explicitly accepted starting point in this example.
|
|
57
27
|
|
|
58
28
|
## What you do
|
|
59
29
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ccdd/core",
|
|
3
|
-
"version": "3.1.
|
|
3
|
+
"version": "3.1.2",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"publishConfig": { "access": "public", "registry": "https://registry.npmjs.org/" },
|
|
6
6
|
"repository": { "type": "git", "url": "git+https://github.com/lhj6102/ccdd.git" },
|
|
@@ -21,8 +21,8 @@
|
|
|
21
21
|
"typecheck:ui": "node src/monitor/ui/typecheck.cjs -p tsconfig.ui.json --noEmit",
|
|
22
22
|
"typecheck": "node node_modules/typescript/bin/tsc -p tsconfig.json --noEmit && npm run typecheck:ui",
|
|
23
23
|
"check:language": "node scripts/check-language.mjs",
|
|
24
|
-
"test": "npm run check:language && npm run build && node --test dist/test/*.test.js",
|
|
25
|
-
"test:packages": "
|
|
24
|
+
"test": "npm run check:language && npm run build && node --test --test-reporter=tap --test-concurrency=4 dist/test/*.test.js",
|
|
25
|
+
"test:packages": "node scripts/smoke-project.mjs",
|
|
26
26
|
"prepack": "npm run build",
|
|
27
27
|
"release": "node scripts/local-release.mjs",
|
|
28
28
|
"release:npm": "node scripts/local-release.mjs --npm",
|