Skip to content

Commit d95d016

Browse files
author
DavidQ
committed
BUILD PR: add minimal usage doc for shared extraction guard.
1 parent 7a02534 commit d95d016

6 files changed

Lines changed: 61 additions & 6 deletions

docs/dev/CODEX_COMMANDS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
MODEL: GPT-5.3-codex
22
REASONING: high
33
COMMAND:
4-
Execute docs/pr/BUILD_PR_SHARED_EXTRACTION_22_ADD_GUARD_RUN_SCRIPT.md exactly.
4+
Execute docs/pr/BUILD_PR_SHARED_EXTRACTION_23_GUARD_DOC_MINIMAL_USAGE.md exactly.
55
Create only:
6-
- tools/dev/runSharedExtractionGuard.sh
6+
- docs/dev/SHARED_EXTRACTION_GUARD_USAGE.md
77
Do not expand scope.
8-
Package delta to <project folder>/tmp/BUILD_PR_SHARED_EXTRACTION_22_ADD_GUARD_RUN_SCRIPT_delta.zip
8+
Package delta to <project folder>/tmp/BUILD_PR_SHARED_EXTRACTION_23_GUARD_DOC_MINIMAL_USAGE_delta.zip

docs/dev/COMMIT_COMMENT.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
BUILD PR: add simple script to run shared extraction guard.
1+
BUILD PR: add minimal usage doc for shared extraction guard.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# SHARED_EXTRACTION_GUARD_USAGE
2+
3+
## Run
4+
- `node tools/dev/checkSharedExtractionGuard.mjs`
5+
- `npm run check:shared-extraction-guard` (if present)
6+
- `./tools/dev/runSharedExtractionGuard.sh`
7+
8+
## What It Checks
9+
- duplicate helpers (`asFiniteNumber`, `asPositiveInteger`, `isPlainObject`)
10+
- bad shared imports (fragile relative shared paths)
11+
- alias usage (`@shared/`)
12+
13+
## What Failure Means
14+
- One or more files violate shared-extraction guard rules and must be corrected before proceeding.
15+
16+
## Fix Violations
17+
- remove local duplicate helper definitions
18+
- replace disallowed shared import paths with approved paths
19+
- remove `@shared/` alias imports and use approved relative imports
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Adds simple guard runner script.
1+
Adds guard usage documentation.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
script added correctly
1+
doc added correctly
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# BUILD_PR_SHARED_EXTRACTION_23_GUARD_DOC_MINIMAL_USAGE
2+
3+
## Purpose
4+
Add minimal documentation describing how to run and interpret the shared-extraction guard.
5+
6+
## Single PR Purpose
7+
Create one doc file:
8+
9+
docs/dev/SHARED_EXTRACTION_GUARD_USAGE.md
10+
11+
## Exact Files Allowed
12+
1. docs/dev/SHARED_EXTRACTION_GUARD_USAGE.md (new file)
13+
14+
## Exact Content
15+
16+
Include:
17+
- how to run:
18+
- node tools/dev/checkSharedExtractionGuard.mjs
19+
- npm run check:shared-extraction-guard (if present)
20+
- ./tools/dev/runSharedExtractionGuard.sh
21+
- what it checks:
22+
- duplicate helpers
23+
- bad shared imports
24+
- alias usage
25+
- what failure means
26+
- how to fix violations (short bullet list)
27+
28+
## Rules
29+
- no other files
30+
- no config changes
31+
- no logic changes
32+
33+
## Validation
34+
1. file exists
35+
2. content matches scope
36+
3. no other files changed

0 commit comments

Comments
 (0)