Repository navigation
ci(quality): measure the documented share of the TypeScript and Svelte code - #53
Merged
Merged
Conversation
The quality-reports job counts the exported functions, classes, types and components of src and webviews that have a JSDoc comment (docs-ts.json), next to the Python docstrings. Today: 78 of 175.
The quality-reports job now runs the shared docs-count script: exported items of .ts, .tsx, .js, .jsx and Svelte components, public methods of exported classes, components wrapped in memo or forwardRef, export default Name and export { Name }. Today: 86 of 183.
ulysse-bonneau-simvia
changed the title
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.
The
quality-reportsjob now counts the exported items ofsrcandwebviewsthat have a doc comment, and writesdocs-ts.json. The dashboard adds it to the Python docstrings in the Docs score..ts,.tsx,.js,.jsxand Svelte components. A Svelte component is one item, documented by a comment opening the file or its script; the functions it exports from its scripts count like any module.export default Nameandexport { Name }, and the public methods of exported classes..d.ts, stories, config files, build output.Today: 86 of 183 documented (47%), against 56.9% for the Python code alone. The step was run as written on csauto's identical workflow.