Skip to content

[codex] Clarify TypeScript source and generated artifacts#119

Merged
albert-einshutoin merged 1 commit into
developfrom
codex/oss-source-generated-boundary
May 11, 2026
Merged

[codex] Clarify TypeScript source and generated artifacts#119
albert-einshutoin merged 1 commit into
developfrom
codex/oss-source-generated-boundary

Conversation

@albert-einshutoin
Copy link
Copy Markdown
Owner

Summary

  • Add .gitattributes so GitHub language stats treat compiled package JS, declarations, golden fixtures, coverage, and example dist output as generated.
  • Update README and CONTRIBUTING in English/Japanese to make src/**/*.ts the contributor-facing source boundary.
  • Document that root JS and .d.ts files are committed package artifacts generated by npm run build:ts, while templates remain hand-written runtime sources.
  • Update fast-uri in package-lock.json to 3.1.2 so the PR passes the current high-severity npm audit gate.

Why

The repository currently looks more JavaScript-heavy than it is because npm package artifacts and generated drift fixtures are committed. For OSS contributors, the project should make the editable source, generated artifacts, and package distribution boundary explicit.

Validation

  • git check-attr linguist-generated -- bin/cli.js src/bin/cli.ts scripts/compile.js src/scripts/compile.ts tests/golden/base/edge/viewer-request.js templates/aws/viewer-request.js src/types/policy.d.ts package-lock.json
  • npm audit --audit-level=high
  • npm run test:api-contract
  • npm run test:package

@albert-einshutoin albert-einshutoin marked this pull request as ready for review May 10, 2026 15:58
@albert-einshutoin albert-einshutoin merged commit b9a1c56 into develop May 11, 2026
5 checks passed
@albert-einshutoin albert-einshutoin deleted the codex/oss-source-generated-boundary branch May 11, 2026 01:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant