devcontainer

[abernier]

Description

This PR aims at enhancing the developer experience, by allowing anyone to have the project up-and-running in a Codespace in one click, right from his browser: https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/setting-up-your-repository/facilitating-quick-creation-and-resumption-of-codespaces

This PR adds a .devcontainer to the repository, that:

• runs a linux machine (with enough memory)
• with node 18
• automatically being pre-npm ci
• launches npm start
• opens a http://localhost:8080 preview
• pre-installs eslint extension

NB: It also works locally with Dev Containers extension

---

• Ready for review
• let the reviewer runs this devcontainer based on this abernier:devcontainer branch:

[github-actions]

📦 Bundle size

Full ESM build, minified and gzipped.

Filesize dev	Filesize PR	Diff
642.6 kB (159.1 kB)	642.6 kB (159.1 kB)	+0 B

🌳 Bundle size after tree-shaking

Minimal build including a renderer, camera, empty scene, and dependencies.

Filesize dev	Filesize PR	Diff
432.5 kB (104.8 kB)	432.5 kB (104.8 kB)	+0 B

[abernier]

this is to allow overriding servez options, for --ssl=false in https://github.com/mrdoob/three.js/pull/26055/files#diff-24ad71c8613ddcf6fd23818cb3bb477a1fb6d83af4550b0bad43099813088686R9

see: concurrently -P option

[LeviPesin]

Why do we need --ssl=false?

[abernier]

--ssl=false is only for inside the codespace, on https://localhost:8080, ssl will be ON like before

Actually --ssl=false defined in devcontainer.json postAttachCommand, will override the --ssl flag defined by default in the npm start script, so it has no impact on the npm start command run locally

[abernier]

the reason is that the endpoint Codespace mounts for the preview is already configured with ssl

[mrdoob]

Can the .devcontainer/devcontainer.json file go inside .github/ and avoid polluting the root of the repo?

[abernier]

Can the .devcontainer/devcontainer.json file go inside .github/ and avoid polluting the root of the repo?

Unfortunately I think it cannot: https://containers.dev/implementors/spec/#devcontainerjson

Also because devcontainers are not directly related to github: you can for example execute it on your local vscode with this extension https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers

[abernier]

however you can have a .devcontainer.json file at root of the project

the only drawback I can see, is if we want later to provide our own Dockerfile for the image: in that case, having a .devcontainer/ folder to group them all would be handy, but we can start small with root .devcontainer.json file and see later

Tell me if you prefer that option, I'll change into a .devcontainer.json file at root

[mrdoob]

This PR aims at enhancing the developer experience, by allowing anyone to have the project up-and-running in a Codespace in one click, right from his browser

Do you mind doing a screen recording showing the developer experience?

[abernier]

Do you mind doing a screen recording showing the developer experience?

You can actually try it directly with that link: https://github.com/codespaces/new?template_repository=abernier%2Fthree.js&ref=devcontainer

[Mugen87]

TBH, downloading the repo and executing npm i && npm start isn't that complicated. To me, this does not justify yet another service that we are going to use (and maintain). Something like Codespace should work without requiring the repositories to add additional configuration.

[mrdoob]

Agreed. The PR didn't have many upvotes either...