Initialize GitHub codespaces. (#107)

* Init devcontainer

* Update comment

* PHPCS

* Exclude .devcontainer from git archive

* Replace call to deprecated user_roles()

Author: richardbporter

.devcontainer/Dockerfile

@@ -0,0 +1,25 @@
+FROM mcr.microsoft.com/devcontainers/php:1-8.2-bookworm
+
+# Install MariaDB client
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+    && apt-get install -y mariadb-client \ 
+    && apt-get clean -y && rm -rf /var/lib/apt/lists/*
+
+# Install php-mysql driver
+RUN docker-php-ext-install mysqli pdo pdo_mysql
+
+# Install GD dependencies and extension
+RUN apt-get update && apt-get install -y \
+		libfreetype-dev \
+		libjpeg62-turbo-dev \
+		libpng-dev \
+	&& docker-php-ext-configure gd --with-freetype --with-jpeg \
+	&& docker-php-ext-install -j$(nproc) gd
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1
+

.devcontainer/devcontainer.json

@@ -0,0 +1,23 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/php-mariadb
+{
+	"name": "PHP & MariaDB",
+	"dockerComposeFile": "docker-compose.yml",
+	"service": "app",
+	"workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// For use with PHP or Apache (e.g.php -S localhost:8080 or apache2ctl start)
+	"forwardPorts": [8080, 3306]
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "sudo chmod a+x \"$(pwd)\" && sudo rm -rf /var/www/html && sudo ln -s \"$(pwd)\" /var/www/html"
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

.devcontainer/docker-compose.yml

@@ -0,0 +1,36 @@
+version: '3.8'
+
+services: 
+  app:
+    build:
+      context: .
+      dockerfile: Dockerfile
+
+    volumes:
+      - ../..:/workspaces:cached
+
+    # Overrides default command so things don't shut down after the process ends.
+    command: sleep infinity
+
+    # Runs app on the same network as the database container, allows "forwardPorts" in devcontainer.json function.
+    network_mode: service:db
+
+    # Use "forwardPorts" in **devcontainer.json** to forward an app port locally. 
+    # (Adding the "ports" property to this file will not forward from a Codespace.)
+
+  db:
+    image: mariadb:10.4
+    restart: unless-stopped
+    volumes:
+      - mariadb-data:/var/lib/mysql
+    environment:
+      MYSQL_ROOT_PASSWORD: mariadb
+      MYSQL_DATABASE: mariadb
+      MYSQL_USER: mariadb
+      MYSQL_PASSWORD: mariadb
+
+    # Add "forwardPorts": ["3306"] to **devcontainer.json** to forward MariaDB locally.
+    # (Adding the "ports" property to this file will not forward from a Codespace.)
+  
+volumes:
+  mariadb-data:

.gitattributes

@@ -3,3 +3,4 @@
 /tests                  export-ignore
 /phpunit.xml.dist       export-ignore
 /.phpunit.result.cache  export-ignore
+/.devcontainer          export-ignore

.github/dependabot.yml

@@ -12,3 +12,7 @@ updates:
     interval: monthly
   reviewers:
     - richardbporter
+- package-ecosystem: devcontainers
+   directory: "/"
+   schedule:
+     interval: monthly

.github/workflows/ci.yml

@@ -20,7 +20,7 @@ jobs:
     - uses: actions/checkout@v4
     - name: Start MySQL
       run: sudo /etc/init.d/mysql start
-    - name: Validate composer.json and composer.lock
+    - name: Validate composer.json
       run: composer validate --strict
     - name: Install dependencies
       run: composer install --prefer-dist --no-scripts --no-suggest --no-interaction

UsersCommands.php

@@ -6,6 +6,7 @@
 use Consolidation\OutputFormatters\Options\FormatterOptions;
 use Consolidation\OutputFormatters\StructuredData\RowsOfFields;
 use Consolidation\SiteAlias\SiteAliasManagerAwareTrait;
+use Drupal\user\Entity\Role;
 use Drupal\user\Entity\User;
 use Drush\Commands\DrushCommands;
 use Drush\Drush;
@@ -72,12 +73,14 @@ class UsersCommands extends DrushCommands implements SiteAliasManagerAwareInterf
    * @return \Consolidation\OutputFormatters\StructuredData\RowsOfFields
    *   The users as a RowsOfFields.
    */
-  public function listAll(array $options = [
-    'status' => InputOption::VALUE_REQUIRED,
-    'roles' => InputOption::VALUE_REQUIRED,
-    'no-roles' => InputOption::VALUE_REQUIRED,
-    'last-login' => InputOption::VALUE_REQUIRED,
-  ]) {
+  public function listAll(
+    array $options = [
+      'status' => InputOption::VALUE_REQUIRED,
+      'roles' => InputOption::VALUE_REQUIRED,
+      'no-roles' => InputOption::VALUE_REQUIRED,
+      'last-login' => InputOption::VALUE_REQUIRED,
+    ],
+  ) {
     // Use an entityQuery to dynamically set property conditions.
     $query = \Drupal::entityQuery('user')
       ->accessCheck(FALSE)
@@ -156,7 +159,7 @@ public function validateList(CommandData $commandData) {
     }
 
     // Set the (no-)roles options to an array but validate each one exists.
-    $actual = user_roles(TRUE);
+    $actual = Role::loadMultiple();
 
     foreach (['roles', 'no-roles'] as $option) {
       if ($roles = $input->getOption($option)) {