Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: fix HBuilderX compatibility #33

Merged
merged 4 commits into from
May 19, 2024
Merged

fix: fix HBuilderX compatibility #33

merged 4 commits into from
May 19, 2024

Conversation

Xiphin
Copy link
Contributor

@Xiphin Xiphin commented May 12, 2024

Description 描述

最小修改兼容 HBuiderX 运行模式

Linked Issues 关联的 Issues

在 HBuiderX 使用不生效

Additional context 额外上下文

在 HBuilderX 下运行

Summary by CodeRabbit

  • New Features

    • Introduced a configurable path for loading pages from JSON, enhancing flexibility in file management.
  • Refactor

    • Updated logic for determining source mode based on the resolved path, improving the accuracy of mode detection.

Copy link

coderabbitai bot commented May 12, 2024

Walkthrough

The changes introduce enhanced configurability by enabling dynamic specification of the JSON pages path. Users can now define the path using the pagesJsonPath property in the Options interface. This update ensures consistent handling of the path across Context, types, and utils, fostering system flexibility and simplifying maintenance.

Changes

Files Changes Summary
src/context.ts Updated loadPagesJson to use this.options.pagesJsonPath for loading JSON pages.
src/types.ts Added pagesJsonPath property to the Options interface.
src/utils.ts Enhanced resolveOptions with pagesJsonPath support; improved getTarget logic.

🐰✨
In the code woods, a new path unfurls,
pagesJsonPath now, for JSON pearls.
src and utils in harmony align,
Configurable paths, a paradigm.
Files dance, in the winds of change,
A symphony of code, rearrange! 🌟
🐰💻


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
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 <commit_id>.
    • 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.

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.
  • Please see the configuration documentation 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between eb9eabc and a3c243b.
Files selected for processing (3)
  • src/context.ts (2 hunks)
  • src/types.ts (1 hunks)
  • src/utils.ts (2 hunks)
Files skipped from review due to trivial changes (1)
  • src/types.ts
Additional comments not posted (4)
src/utils.ts (2)

14-14: The addition of pagesJsonPath in resolveOptions enhances configuration flexibility and is implemented correctly.


47-50: Refactoring in getTarget to determine isSrcMode based on the resolved path is clear and effective.

src/context.ts (2)

36-36: Using this.options.pagesJsonPath in setupWatcher correctly implements dynamic configuration for the JSON path.


47-47: Dynamically loading pages JSON in transform using this.options.pagesJsonPath enhances the adaptability of the application.

@Xiphin
Copy link
Contributor Author

Xiphin commented May 13, 2024

@KeJunMao 方便看一下么?

@ModyQyW
Copy link
Member

ModyQyW commented May 14, 2024

LGTM

Copy link
Member

@Skiyee Skiyee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pagesJsonPath 这个属性的有无可能不会产生太大影响
我觉得可以通过判断是否拥有 src目录 来区分所创建项目类型就好了

这是我的看法,看看大佬们怎么说?🧐

同时要谢谢你的PR,解决 HBuilderX 上的问题 ❤

@Xiphin
Copy link
Contributor Author

Xiphin commented May 14, 2024

pagesJsonPath 这个属性的有无可能不会产生太大影响 我觉得可以通过判断是否拥有 src目录 来区分所创建项目类型就好了

这是我的看法,看看大佬们怎么说?🧐

同时要谢谢你的PR,解决 HBuilderX 上的问题 ❤

HBuilderX 和 Cli 两种模式下 pages.json 文件所在的路径不一样,之前的代码似乎是写死的,一起看一下

this.pages = loadPagesJson('src/pages.json', this.options.cwd)

this.pages = loadPagesJson('src/pages.json', this.options.cwd)

@Xiphin
Copy link
Contributor Author

Xiphin commented May 14, 2024

pagesJsonPath 这个属性的有无可能不会产生太大影响 我觉得可以通过判断是否拥有 src目录 来区分所创建项目类型就好了

这是我的看法,看看大佬们怎么说?🧐

同时要谢谢你的PR,解决 HBuilderX 上的问题 ❤

你的意思是定义一个全局 isSrc 模式的判断,对吧?

@Skiyee
Copy link
Member

Skiyee commented May 14, 2024

你的意思是定义一个全局 isSrc 模式的判断,对吧?

if (resolvePath.startsWith(join(cwd, 'src')))
isSrcMode = true
const relativePath = relative(join(cwd, isSrcMode ? 'src' : ''), resolvePath)

是的,就像你处理这个类似 👆

因为在我看来,判断不同创建项目模式,无非就两种可能,pages.jsonsrc根目录

@Xiphin
Copy link
Contributor Author

Xiphin commented May 14, 2024

你的意思是定义一个全局 isSrc 模式的判断,对吧?

if (resolvePath.startsWith(join(cwd, 'src')))
isSrcMode = true
const relativePath = relative(join(cwd, isSrcMode ? 'src' : ''), resolvePath)

是的,就像你处理这个类似 👆

因为在我看来,判断不同创建项目模式,无非就两种可能,pages.jsonsrc根目录

看了一下 在 src/context.ts 全局 isSrc 判断貌似找不到合适的位置

你觉得在哪个位置合适?

@KeJunMao
Copy link
Member

是不是直接检测是否存在就可以,优先 src/pages.json,回退 pages.json,都没有抛出

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between a3c243b and df27b8e.
Files selected for processing (1)
  • src/utils.ts (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/utils.ts

@Xiphin
Copy link
Contributor Author

Xiphin commented May 15, 2024

是不是直接检测是否存在就可以,优先 src/pages.json,回退 pages.json,都没有抛出

调整优化了一下,大家再看一下 (df27b8e)

@Skiyee @KeJunMao

@Skiyee
Copy link
Member

Skiyee commented May 15, 2024

LGTM ❤

const filter = createFilter('src/main.(ts|js)')

这一行可能需要改成这样,const filter = createFilter(['main.(ts|js)', 'src/main.(ts|js)'])

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between df27b8e and 9fde786.
Files selected for processing (2)
  • src/index.ts (1 hunks)
  • src/utils.ts (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/utils.ts

Comment on lines +32 to 34
const filter = createFilter(['src/main.(ts|js)', 'main.(ts|js)'])
if (filter(id))
return ctx.importLayoutComponents(code, id)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure the filter pattern is correct and consistent.

The filter pattern ['src/main.(ts|js)', 'main.(ts|js)'] should be verified to match the intended files. If the project structure varies, consider making this pattern configurable.

-      const filter = createFilter(['src/main.(ts|js)', 'main.(ts|js)'])
+      const filter = createFilter(['src/main.{ts,js}', 'main.{ts,js}'])

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
const filter = createFilter(['src/main.(ts|js)', 'main.(ts|js)'])
if (filter(id))
return ctx.importLayoutComponents(code, id)
const filter = createFilter(['src/main.{ts,js}', 'main.{ts,js}'])
if (filter(id))
return ctx.importLayoutComponents(code, id)

@Xiphin
Copy link
Contributor Author

Xiphin commented May 15, 2024

@Skiyee 看一下

Copy link
Member

@Skiyee Skiyee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ModyQyW
Copy link
Member

ModyQyW commented May 17, 2024

如果没有进一步反馈,我会在2-3天内合并发布。

@ModyQyW ModyQyW changed the title chore: compatible with HBuilderX fix: fix HBuilderX compatibility May 19, 2024
@ModyQyW
Copy link
Member

ModyQyW commented May 19, 2024

Thank you!

@ModyQyW ModyQyW merged commit 5ef1a82 into uni-helper:main May 19, 2024
@Xiphin Xiphin deleted the dev branch May 21, 2024 06:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants