feat: support define page

edwinhuish commented 8 months ago

支持 `definePage` 宏 related #134

支持对象、函数、异步函数。详见 playground 下的示例
语法检查原生支持
代码约束原生支持
支持import

使用注意：

import 仅支持从 js 或 ts 导入，不支持从 vue 文件里导入
import 导入暂不支持别名路径
definePage 和页面script不在同一个作用域，无法使用页面变量。

实现原理：

使用 @vue/compiler-sfc 和 @babel/types 获取宏代码节点 https://github.com/uni-helper/vite-plugin-uni-pages/blob/218af7dba0d2011470c39987287381e2e010c04c/packages/core/src/page.ts#L86-L88
使用 @babel/generator 还原为 JS code https://github.com/uni-helper/vite-plugin-uni-pages/blob/218af7dba0d2011470c39987287381e2e010c04c/packages/core/src/page.ts#L99-L101
创建子进程，并调用 tsx 运行生成的 script，得到结果。 https://github.com/uni-helper/vite-plugin-uni-pages/blob/0d7e869f3303c7ef1c3ac523c48c2c1c8ee6871c/packages/core/src/page.ts#L201-L212

Summary by CodeRabbit

New Features
- Added support for ESLint flat config to improve code quality.
- Introduced a definePage function for more flexible page definitions.
- New utility function for generating random text strings, enhancing dynamic content.
- Enhanced page definition capabilities with support for async functions, nested functions, and object-based configurations.
- Added functionality to import modules directly within Vue components for dynamic title texts.
Refactor
- Refined page initialization and scanning logic for efficiency.
- Updated methods to work with Page instances, improving the handling of page options.
- Streamlined the process of parsing Vue single-file components (SFC) for better consistency.
Bug Fixes
- Removed unnecessary code and imports to clean up the codebase.
Chores
- Added a new child-process.ts file for running child processes, facilitating external command execution.
Documentation
- Adjusted settings and configurations to prioritize ESLint, enhancing code documentation and maintainability.

coderabbitai[bot] commented 8 months ago

Walkthrough

The update entails enhancements in ESLint integration, Vue.js project page management, and development workflow optimizations. It introduces new features for defining and parsing pages, improves ESLint settings in VS Code, and streamlines interactions with Vue Single File Components (SFCs). Utility functions are introduced, and the playground showcases enhanced capabilities, emphasizing code quality and developer efficiency.

Changes

Files	Change Summary
`.vscode/settings.json`	Enhanced ESLint integration and disabled default formatter.
`packages/core/client.d.ts`, `.../core/src/constant.ts`, `.../core/src/index.ts`, `.../core/src/types.ts`	Added `definePage` function, `DEFINE_PAGE` constant, and related types.
`packages/core/src/context.ts`	Refactored page handling logic, updated import/export statements, and improved page initialization methods.
`packages/core/src/page.ts`	Introduced `Page` class for managing options, parsing different file formats, and handling Vue SFC blocks.
`packages/core/src/utils.ts`	Streamlined utility functions and imports, added async parsing function for SFCs.
`packages/core/src/child-process.ts`	Added `runProcess` function for managing child processes with specified configurations.
`packages/playground/src/pages/...`, `.../macros/utils.ts`	Expanded playground with new Vue.js examples showcasing macros, async functions, and utility functions.
`packages/playground/src/uni-pages.d.ts`	Modified accessibility of navigation options declarations.

"In the realm of code, where logic does play,
A rabbit hopped in, with changes to say.
🐾 With a leap and a bound, ESLint's embraced,
Pages and playgrounds, so swiftly retraced.
🌟 Amidst Vue and scripts, it danced with delight,
Crafting a world, where code shines so bright."
🐇💻

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.` - `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 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 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.

edwinhuish commented 8 months ago

@KeJunMao @Ares-Chang @zguolee @ModyQyW

Ares-Chang commented 8 months ago

Sorry，最近大家可能都比较忙，可能没有时间看，如果非必要请不要 @，感谢。

如果比较着急，可以看自己发个包用一下。

我看你的文件改动比较大，如果不冲突最好把重构和新功能分开 pr。

edwinhuish commented 8 months ago

如果比较着急，可以看自己发个包用一下。

我最近没有用uniapp的需求。如果有其他人需要这个功能再考虑另发包。

我看你的文件改动比较大，如果不冲突最好把重构和新功能分开 pr。

改动的细分很难界定，曾经试过在其他库提几个文件的修改，因为代码样式、实现方式等，来来回回改近十个commit，拖了十多天才通过第一个PR，后续PR都一直等第一个PR合并才能继续。。。

另，正如我之前所说，我写这个PR，仅仅是为爱发电，如果你觉得改动太多，不好梳理，或者你们按照需求去拆分commit？对于commit的owner是否我，都没问题。

此 PR 暂关闭，分支在此仓库下，你们自行决定怎么处理吧？

CrazyZhang3 commented 3 months ago

个人感觉definePage比其他几种方式更优雅希望早日能实现合并

edwinhuish commented 3 months ago

@CrazyZhang3 https://github.com/uni-ku/define-page

uni-helper / vite-plugin-uni-pages