Conversation
added 14 commits
November 21, 2023 14:26
ballercat
marked this pull request as ready for review
November 29, 2023 15:48
|
…or TS7 - typescript ^7.0.2 (Go-native tsc) - typedoc ^0.28.20 with dedicated TS 6.0.3 in typedoc/node_modules - tsconfig: module=NodeNext (required by TS7), checkJs=false - Add typedoc.json config (entrypoint src/index.ts, output docs/) - Add 'typecheck' and 'docs' npm scripts - Add legacy-peer-deps=true to .npmrc - Add npm overrides for typedoc peer dep isolation - Switch @ts-check files with errors to @ts-nocheck (pre-existing issues) - Export StatusCode type from src/index.ts - Add src/diagnostics.js (renamed from .cjs in main branch)
- Add class/method JSDoc to core: Cache, Config, Jambox, Emitter - Add JSDoc to handlers (CacheHandler, ProxyHandler), matchers (CacheMatcher, GlobMatcher), server routes, Broadcaster - Add JSDoc to utils: serialize, deserialize, tiny-server, debounce - Add JSDoc to small utilities: constants, store, noop, is-uri, browser, entrypoint, read-user-config Fixes for ESM/CJS correctness under "type": "module": - Repoint Config/Jambox imports from diagnostics.js to diagnostics.cjs (the .js CJS file is not loadable as ESM; .cjs was the original) - Rename read-user-config.js -> read-user-config.cjs (CJS module) - Rename manifest-plugin.js -> manifest-plugin.cjs and fix webpack config import (fixes pre-existing webpack build failure from merge) Verified: tsc clean, typedoc builds, 33/33 ava tests pass, webpack compiles
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
1 participant
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.
Leaning into JSDoc & TypeScript type comments.
Using
typedocto generate documentation.