Optimize documentation and remove unused component related code #1338
Conversation
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
- Removed outdated functions and type aliases related to component state management. - Updated documentation for existing functions to improve clarity and completeness. - Enhanced type definitions for class and function components. - Consolidated utility functions for better maintainability.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors and improves the component-related code in the core package by removing outdated utilities and enhancing documentation. The changes consolidate related functionality while adding comprehensive JSDoc comments to improve code maintainability.
- Removed obsolete component state and children utility files
- Relocated functions to more appropriate modules with clearer visibility markers
- Added comprehensive JSDoc documentation to interfaces, functions, and constants
- Improved code organization with better naming conventions and import structure
Reviewed changes
Copilot reviewed 26 out of 26 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
packages/core/src/component/index.ts |
Removed exports for deleted component-children and component-state modules |
packages/core/src/component/component-state.ts |
Deleted file; functions moved to component-collector-legacy.ts |
packages/core/src/component/component-children.ts |
Deleted file; function moved inline to component-definition.ts |
packages/core/src/component/component-semantic-node.ts |
Added comprehensive JSDoc comments for interfaces and their properties |
packages/core/src/component/component-name.ts |
Added JSDoc comments for exported functions with parameter descriptions |
packages/core/src/component/component-flag.ts |
Added descriptive comments for each component flag constant |
packages/core/src/component/component-definition.ts |
Improved JSDoc, refactored functions, renamed constants to SCREAMING_SNAKE_CASE, inlined isChildrenOfCreateElement |
packages/core/src/component/component-collector-legacy.ts |
Added isThisSetState and isAssignmentToThisState functions marked as @internal, reorganized imports |
packages/core/src/component/component-init-path.ts |
Added blank line for improved readability |
packages/core/src/component/component-id.ts |
Added blank line for improved readability |
packages/core/docs/variables/ComponentFlag.md |
Added description column to document each flag's purpose |
packages/core/docs/type-aliases/ComponentStateKind.md |
Removed documentation for deleted type |
packages/core/docs/type-aliases/Component.md |
Added description for the union type |
packages/core/docs/interfaces/FunctionComponent.md |
Added description column documenting each property |
packages/core/docs/interfaces/ClassComponent.md |
Added description column documenting each property |
packages/core/docs/functions/stringifyJsx.md |
Reordered union type parameters (automated formatting) |
packages/core/docs/functions/isThisSetState.md |
Removed public documentation (function now internal) |
packages/core/docs/functions/isFunctionOfRenderMethod.md |
Removed public documentation (function now internal) |
packages/core/docs/functions/isComponentNameLoose.md |
Added description and parameter documentation |
packages/core/docs/functions/isComponentName.md |
Added description and parameter documentation |
packages/core/docs/functions/isComponentDefinition.md |
Enhanced parameter descriptions with more context |
packages/core/docs/functions/isChildrenOfCreateElement.md |
Removed public documentation (function now internal) |
packages/core/docs/functions/isAssignmentToThisState.md |
Removed public documentation (function now internal) |
packages/core/docs/functions/hasNoneOrLooseComponentName.md |
Added description and parameter documentation |
packages/core/docs/functions/getComponentNameFromId.md |
Added description and parameter documentation |
packages/core/docs/README.md |
Updated index to reflect removed exports and type aliases |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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 kind of change does this PR introduce?
Does this PR introduce a breaking change?
Checklist
fix: remove a typo, closes #___, #___)Other information