docs: add JSDoc to component props and story descriptions, update claude.md and other small build fixes#59
Merged
Conversation
Documents every public prop across all component types.ts/type.ts files so IDE autocomplete surfaces what each prop does, reusing the wording already written for Storybook's argTypes where available. Also adds a one-line description above every named story export explaining what it demonstrates. Adds eslint-plugin-jsdoc with jsdoc/multiline-blocks and jsdoc/lines-before-block, scoped to types.ts/type.ts, to keep prop JSDoc single-line with a blank line above going forward.
Only Default and Header were covered before, leaving selected, text2, text3, and button undocumented in Storybook. Adds one story per missing variant plus an AllVariants story that renders them all side by side for quick visual comparison.
Captures which files to create/update when adding a new component or a new prop to an existing one, and the commit type/scope conventions this repo relies on for automatic changelog and version generation.
The browserslist config already excludes dead browsers (which covers IE11), and this library's own peer deps — react@^18 and @mui/material@^6||^7 — dropped IE11 support already. Targeting ES5 was just adding class/generator-emulation overhead for a browser baseline nothing here actually supports anymore.
Without an explicit "include", tsc scans the whole project directory for inputs. Since "dist" wasn't excluded, any previously-built .d.ts files sitting there got picked up as inputs too, colliding with the compiler's own declaration output path (TS5055) whenever the project was type-checked directly (e.g. by the editor) instead of built via webpack/ts-loader, which follows the entry graph and never hit this.
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 does this PR do?
Housekeepingh tasks:
docs: add JSDoc to component props and story descriptions
Documents every public prop across all component types.ts/type.ts files so IDE autocomplete surfaces what each prop does, reusing the wording already written for Storybook's argTypes where available. Also adds a one-line description above every named story export explaining what it demonstrates.
Adds eslint-plugin-jsdoc with jsdoc/multiline-blocks and jsdoc/lines-before-block, scoped to types.ts/type.ts, to keep prop JSDoc single-line with a blank line above going forward.
docs(BBBTypography): add stories for every typography variant
Only Default and Header were covered before, leaving selected, text2, text3, and button undocumented in Storybook. Adds one story per missing variant plus an AllVariants story that renders them all side by side for quick visual comparison.
docs: add CLAUDE.md with component/prop/commit conventions
Captures which files to create/update when adding a new component or a new prop to an existing one, and the commit type/scope conventions this repo relies on for automatic changelog and version generation.
chore(build): target ES2017 instead of ES5
The browserslist config already excludes dead browsers (which covers IE11), and this library's own peer deps — react@^18 and @mui/material@^6||^7 — dropped IE11 support already. Targeting ES5 was just adding class/generator-emulation overhead for a browser baseline nothing here actually supports anymore.
fix(build): exclude dist/ from tsconfig.json's file discovery
Without an explicit "include", tsc scans the whole project directory for inputs. Since "dist" wasn't excluded, any previously-built .d.ts files sitting there got picked up as inputs too, colliding with the compiler's own declaration output path (TS5055) whenever the project was type-checked directly (e.g. by the editor) instead of built via webpack/ts-loader, which follows the entry graph and never hit this.
Closes Issue(s)
N/A