docs: track untyped-JS / no-static-type-checking as tech debt#74
Merged
Conversation
…king Distinct from the existing 'publishes no .d.ts' entry: this covers checking bwin's own source (sash.store, config->sash compile, actions contract, public API). Recommends an incremental tsconfig + checkJs + JSDoc path over a big-bang .ts conversion, and cross-links both entries.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a new
[low]tech-debt entry todocs/TECH_DEBT.md: "Source is untyped JavaScript — no static type checking."Placed just above the existing "bwin publishes no TypeScript types" entry, with cross-links both ways.
Why
The two are related but distinct, and the existing entry only covered one side:
.d.ts, so consumers hand-maintain adeclare module 'bwin'shim (output gap).tsconfig, nocheckJs, no JSDoc types. The shapes that matter most (sash.storekeys, the config→sash compile output, the actionsundefined-vs-nullcontract, the public API) are enforced only at runtime and documented only in prose.Notes
bw-pot/bw-glass-actionrename and the in-flight drag-and-drop rework, plus drift against thereact-bwinshim.tsconfig+allowJs/checkJs+ JSDoc path (starting at the public API /store/config/sashshapes) over a big-bang.tsconversion — and notes acheckJssetup that emits.d.tswould subsume the entry below it.Docs-only change. Branched from
main(TECH_DEBT.md is identical there), independent ofrefactor/drag-and-drop.