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: setup dev containers #138

Merged
merged 3 commits into from
Aug 7, 2024
Merged

chore: setup dev containers #138

merged 3 commits into from
Aug 7, 2024

Conversation

MarlonPassos-git
Copy link
Contributor

@MarlonPassos-git MarlonPassos-git commented Jul 26, 2024

Summary

In my daily work, I use Development Containers for all my applications. This approach is also widely adopted by large teams. Development containers allow us to create a Docker environment tailored for development, complete with a pre-configured operating system, dependencies, packages, extensions, and settings. This greatly facilitates the development process.

I have prepared a contribution that integrates development containers into the project. This setup works with both VSCode and IntelliJ, as well as with online code editors like CodeSandbox and GitHub Codespaces. I believe this configuration would add significant value to the project.

How to test it in Visual Studio Code

  1. clone repository and access PR branch with VSCode
  2. If you have not yet installed the Dev Containers Extension (https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) (To install it, you require the docker)
  3. Click in the popup, or run the command dev Containers: open Folder in Container

image

For any code change,

  • Related documentation has been updated, if needed
  • Related tests have been added or updated, if needed
  • Related benchmarks have been added or updated, if needed

Does this PR introduce a breaking change?

No

Bundle impact

Status File Size

@MarlonPassos-git MarlonPassos-git changed the title Feat/ setup dev containers chore: setup dev containers Jul 26, 2024
@MarlonPassos-git
Copy link
Contributor Author

Now that I saw that my PR had several commits that were already merged into the main branch, I don't know if this is a problem.

@aleclarson
Copy link
Member

Huh, never heard of this. I will try it out tomorrow and get back to you 👍

Comment on lines 16 to 58
"customizations": {
"vscode": {
"extensions": [
"vitest.explorer",
"biomejs.biome",
"esbenp.prettier-vscode"
],
"settings": {
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.organizeImports": "explicit",
"quickfix.biome": "explicit"
},
"typescript.tsdk": "./node_modules/typescript/lib",
"typescript.enablePromptUseWorkspaceTsdk": true,
"typescript.preferences.importModuleSpecifier": "non-relative",
"typescript.preferences.autoImportFileExcludePatterns": [
"**/node_modules/**",
"**/dist/**",
"**/dist"
],
"[markdown]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[mdx]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[json]": {
"editor.defaultFormatter": "biomejs.biome"
},
"[jsonc]": {
"editor.defaultFormatter": "biomejs.biome"
},
"[typescript]": {
"editor.defaultFormatter": "biomejs.biome",
"rewrap.wrappingColumn": 70
},
"[shellscript]": {
"rewrap.wrappingColumn": 70
}
}
}
}
Copy link
Member

Choose a reason for hiding this comment

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

is this actually necessary? do dev containers not use .vscode/settings.json?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

the extensions part, yes, because this way when creating the development container they are already installed 😃. but the rest is really an unnecessary duplication.
I think it was my force of habit to leave only the configurations in the dev container.
I'm going to change this

@aleclarson
Copy link
Member

aleclarson commented Aug 6, 2024

Sorry for the delay (was finishing v1 of the documentation site).

Happy to get this one merged once my question is answered :)

@aleclarson aleclarson merged commit 59a1a66 into radashi-org:main Aug 7, 2024
5 checks passed
Copy link

A new beta version 12.2.0-beta.1ee40e2 has been published to NPM. 🚀

To install:

The radashi@beta tag also includes this PR.

See the changes

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