feat(docs): add docs-extractor packages #269
Conversation
- Added TypeExtractor class to orchestrate the extraction of component type information. - Introduced specialized analyzers: ComponentAnalyzer, PropsAnalyzer, VanillaExtractAnalyzer, and ExternalTypeResolver. - Created utility functions for TypeScript analysis and component extraction. - Developed a main function to handle file processing and output generation in JSON format. - Added types and interfaces for component type information and extraction configuration. - Integrated support for Vanilla Extract CSS files to extract default values and styling information. - Established a configuration file for TypeScript compilation settings. - Updated package dependencies and lock file to include necessary libraries for functionality.
…ction - Removed legacy order.json configuration file. - Enhanced types.ts with new interfaces for component and prop information. - Updated tsconfig.json to include path mapping for improved module resolution. - Created comprehensive README.md detailing the new architecture and usage. - Implemented CLI tool for extracting component types from specified files. - Developed ComponentAnalyzer for extracting display names and default elements from React components. - Introduced ExternalTypeResolver for resolving external type definitions from npm packages. - Built PropsAnalyzer for extracting prop information, including types and default values. - Refactored TypeExtractor to orchestrate the extraction process using various analyzers. - Added utility functions for TypeScript analysis, including JSDoc extraction and type parsing. - Integrated Vanilla Extract support for CSS-in-JS styling analysis.
- Removed the ComponentAnalyzer and ExternalTypeResolver classes, replacing them with standalone functions in new files. - Introduced PropsAnalyzer for extracting props information from TypeScript types. - Created a new type-extractor module to handle TypeScript program creation and component type extraction. - Updated index.ts to reflect new module structure and exports. - Removed legacy VanillaExtractAnalyzer and replaced it with utility functions for CSS file handling. - Cleaned up unused utility functions and consolidated prop extraction logic. - Updated tsconfig.json for improved path resolution.
…tion and updating utils imports
…pty and simplifying patterns handling
…y only when necessary
…w parser utilities and restructuring component handling
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Summary of ChangesHello @MaxLee-dev, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a dedicated documentation extraction package to enhance the project's documentation workflow. By programmatically analyzing TypeScript component definitions, the new tool automates the generation of API documentation, ensuring that the website's component reference is always up-to-date and accurately reflects the codebase. This change significantly improves the efficiency and reliability of maintaining comprehensive component documentation. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
packages/docs-extractor/src/handler/external-packages-handler.ts
Outdated
Show resolved
Hide resolved
…-components-tsdocs
… initialization outside the loop
…ctions; refactor package.json for typescript-api-extractor; enhance error handling in CLI; remove legacy type parsing function
…lProp for prop inclusion logic
…-docs-extractor
…p types in extractFullUnionTypes function
- Deleted ESLint configuration file as it is no longer needed. - Removed package.json and TypeScript configuration files, cleaning up the project structure. - Eliminated CLI implementation and related handlers for component extraction. - Removed parser utilities and types related to component and prop extraction. - Cleaned up utility functions and external type parsing logic. - Updated pnpm lock file to reflect dependency changes.
…omponent JSON files with props definitions
1 participant
Related Issues
Description of Changes
Checklist
Before submitting the PR, please make sure you have checked all of the following items.