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

Proposal: Add devcontainers init command similar to devcontainerize #890

Open
mathdroid opened this issue Sep 9, 2024 · 1 comment
Open

Comments

@mathdroid
Copy link

mathdroid commented Sep 9, 2024

Hello devcontainers team,

I've recently created a tool called devcontainerize (https://www.npmjs.com/package/devcontainerize, https://github.com/mathdroid/devcontainerize) that automatically detects a project's type and sets up the appropriate devcontainer configuration.

The tool:

  1. Detects the project type based on files in the current directory.
  2. Fetches appropriate Dockerfile and devcontainer.json from the devcontainers/images repository.
  3. Creates a .devcontainer directory with these files.
  4. Optionally adds .devcontainer to .gitignore if in a Git repository.

I believe a similar functionality could be valuable as part of the official devcontainers CLI, potentially as a devcontainers init command.

I'm keen to contribute this functionality to the official CLI if the team is interested. This could help streamline the process of setting up devcontainers for various project types and improve the overall developer experience.

Would you be open to discussing this further? I'd be happy to provide more details about the implementation or discuss how we could adapt it to fit within the existing CLI structure.

@bamurtaugh
Copy link
Member

Hi there! Thanks so much for opening this issue and for sharing the tool you created - this is super interesting!

I'd love to learn more about how you're thinking of implementing this. A couple thoughts that came to mind:

  • The CLI would need to have access to the index of dev container resources https://containers.dev/collections (it doesn't currently)
  • We'd probably want to implement functionality directly into the CLI, rather than calling upon a separate tool (i.e. avoid potential breakage issues)
  • We might want to put this functionality / command behind an experimental flag, to help measure user expectations (there isn't a guarantee the recommended setup will be 100% ideal)

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

No branches or pull requests

2 participants