feat(SW-1370): enforce JSDoc, export conventions, and barrel file patterns#36
Open
darwinboersma wants to merge 1 commit intomainfrom
Open
feat(SW-1370): enforce JSDoc, export conventions, and barrel file patterns#36darwinboersma wants to merge 1 commit intomainfrom
darwinboersma wants to merge 1 commit intomainfrom
Conversation
…terns
- Add eslint-plugin-jsdoc and require JSDoc on Props interfaces/types and components
- Convert all component source files to inline named exports (export const)
- Keep export default for backward compatibility
- Convert all barrel files (index.ts) to use export * pattern
- Add ESLint rules enforcing export * in barrel files
- Add ESLint rules banning bottom-of-file export { Foo } in component files
- Remove redundant explicit type re-exports from src/index.ts
- Remove TaskScripts stub from src/index.ts
- Convert server, theme, and utils barrel files to export *
- Update .augment-guidelines with Storybook testing conventions
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
darwinboersma
had a problem deploying
to
artifactory-prod
GitHub Actions
Failure
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.
Summary
Enforces code quality conventions across the UI kit: JSDoc documentation, consistent export patterns, and barrel file standards.
Changes
ESLint Rules
eslint-plugin-jsdocwithrequire-jsdocrule for Props interfaces/types and component declarationsindex.tsfiles must useexport *(no named re-exports)export { Foo }patternsExport Pattern Refactoring
export const ComponentName)export defaultat bottom of each component for backward compatibilityindex.tsfiles toexport * from "./ComponentName"src/index.tsto useexport *for utils/colors and theme (removed redundant explicit type re-exports)export *src/index.tsJSDoc
Other
generate:catalogscript topackage.json.augment-guidelineswith Storybook testing conventionsJira
SW-1370 (parent epic: SW-1173)
Pull Request opened by Augment Code with guidance from the PR author