Dev Containers

Two dev containers are included in the repository to streamline development.

• php-container is used for writing and testing Vigilant.
• python-container is used for writing and building the documentation.

PHP Container

php-container uses composer to manage dependencies and run code quality tools.

Commands

Install dependencies (Dependencies are automatically installed when the container starts)

composer install

Analysis code using PHP_CodeSniffer and PHPStan

composer lint

Fix code formatting using PHP_CodeSniffer

composer fix

Test code using PHPUnit

composer test

Python Container

python-container uses Pipenv to manage dependencies and run MkDocs commands.

Commands

Install dependencies (Dependencies are automatically installed when the container starts)

pipenv install

Run the documentation development server

pipenv run zensical serve

Build the documentation

pipenv run zensical build --clean