Skip to content

Ease contribution with Devcontainer #1041

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
mk-mxp wants to merge 3 commits into
base: main
Choose a base branch
from
+47 −2
Open

Ease contribution with Devcontainer #1041

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
8f4f4e7
Provide devcontainers for GitHub contributors
mk-mxp Aug 2, 2026
a6bd0b2
PHPUnit / PHPCS VSCode extensions unusable
mk-mxp Aug 2, 2026
54c331f
Update base image
mk-mxp Aug 2, 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
13 changes: 13 additions & 0 deletions .devcontainer/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
FROM mcr.microsoft.com/devcontainers/php:4-8.4-bookworm

RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
&& apt-get -y install --no-install-recommends jq \
&& apt-get clean -y && rm -rf /var/lib/apt/lists/*

# ds is pinned to v1, since v2 (the only version building against PHP 8.4 via
# PECL/docker-php-ext-install) dropped Vector/Deque/Stack/Queue/PriorityQueue.
RUN curl -L -o install-php-extensions \
https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions \
&& chmod +x install-php-extensions \
&& ./install-php-extensions gmp ds-^1@stable intl \
&& rm install-php-extensions
Comment on lines +7 to +13

@homersimpsons homersimpsons Aug 3, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we instead upgrade the test runner and everything to V2 ? Or would you prefer doing this in the php 8.5 upgrade ?

Note that even if they were removed, new alternatives were provided https://github.com/php-ds/ext-ds/releases/tag/v2.0.0

20 changes: 20 additions & 0 deletions .devcontainer/devcontainer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"name": "Exercism PHP",
"build": {
"dockerfile": "Dockerfile"
},
"containerEnv": {
"XDEBUG_MODE": "off"
},
"postCreateCommand": "composer install",
"customizations": {
"vscode": {
"extensions": [
"bmewburn.vscode-intelephense-client"
],
"settings": {
"php.suggest.basic": false
}
}
}
}
16 changes: 14 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,26 @@ Exercism exercises in PHP
Follow these instructions to contribute to the PHP track.
To solve the exercises, head to the [PHP track][exercism-track-home] and check the [documentation][exercism-track-installation].

## Quick Start with Dev Containers

This repo includes a [dev container](.devcontainer) that provides PHP 8.4, Composer, `jq` and all other dependencies out of the box.
Open the repo in [VS Code][vscode-devcontainers] (or [GitHub Codespaces][github-codespaces]) and select "Reopen in Container" - `composer install` runs automatically once it starts.

## Install Dependencies

The following system dependencies are required:

- `composer`, as recommended in the [PHP track installation docs][exercism-track-installation-composer].
- [`bash` shell][gnu-bash].
- PHP V8.4+ CLI.
- PHP V8.4+ CLI, with the following extensions:
- `ds` (V1.x)
- `intl`
- Default modules: `Core`, `ctype`, `date`, `dom`, `fileinfo`, `filter`, `hash`, `iconv`, `json`, `libxml`, `mbstring`, `pcre`, `random`, `Reflection`, `SimpleXML`, `sodium`, `SPL`, `standard`, `tokenizer`, `xml`, `xmlreader`, `xmlwriter`, `zlib`

@homersimpsons homersimpsons Aug 3, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Shouldn't we just mention ext-* requirements? It does not look relevant to mention "Core", "ctype", "date"...

- An active Internet connection for installing required tools / composer packages.
- [`jq`][jq], if you change the difficulty or add a practice exercise.

The [dev container](.devcontainer) already provides all of the above.

Run the following command to get started with this project:

```shell
Expand Down Expand Up @@ -98,7 +108,9 @@ Run `bin/order-exercises.sh` when you set the exercise difficulty to a sensible
[exercism-track-home]: https://exercism.org/docs/tracks/php
[exercism-track-installation]: https://exercism.org/docs/tracks/php/installation
[exercism-track-installation-composer]: https://exercism.org/docs/tracks/php/installation#h-install-composer
[github-codespaces]: https://docs.github.com/en/codespaces/overview
[gnu-bash]: https://www.gnu.org/software/bash/
[jq]: https://jqlang.org/
[local-file-phpcs-config]: phpcs.xml
[psr-12]: https://www.php-fig.org/psr/psr-12
[jq]: https://jqlang.org/
[vscode-devcontainers]: https://code.visualstudio.com/docs/devcontainers/containers
Loading