uni-helper / vite-plugin-uni-pages

为 Vite 下的 uni-app 提供基于文件系统的路由
https://uni-helper.js.org/vite-plugin-uni-pages
MIT License
104 stars 15 forks source link

fix: fix jsdoc and schema type #139

Closed zifengb closed 6 months ago

zifengb commented 6 months ago

fix: 修复 pages.json 布尔类型初始值问题 fix: 修复分包 subPackages 的 schema 类型引用

Summary by CodeRabbit

coderabbitai[bot] commented 6 months ago

[!IMPORTANT]

Auto Review Skipped

Review was skipped due to path filters

Files ignored due to path filters (1) * `packages/schema/schema.json` is excluded by: `!**/*.json`

Walkthrough

The recent updates introduce clearer and more consistent configurations within the core package by ensuring boolean properties in the GlobalStyle interface now have boolean default values. Additionally, the SubPackage interface's pages property type has been refined from a broad any array to a more specific PageMetaDatum array, enhancing type safety and clarity in the project structure.

Changes

Files Change Summary
.../config/types/globalStyle.ts, .../index.ts Set boolean defaults in GlobalStyle; pages in SubPackage now PageMetaDatum array.

Poem

🎉🐰✨
In the realm of code, under digital skies,
A rabbit hopped, with bright, wise eyes.
"Let's tidy up," it said with glee,
Boolean defaults, clear as can be.
From any to PageMetaDatum, a precise leap,
In the heart of the code, improvements seep.
🌟📚🐇

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: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - 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 tests 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 generate interesting stats about this repository from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` 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 as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
ModyQyW commented 6 months ago

@uni-helper/pages-json-schema 是根据 core 的 ts 类型自动生成的,请不要直接更新 json 文件,而是去更新 ts 类型并生成相应的 json 文件,谢谢。

zifengb commented 6 months ago

@uni-helper/pages-json-schema 是根据 core 的 ts 类型自动生成的,请不要直接更新 json 文件,而是去更新 ts 类型并生成相应的 json 文件,谢谢。

多谢指导,那我理解是不是更新 ts 类型后,并且跑 schema/package.json 里面的命令生成 schema.json,然后一起提交就完成了?

ModyQyW commented 6 months ago

@uni-helper/pages-json-schema 是根据 core 的 ts 类型自动生成的,请不要直接更新 json 文件,而是去更新 ts 类型并生成相应的 json 文件,谢谢。

多谢指导,那我理解是不是更新 ts 类型后,并且跑 schema/package.json 里面的命令生成 schema.json,然后一起提交就完成了?

是的

ModyQyW commented 6 months ago

Thank you!