Skip to content

build: Add devcontainer config #848

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.

Sign up for GitHub

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

Open
spenserblack wants to merge 3 commits into
base: master
Choose a base branch
from
Open

build: Add devcontainer config #848

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5ec11c4
build: Add devcontainer config
spenserblack May 22, 2026
16d2091
build(devcontainer): Open contributing docs by default
spenserblack May 22, 2026
84cd6ee
Use devcontainer config from @im7mortal
spenserblack May 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .devcontainer/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
FROM rust:1.95
Copy link
Copy Markdown
Author

@spenserblack spenserblack May 26, 2026

Choose a reason for hiding this comment

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

#848 (comment) 🙃


# Match a typical host Linux UID/GID (override in devcontainer.json "build" -> "args" if needed)
ARG USERNAME=vscode
ARG USER_UID=1000
ARG USER_GID=1000

ENV RUSTUP_HOME=/usr/local/rustup
ENV CARGO_HOME=/usr/local/cargo

RUN apt-get update && apt-get install -y --no-install-recommends \
sudo \
python3 \
python3-pip \
python3-matplotlib \
&& groupadd --gid $USER_GID $USERNAME \
&& useradd -s /bin/bash -m -u $USER_UID -g $USER_GID $USERNAME \
&& chown -R $USER_UID:$USER_GID $RUSTUP_HOME $CARGO_HOME \
&& echo "$USERNAME ALL=(ALL) NOPASSWD:ALL" > /etc/sudoers.d/$USERNAME \
Copy link
Copy Markdown
Author

@spenserblack spenserblack May 26, 2026

Choose a reason for hiding this comment

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

FWIW the default devcontainer configuration (mcr.microsoft.com/devcontainers/...) also does this.

&& chmod 440 /etc/sudoers.d/$USERNAME \
&& rm -rf /var/lib/apt/lists/*

USER $USERNAME
25 changes: 25 additions & 0 deletions .devcontainer/devcontainer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"name": "zip2",
"workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
"build": {
"dockerfile": "Dockerfile",
"context": "..",
"args": {
"USER_UID": "1000",
"USER_GID": "1000"
Comment on lines +8 to +9
}
},
"postCreateCommand": "rustup component add rustfmt clippy",
"customizations": {
"codespaces": {
"openFiles": ["CONTRIBUTING.md", ".github/pull_request_template.md"]
},
"vscode": {
"extensions": [
"rust-lang.rust-analyzer"
]
}
Comment on lines +17 to +21
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 22, 2026

Choose a reason for hiding this comment

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

medium

To better align the development environment with the project's strict CI requirements (clippy and multi-feature support), consider adding the even-better-toml extension for Cargo.toml validation and configuring rust-analyzer to use clippy and enable all features by default. This helps contributors identify issues locally before submitting a pull request.

    "vscode": {
      "extensions": [
        "rust-lang.rust-analyzer",
        "tamasfe.even-better-toml"
      ],
      "settings": {
        "rust-analyzer.check.command": "clippy",
        "rust-analyzer.cargo.allFeatures": true
      }
    }

},
"remoteUser": "vscode",
"updateRemoteUserUID": false
}