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: updated vscode settings and added recommended extensions #53

Merged

Conversation

eugene-manuilov
Copy link
Contributor

@eugene-manuilov eugene-manuilov commented Jan 27, 2025

  • Added the new .vscode/extensions.json file that contains recommendationded extensions used by the project.
  • Updated vscode settings to use prettier as the defalult formatter for all files. This will let us have consistent formatting in js, ts and json files. Plus, hid node_modules folders in the navigation sidebar and excluded node_modules files from search.

Summary by CodeRabbit

  • Chores
    • Added recommended Prettier extension for Visual Studio Code.
    • Updated VS Code settings to exclude node_modules from file operations and search results.
    • Introduced a path for Prettier's configuration file.
    • Enhanced Prettier configuration with specific formatting options for YAML and Markdown files.

Copy link

vercel bot commented Jan 27, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
daydreams ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 28, 2025 7:37am

Copy link
Contributor

coderabbitai bot commented Jan 27, 2025

Walkthrough

The pull request introduces configuration changes to the Visual Studio Code workspace settings. A new recommended extension for Prettier is added to the .vscode/extensions.json file, while the .vscode/settings.json file is updated to exclude the node_modules directory from file operations and search results. Additionally, a path for Prettier's configuration file is specified. Furthermore, the prettier.config.cjs file is updated to include custom formatting options for YAML and Markdown files.

Changes

File Change Summary
.vscode/extensions.json Added Prettier extension recommendation under the "recommendations" key
.vscode/settings.json Added exclusion rules for node_modules in file and search operations; added prettier.configPath pointing to prettier.config.cjs
prettier.config.cjs Updated overrides for custom formatting options for *.yml, *.yaml, and *.md files

Poem

🐰 A rabbit's code config delight,
VSCode settings now shine so bright.
Prettier's magic, node_modules away,
Clean workspace rules save the day!
Hop, hop, configuration complete! 🧹✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 915185e and 18beb69.

📒 Files selected for processing (1)
  • prettier.config.cjs (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • prettier.config.cjs

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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

🧹 Nitpick comments (3)
.vscode/settings.json (3)

4-6: Consider adding more common excludes.

While hiding node_modules is good, consider adding other common excludes for a cleaner workspace:

 "files.exclude": {
-    "**/node_modules": true
+    "**/node_modules": true,
+    "**/.git": true,
+    "**/.DS_Store": true,
+    "**/dist": true,
+    "**/coverage": true
 }

7-7: Consider adding more Prettier configurations.

While setting singleQuote is good, consider adding other common Prettier configurations for better consistency:

-"prettier.singleQuote": false,
+"prettier.singleQuote": false,
+"prettier.trailingComma": "es5",
+"prettier.printWidth": 100,
+"prettier.tabWidth": 2,
+"prettier.semi": true

8-10: Consider adding more search excludes.

While excluding node_modules from search is good, consider adding other common excludes to improve search performance:

 "search.exclude": {
-    "**/node_modules": true
+    "**/node_modules": true,
+    "**/dist": true,
+    "**/coverage": true,
+    "**/.git": true,
+    "package-lock.json": true
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6f29044 and b7fce02.

📒 Files selected for processing (2)
  • .vscode/extensions.json (1 hunks)
  • .vscode/settings.json (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .vscode/extensions.json
🔇 Additional comments (2)
.vscode/settings.json (2)

2-3: LGTM! Good formatting configuration.

The configuration enforces consistent code formatting by setting Prettier as the default formatter and enabling format on save. This aligns well with the recommended extensions in .vscode/extensions.json.


11-11: LGTM! Good TypeScript configuration.

Using the workspace's TypeScript version is a good practice as it ensures consistency between developers.

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

🧹 Nitpick comments (3)
prettier.config.cjs (3)

10-23: Consider standardizing tab width across all file types.

The configuration sets different tab widths (4 spaces globally vs 2 spaces for YAML/Markdown), which could lead to inconsistent code appearance across the project. While YAML and Markdown files commonly use 2 spaces, consider standardizing to 2 spaces project-wide for consistency.

module.exports = {
    endOfLine: "lf",
    semi: true,
    singleQuote: false,
-    tabWidth: 4,
+    tabWidth: 2,
    trailingComma: "es5",
    bracketSpacing: true,
    printWidth: 80,
-    overrides: [
-        {
-            files: ["*.yaml", "*.yml"],
-            options: {
-                tabWidth: 2,
-            },
-        },
-        {
-            files: ["*.md"],
-            options: {
-                tabWidth: 2,
-            },
-        },
-    ],
};

10-16: Consider additional YAML-specific formatting options.

For YAML files, you might want to consider additional formatting options that are commonly used:

        {
            files: ["*.yaml", "*.yml"],
            options: {
                tabWidth: 2,
+               proseWrap: "preserve",
+               bracketSpacing: false
            },
        },

17-22: Consider additional Markdown-specific formatting options.

For Markdown files, you might want to consider additional formatting options that improve readability:

        {
            files: ["*.md"],
            options: {
                tabWidth: 2,
+               proseWrap: "always",
+               embeddedLanguageFormatting: "auto"
            },
        },
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b8947cd and 915185e.

📒 Files selected for processing (1)
  • prettier.config.cjs (1 hunks)

@eugene-manuilov eugene-manuilov changed the title feat: updated vscode settings and added recommended extensions chore: updated vscode settings and added recommended extensions Jan 27, 2025
@ponderingdemocritus ponderingdemocritus merged commit d27f0d5 into daydreamsai:main Jan 28, 2025
5 checks passed
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.

2 participants