deepseek-harness/scripts
Tianyi Cui cd9737d569 Gate JSDoc completeness on every package export
New doc-sync gate verify-export-jsdoc walks every module-level exported
name under packages/*/*/src and requires description prose everywhere,
plus @param per parameter and @returns on non-void annotated returns for
function-like exports, public class methods, properties, and accessors.
The parsing + check helpers move out of gen-cordis-catalog.ts into a
shared scripts/jsdoc.ts so 'documented' means one thing on both gated
surfaces.

Deliberate exemptions (documented in the RFC): heritage-declared class
members (the seam declaration is the doc's one home — the one checker
query in an otherwise pure-AST walk), cordis plugin-protocol slots
(name/inject/reusable/Config/apply, top-level and static), constructors,
overload implementations, declare-module augmentation bodies, and
re-export statements (checked at the defining module).

The 203 under-documented exports the gate found at adoption are filled
in this change, so the gate lands green; generated catalogs/graphs are
regenerated for the shifted line pointers.

RFC: docs/rfc/implemented/process/2026-07-06-export-surface-jsdoc-gate.md
2026-07-06 22:09:30 +08:00
..
check-vendor-manifest.sh Add lefthook git hooks with a vendor-manifest guard 2026-06-11 15:07:55 +08:00
check-workspace-constraints.ts scripts: ignore local artifacts in constraints 2026-07-04 00:57:35 +08:00
doc-budgets.manifest.json Clarify condensing in doc budget guidance 2026-07-06 16:31:18 +08:00
doc-typecheck.ts Add generated persistence log event catalog with freshness + completeness gates 2026-07-04 22:58:28 +08:00
gen-cordis-catalog.ts Gate JSDoc completeness on every package export 2026-07-06 22:09:30 +08:00
gen-doc-graphs.ts Move ACP snapshot replay doc into package 2026-07-06 00:52:06 +08:00
gen-module-graph.ts docs: revise graph docs from review 2026-07-05 01:25:58 +08:00
gen-persistence-catalog.ts Split the cordis catalog into separate events and services documents 2026-07-05 00:45:06 +08:00
gen-rfc-index.ts docs(rfc): define and enforce a uniform RFC format; adopt it across the corpus 2026-07-05 22:58:25 +08:00
gen-tool-catalog.ts Merge remote-tracking branch 'origin/master' into codex/docs-graph-brainstorm 2026-07-05 02:16:26 +08:00
install-lefthook.mjs fix(dev): make hooks and bash seams safer 2026-06-17 21:26:44 +08:00
jsdoc.ts Gate JSDoc completeness on every package export 2026-07-06 22:09:30 +08:00
publint-all.ts scripts: lint only package directories 2026-07-04 00:54:31 +08:00
rfc-index.ts docs(rfc): define and enforce a uniform RFC format; adopt it across the corpus 2026-07-05 22:58:25 +08:00
translation-pairing.manifest.json Add generated persistence log event catalog with freshness + completeness gates 2026-07-04 22:58:28 +08:00
type-equiv.manifest.json docs: the governing principle — every LLM request is reconstructable from the session log 2026-07-06 03:49:35 +08:00
verify-doc-budgets.ts docs(budgets): ceilings carry at least 5% working headroom 2026-07-04 17:20:18 +08:00
verify-doc-refs.ts docs: split cordis primer from architecture map 2026-07-05 19:07:34 +08:00
verify-export-jsdoc.ts Gate JSDoc completeness on every package export 2026-07-06 22:09:30 +08:00
verify-md-links.ts docs: bilingual docs contract, translation skill, and pairing gate 2026-07-02 23:12:25 -07:00
verify-md-wrap.ts docs(AGENTS): rewrite the root standing orders to the 1,500-word budget 2026-07-04 14:22:47 +08:00
verify-mermaid.ts docs: revise graph docs from review 2026-07-05 01:25:58 +08:00
verify-node-next-types.ts docs: update rewriteRelativeImportExtensions to current rfc 2026-06-22 09:03:28 +08:00
verify-package-paths.ts fix review findings: don't treat disabled entries as load failures; scope the verify-package-paths lib skip to a real package root 2026-06-21 19:47:22 +08:00
verify-rfc-classification.ts docs(rfc): define and enforce a uniform RFC format; adopt it across the corpus 2026-07-05 22:58:25 +08:00
verify-rfc-format.ts docs(rfc): address Codex review — fence-aware format gate, exact corpus counts 2026-07-05 23:45:34 +08:00
verify-translation-pairing.ts docs: equal-authority pairing with sidecar consistency records 2026-07-03 07:41:24 -07:00
verify-type-equiv.ts Reorganize packages into a modular hierarchy 2026-06-20 22:55:20 +08:00