Initial Dockerfile and docs

Author: mike-potter

Dockerfile

@@ -0,0 +1,38 @@
+# Extend the Docksal CLI per https://docs.docksal.io/stack/extend-images/
+#
+# Note how we use cli:2 here, which refers the latest available 2.x version
+# So that we wouldn't need to update this every time new version of Docksal cli releases
+FROM docksal/cli:2-php7.3
+
+# Puppeteer dependencies taken from https://github.com/alekzonder/docker-puppeteer
+# Install addtional apt packages needed for pa11y and puppeteer
+# Added vim.
+RUN apt-get update && \
+  apt-get install -yq gconf-service libasound2 libatk1.0-0 libc6 libcairo2 libcups2 libdbus-1-3 \
+  libexpat1 libfontconfig1 libgcc1 libgconf-2-4 libgdk-pixbuf2.0-0 libglib2.0-0 libgtk-3-0 libnspr4 \
+  libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1 libxcomposite1 \
+  libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss1 libxtst6 \
+  fonts-ipafont-gothic fonts-wqy-zenhei fonts-thai-tlwg fonts-kacst \
+  ca-certificates fonts-liberation libappindicator1 libnss3 lsb-release xdg-utils wget vim && \
+  apt-get --purge remove && \
+  apt-get clean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/*
+
+# All further commands will be performed as the docker user.
+USER docker
+SHELL ["/bin/bash", "-c"]
+
+# Remove ruby from Docksal CLI
+RUN \
+	# Initialize the user environment (this loads rvm)
+	. $HOME/.profile && \
+    rvm remove ruby-${RUBY_VERSION_INSTALL}
+
+# Install additional global npm dependencies
+RUN \
+	# Initialize the user environment (this loads nvm)
+	. $HOME/.profile && \
+	# Install node packages
+	npm install -g [email protected] pa11y@5 pa11y-ci@2
+
+# IMPORTANT! Switching back to the root user as the last instruction.
+USER root

README.md

@@ -1 +1,62 @@
-# docker-cli
+# Outrigger cli
+
+> Docker image adding pa11y and other common tools to [Docksal CLI](https://github.com/docksal/service-cli).
+
+[![GitHub tag](https://img.shields.io/github/tag/phase2/docker-cli.svg)](https://github.com/phase2/docker-cli) [![Docker Stars](https://img.shields.io/docker/stars/outrigger/cli.svg)](https://hub.docker.com/r/outrigger/cli) [![Docker Pulls](https://img.shields.io/docker/pulls/outrigger/cli.svg)](https://hub.docker.com/r/outrigger/cli) [![](https://images.microbadger.com/badges/image/outrigger/cli:dev.svg)](https://microbadger.com/images/outrigger/cli:dev "Get your own image badge on microbadger.com")
+
+This Docker image adds the following tools to the docksal/cli image:
+* [pa11y v5](https://github.com/pa11y/pa11y)
+* [puppeteer v1.2](https://github.com/puppeteer/puppeteer) (needs testing with v2.x)
+* vim
+
+## Using pa11y with Docksal
+
+In the project `.docksal/docksal.env` set the following:
+
+```
+CLI_IMAGE='outrigger/cli'
+```
+
+Then start your project with `fin start`.  Once the containers have started, run
+the webpack-dev-server for your theme:
+
+```
+cd THEME_PATH
+fin exec npm run theme
+```
+where the `theme` job is defined in `package.json` as:
+```
+scripts:
+    "theme": "cross-env-shell NODE_ENV=development \"webpack-dev-server --config ./webpack.config.js --hot\"",
+```
+
+This will use your webpack config and enter watch mode to recompile when changes
+are detected to your theme files.
+
+Once the theme has compiled and the webpack-dev-server is running, execute pa11y
+tests via:
+
+```
+fin exec npm run pa11y
+```
+where the `pa11y` job is defined in `package.json` as:
+```
+scripts:
+  "pa11y": "pa11y-ci --config pa11y.js"
+```
+
+## Resources
+
+* General questions on Docksal should go to the [docksal documenation](https://docs.docksal.io/)
+* General issues on Puppeteer should check out the [base Puppeteer image](https://hub.docker.com/r/alekzonder/puppeteer/). Note: you can follow the instructions in that README to take screenshots. Since this image is based on that, you should not need a further Docker iamge download.
+* [Puppeteer Github Project](https://github.com/GoogleChrome/puppeteer)
+* [Official Puppeteer Docker guidance](https://github.com/GoogleChrome/puppeteer/blob/master/docs/troubleshooting.md#running-puppeteer-in-docker)
+* [pa11y @ Github](https://github.com/pa11y/pa11y)
+
+## Security Reports
+
+Please email [email protected] with security concerns.
+
+## Maintainers
+
+[![Phase2 Logo](https://s3.amazonaws.com/phase2.public/logos/phase2-logo.png)](https://www.phase2technology.com)

build.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+docker build -t outrigger/cli .