search

reearth / resium

React components for 🌏 Cesium
https://resium.reearth.io
MIT License
746 stars 135 forks source link

fix: export component props in dist #677

Closed reggie3-braingu closed 1 month ago

reggie3-braingu commented 1 month ago

fixes #676

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes involve modifying multiple TypeScript modules to export additional type definitions alongside their default exports. This enhancement allows consumers of these modules to access the types, thereby improving type safety and extensibility within applications that utilize these components.

Changes

File Path Change Summary
src/Billboard/index.ts Exported type BillboardProps.
src/BillboardCollection/index.ts Exported type BillboardCollectionProps.
src/BillboardGraphics/index.ts Exported type BillboardGraphicsProps.
src/BoxGraphics/index.ts Exported type BoxGraphicsProps.
src/Camera/index.ts Exported type CameraProps.
src/CameraFlyHome/index.ts Exported type CameraFlyHomeProps.
src/CameraFlyTo/index.ts Exported type CameraFlyToProps.
src/CameraFlyToBoundingSphere/index.ts Exported type CameraFlyToBoundingSphereProps.
src/CameraLookAt/index.ts Exported type CameraLookAtProps.
src/Cesium3DTileset/index.ts Exported type Cesium3DTilesetProps.
src/Cesium3DTilesetGraphics/index.ts Exported type Cesium3DTilesetGraphicsProps.
src/CesiumWidget/index.ts Exported type CesiumWidgetProps.
src/ClassificationPrimitive/index.ts Exported type ClassificationPrimitiveProps.
src/Clock/index.ts Exported type ClockProps.
src/CloudCollection/index.ts Exported type CloudCollectionProps.
src/CorridorGraphics/index.ts Exported type CorridorGraphicsProps.
src/CumulusCloud/index.ts Exported type CumulusCloudProps.
src/CustomDataSource/index.ts Exported type CustomDataSourceProps.
src/CylinderGraphics/index.ts Exported type CylinderGraphicsProps.
src/CzmlDataSource/index.ts Exported type CzmlDataSourceProps.
src/EllipseGraphics/index.ts Exported type EllipseGraphicsProps.
src/EllipsoidGraphics/index.ts Exported type EllipsoidGraphicsProps.
src/Entity/index.ts Exported type EntityProps.
src/EntityDescription/index.ts Exported type EntityDescriptionProps.
src/Fog/index.ts Exported type FogProps.
src/GeoJsonDataSource/index.ts Exported type GeoJsonDataSourceProps.
src/Globe/index.ts Exported type GlobeProps.
src/GroundPolylinePrimitive/index.ts Exported type GroundPolylinePrimitiveProps.
src/GroundPrimitive/index.ts Exported type GroundPrimitiveProps.
src/GroundPrimitiveCollection/index.ts Exported type GroundPrimitiveCollectionProps.
src/ImageryLayer/index.ts Exported type ImageryLayerProps.
src/ImageryLayerCollection/index.ts Exported type ImageryLayerCollectionProps.
src/KmlDataSource/index.ts Exported type KmlDataSourceProps.
src/Label/index.ts Exported type LabelProps.
src/LabelCollection/index.ts Exported type LabelCollectionProps.
src/LabelGraphics/index.ts Exported type LabelGraphicsProps.
src/Model/index.ts Exported type ModelProps.
src/ModelGraphics/index.ts Exported type ModelGraphicsProps.
src/Moon/index.ts Exported type MoonProps.
src/ParticleSystem/index.ts Exported type ParticleSystemProps.
src/PathGraphics/index.ts Exported type PathGraphicsProps.
src/PlaneGraphics/index.ts Exported type PlaneGraphicsProps.
src/PointGraphics/index.ts Exported type PointGraphicsProps.
src/PointPrimitive/index.ts Exported type PointPrimitiveProps.
src/PointPrimitiveCollection/index.ts Exported type PointPrimitiveCollectionProps.
src/PolygonGraphics/index.ts Exported type PolygonGraphicsProps.
src/Polyline/index.ts Exported type PolylineProps.
src/PolylineCollection/index.ts Exported type PolylineCollectionProps.
src/PolylineGraphics/index.ts Exported type PolylineGraphicsProps.
src/PolylineVolumeGraphics/index.ts Exported type PolylineVolumeGraphicsProps.
src/PostProcessStage/index.ts Exported types for PostProcessStageProps, BlackAndWhiteStageProps, BrightnessStageProps, LensFlareStageProps.
src/PostProcessStageComposite/index.ts Exported types for PostProcessStageCompositeProps, AmbientOcclusionProps, BloomProps, BlurStageProps, DepthOfFieldStageProps, EdgeDetectionStageProps, SilhouetteStageProps.
src/Primitive/index.ts Exported type PrimitiveProps.
src/RectangleGraphics/index.ts Exported type RectangleGraphicsProps.
src/Scene/index.ts Exported type SceneProps.
src/ScreenSpaceCameraController/index.ts Exported type ScreenSpaceCameraControllerProps.
src/ScreenSpaceEvent/index.ts Exported type ScreenSpaceEventProps.
src/ScreenSpaceEventHandler/index.ts Exported type ScreenSpaceEventHandlerProps.
src/ShadowMap/index.ts Exported type ShadowMapProps.
src/SkyAtmosphere/index.ts Exported type SkyAtmosphereProps.
src/SkyBox/index.ts Exported type SkyBoxProps.
src/Sun/index.ts Exported type SunProps.
src/TimeDynamicPointCloud/index.ts Exported type TimeDynamicPointCloudProps.
src/Viewer/index.ts Exported type ViewerProps.
src/WallGraphics/index.ts Exported type WallGraphicsProps.
src/index.ts Updated exports to include associated type definitions.

Assessment against linked issues

Objective Addressed Explanation
Export type definitions for all components (676) ✅

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
keiya01 commented 1 month ago

@reggie3-braingu Thanks for your PR. I reviewed your PR. It looks good to me. There are some comments from coderabbitai. Have these comments been resolved?

reggie3-braingu commented 1 month ago

Hi @keiya01 , thank you for taking a look at this PR. I'm confused by what the coderabbitai bot is saying here. It's saying that almost all of the files do not export the component prop, but the props are being exported (as far as I can tell). Are you able to explain what the bot is trying to get me to do?

arngc commented 1 month ago

Please confirm, does this commit also resolve this issue? https://github.com/reearth/resium/issues/675

reggie3-braingu commented 1 month ago

@arngc , it doesn't. My PR just exports the component props.