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

chore: update vscode configuration #4210

Merged
merged 3 commits into from
Aug 22, 2024
Merged

Conversation

WitMiao
Copy link
Contributor

@WitMiao WitMiao commented Aug 21, 2024

Description

配置package.json默认匹配为json而不是jsonc, 以修复依赖悬浮提示信息

###before:
image

###after:
image

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features
    • Enhanced file type recognition for package.json, improving syntax highlighting and validation in the editor.

Copy link

changeset-bot bot commented Aug 21, 2024

⚠️ No Changeset found

Latest commit: fd7e22d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Aug 21, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The recent changes focus on enhancing the .vscode/settings.json file by explicitly associating the package.json file with the json type while retaining the existing association for other JSON files to the jsonc type. This modification aims to improve the editor's handling of package.json, providing better syntax highlighting and validation tailored for this specific file format.

Changes

Files Change Summary
.vscode/settings.json Added an entry to associate package.json with json type, while keeping other .json files as jsonc.

Poem

🐰 In the code garden, changes bloom,
A package.json in its room.
With colors bright and syntax right,
Our editor dances in delight!
JSON, JSON, now distinct,
In the world of code, we’re all linked! 🌼


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.
    • @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 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 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
Contributor

@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 c3631ef and de8dcb1.

Files selected for processing (1)
  • .vscode/settings.json (1 hunks)
Additional comments not posted (1)
.vscode/settings.json (1)

59-60: LGTM! Improved handling of package.json in VSCode.

Associating package.json with json instead of jsonc will likely enhance syntax highlighting and validation specific to package.json files. This change aligns with the PR objectives to improve tooltip information in the development environment.

@WitMiao WitMiao changed the title chore: vscode 配置package.json默认匹配为json而不是jsonc, 以修复依赖悬浮提示信息 chore(.vscode): Configure VS Code to default to matching package.json as JSON instead of JSONC to fix dependency hover hints. Aug 22, 2024
@vince292007
Copy link
Collaborator

@WitMiao 没检查通过

@WitMiao WitMiao changed the title chore(.vscode): Configure VS Code to default to matching package.json as JSON instead of JSONC to fix dependency hover hints. chore: Configure VS Code to default to matching package.json as JSON instead of JSONC to fix dependency hover hints Aug 22, 2024
@WitMiao WitMiao changed the title chore: Configure VS Code to default to matching package.json as JSON instead of JSONC to fix dependency hover hints chore: configure VS Code to default to matching package.json as JSON instead of JSONC to fix dependency hover hints Aug 22, 2024
@WitMiao WitMiao changed the title chore: configure VS Code to default to matching package.json as JSON instead of JSONC to fix dependency hover hints chore(vscode): 配置package.json默认匹配为json而不是jsonc, 以修复依赖悬浮提示信息 Aug 22, 2024
@WitMiao WitMiao changed the title chore(vscode): 配置package.json默认匹配为json而不是jsonc, 以修复依赖悬浮提示信息 chore: update vscode configuration Aug 22, 2024
@WitMiao
Copy link
Contributor Author

WitMiao commented Aug 22, 2024

@WitMiao 没检查通过

改好了

@vince292007 vince292007 merged commit e2732f3 into vbenjs:main Aug 22, 2024
15 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Sep 22, 2024
@WitMiao WitMiao deleted the chore/vscode branch October 7, 2024 09:02
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants