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

feat: support detecting origin indent and newline to generate pages.json #170

Closed ModyQyW closed 2 months ago

ModyQyW commented 3 months ago

Description 描述

Close https://github.com/uni-helper/vite-plugin-uni-pages/issues/133.

Linked Issues 关联的 Issues

https://github.com/uni-helper/vite-plugin-uni-pages/issues/133

Additional context 额外上下文

As a feature, we don't have to rush for it.

I also want to find a way to handle https://github.com/uni-helper/vite-plugin-uni-pages/issues/133#issuecomment-1987318138. I think we can try to detect if pages.json or manifest.json exists and generate one if not in the constructor in the next PR. What do you think?

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The updates enhance dependency versions, integrate new features for file formatting, and extend testing capabilities. Major improvements include updating package versions in package.json files across the project and ensuring JSON file formatting consistency using detect-indent and detect-newline. These adjustments resolve issues with newline characters in JSON files post-update, streamlining development workflows.

Changes

File(s) Change Summary
package.json Updated packageManager and several devDependencies versions.
packages/core/package.json Updated dependencies and added new ones (detect-indent, detect-newline).
packages/core/src/context.ts Introduced logic for handling JSON file formatting, including indent and newline detection.
test/files.spec.ts Extended imports to include it from 'vitest', enhancing test capabilities.

Sequence Diagram(s)

sequenceDiagram
    participant Editor as Editor
    participant PageContext as PageContext
    participant detectIndent as detectIndent
    participant detectNewline as detectNewline
    participant JSON as JSON

    Editor->>PageContext: Update pages.json
    PageContext->>detectIndent: Detect indent in pages.json
    detectIndent-->>PageContext: Return indent
    PageContext->>detectNewline: Detect newline in pages.json
    detectNewline-->>PageContext: Return newline style
    PageContext->>JSON: Stringify with detected indent & newline
    JSON-->>PageContext: Formatted JSON string
    PageContext->>Editor: Save formatted pages.json

Assessment against linked issues

Objective Addressed Explanation
Ensure pages.json maintains consistent file formatting including newline characters on save (#133)

Poem

In the realm of JSON's delight,
Where files gain structure, pure and bright,
Indents detected, newlines aligned,
Our code's now flawless, well-defined.
With pnpm and pnpm anew,
A coder's dreams do come true! ✨🐇


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 .` - `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 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 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 as 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. 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. - 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
Skiyee commented 3 months ago

LGTM

ModyQyW commented 2 months ago

我打算在两到三天内合并发布这个