Documentation, ESLint, and Repository Instructions Updates#61
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request tightens and normalizes JSDoc across the TypeScript utility modules, introduces ESLint JSDoc linting for src/**/*.ts, and refreshes the versioned TypeDoc release documentation output under docs/releases/.
Changes:
- Add
eslint-plugin-jsdocand enforce a comprehensive JSDoc ruleset forsrc/**/*.ts. - Update/expand JSDoc summaries and tag descriptions across several utility classes to align with stricter linting.
- Commit regenerated TypeDoc HTML assets for
v0.1.0-alpha.2underdocs/releases/....
Reviewed changes
Copilot reviewed 44 out of 50 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/string/string-utility.ts | Expands JSDoc summaries/descriptions to satisfy stricter JSDoc linting. |
| src/string/color-string-utility.ts | Expands JSDoc summaries/descriptions to satisfy stricter JSDoc linting. |
| src/random/weighted-element/weighted-element.ts | Reorders/normalizes JSDoc tags for schema/interface docs. |
| src/random/weighted-element/weighted-element-utility.ts | Adds JSDoc detail for object-parameter fields. |
| src/random/seeded-random/seeded-random-number-generator.ts | Improves JSDoc completeness (constructor/methods/internal validation docs). |
| src/random/seeded-random/seed-versions.ts | Improves JSDoc completeness for static class members. |
| src/random/seeded-random/random-number-generator-factory.ts | Improves JSDoc clarity and corrects async return typing documentation. |
| src/random/random.ts | Improves JSDoc completeness for Random API and internal validators. |
| src/number/number-utility.ts | Improves JSDoc parameter descriptions and static-class constructor docs. |
| src/discriminator/discriminator-registry.ts | Normalizes JSDoc tag ordering and adds constructor/spacing tweaks. |
| src/discriminator/discriminated.ts | Normalizes JSDoc tag ordering in schema docs. |
| package.json | Adds eslint-plugin-jsdoc dev dependency. |
| eslint.config.ts.mjs | Enables eslint-plugin-jsdoc with a strict ruleset for src/**/*.ts. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/variables/random.weightedElementSchema.html | Adds generated TypeDoc output for the release docs site. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/variables/discriminator.discriminatedSchema.html | Adds generated TypeDoc output for the release docs site. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/types/random.WeightedList.html | Adds generated TypeDoc output for the release docs site. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/types/discriminator.TypeGuard.html | Adds generated TypeDoc output for the release docs site. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/types/discriminator.Discriminated.html | Adds generated TypeDoc output for the release docs site. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/modules/string.html | Adds generated TypeDoc module index output. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/modules/random.html | Adds generated TypeDoc module index output. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/modules/number.html | Adds generated TypeDoc module index output. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/modules/discriminator.html | Adds generated TypeDoc module index output. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/modules.html | Adds generated TypeDoc top-level modules page. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/interfaces/random.WeightedElement.html | Adds generated TypeDoc interface docs. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/interfaces/random.SeedVersion.html | Adds generated TypeDoc interface docs. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/interfaces/discriminator.DiscriminatorRegistration.html | Adds generated TypeDoc interface docs. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/index.html | Adds generated TypeDoc docs landing page for the release. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/hierarchy.html | Adds generated TypeDoc hierarchy page. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/enums/discriminator.Discriminators.html | Adds generated TypeDoc enum docs. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/classes/random.SeededRandomNumberGenerator.html | Adds generated TypeDoc class docs. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/assets/search.js | Adds generated TypeDoc search index asset. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/assets/navigation.js | Adds generated TypeDoc navigation asset. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/assets/icons.svg | Adds generated TypeDoc icon asset bundle. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/assets/highlight.css | Adds generated TypeDoc highlight styling. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/assets/hierarchy.js | Adds generated TypeDoc hierarchy data asset. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/.nojekyll | Adds TypeDoc-generated .nojekyll marker file for the release docs subtree. |
| CLAUDE.md | Replaces embedded command list with a pointer to .github/copilot-instructions.md. |
Files not reviewed (4)
- docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/assets/icons.js: Generated file
- docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/assets/main.js: Generated file
- docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/assets/navigation.js: Generated file
- docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/assets/search.js: Generated file
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.
No description provided.