-
-
Notifications
You must be signed in to change notification settings - Fork 6.4k
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
Enhance dev container #2226
base: master
Are you sure you want to change the base?
Enhance dev container #2226
Conversation
- Add error handling with 'set -e' - Ensure Node.js version check before installation - Improve idempotency for dependencies - Add logging for script execution - Introduce modular Zsh plugin installation
- onCreateCommand: Added Git configuration for user name and email, which is a useful setup for contributors. - postCreateCommand: Added installation of jekyll and bundler gems, which are necessary for building Jekyll sites. VSCode Settings: - files.autoSave: Configures auto-save behavior when the window focus changes. - editor.formatOnSave: Ensures code is automatically formatted when saving files. - workbench.colorTheme: Uses the "Dark+" theme for consistency with many developers' preferences. - ruby.rubyPath: Ensures Ruby tools work with the correct Ruby version. Extensions: - Added Ruby and YAML extensions to support Jekyll and configuration files. - Added GitLens for enhanced Git experience, and Git Graph for visualization of Git repositories. - Integrated several tools such as ShellCheck and Prettier for better shell scripting and code formatting.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for taking the time to improve the project! After reviewing your changes, I found that your modifications duplicate existing settings (such as zsh and vscode-plugins configurations, which are already set up in .vscode
) and introduce some redundant environment checks (like nvm). Therefore, I am curious about the situations you encountered that made the original post-create.sh
insufficient for initialization tasks?
"redhat.vscode-yaml", | ||
|
||
// Enhanced Git functionality with GitLens for better repository insights | ||
"eamodio.gitlens" | ||
] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe these extensions could be a great addition to the config that's been updated. I find these tools helpful to me while writing blogs, from an end user perspective.
] | |
// Spelling Checker for blog writers | |
"streetsidesoftware.code-spell-checker", | |
// Grammar Checker for blog writers | |
"davidlday.languagetool-linter" | |
] |
"workbench.colorTheme": "Dark+ (default dark)", | ||
|
||
// Ruby path for proper integration with Ruby-based tools | ||
"ruby.rubyPath": "/usr/local/bin/ruby" | ||
}, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe these extensions could be a great addition to the config that's been updated. I find these tools helpful to me while writing blogs, from an end user perspective.
If you're considering adding the previously mentioned changes, it might be better to add this config too... Using the public API enabled the Language-Tool
extension to work properly.
}, | |
// Using public API for language tools extension | |
"languageToolLinter.serviceType": "public" | |
}, |
I doubt whether |
Type of change
Description
This PR improves the Dev Container configuration and post-create.sh script to enhance reliability, maintainability, and developer experience.
Key Improvements
Dev Container Configuration (
devcontainer.json
)postCreateCommand
to automatically execute the enhancedpost-create.sh
script.zsh
is set as the default terminal profile in VS Code.shellcheck
,prettier
,git-graph
for better shell scripting, formatting, and Git visualization.Post-Create Script (
post-create.sh
)nvm
availability issue by ensuring it is sourced properly before use.set -e
to stop execution on failures.Additional context
This update ensures a more robust and developer-friendly Dev Container setup by minimizing redundant installations, improving shell experience, and providing a more consistent development environment. 🚀