CI, scaffolding, and automated testing utilities
npm install o3-clio3-cli
======
CI, scaffolding, and automated testing utilities
sh-session
$ npm install -g o3-cli
$ o3-cli COMMAND
running command...
$ o3-cli (-v|--version|version)
o3-cli/2.19.2 linux-x64 node-v12.22.0
$ o3-cli --help [COMMAND]
USAGE
$ o3-cli COMMAND
...
`
Commands
* [](#o3-cli-autocomplete-shell)
* o3-cli axe
*
*
*
*
* [](#o3-cli-eslint-directories)
* o3-cli generate BOILERPLATE
* [](#o3-cli-help-command)
* [o3-cli phpcs [ROOTDIR]](#o3-cli-phpcs-rootdir)
* [o3-cli phplint [ROOTDIR]](#o3-cli-phplint-rootdir)
* [o3-cli phpunit [ROOTDIR]](#o3-cli-phpunit-rootdir)
* o3-cli setupdisplay autocomplete installation instructions
USAGE
$ o3-cli autocomplete [SHELL]ARGUMENTS
SHELL shell type
OPTIONS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
EXAMPLES
$ o3-cli autocomplete
$ o3-cli autocomplete bash
$ o3-cli autocomplete zsh
$ o3-cli autocomplete --refresh-cache
_See code: @oclif/plugin-autocomplete_
Describe the command here
USAGE
$ o3-cli axeOPTIONS
-n, --name=name name to print
DESCRIPTION
...
Extra documentation goes here
_See code: src/commands/axe.js_
Run a backstop test.
USAGE
$ o3-cli backstop COMMANDARGUMENTS
COMMAND (reference|test|generatetestfile) "reference" to create a snapshot to compare against. "test" to test.
"generatetestfile" to write a dynamic test to a file
OPTIONS
-c, --configFile=configFile [default: tests/backstop/config.js] path to config file
-d, --dynamic run a dynamic test using a remote api for list of urls
-l, --limit=limit (For dynamic tests): limit number of urls returned for a content or post type.
-m, --menus=menus (For dynamic tests): return urls from specific menus. e.g.
--menus=primary,secondary
-m, --viewports=viewports Pass comma seperated list: mobile,desktop,tablet
-p, --content_types=content_types (For dynamic tests): return urls from specific content types. e.g.
--content_types=page,blog
-p, --paragraph_types=paragraph_types (For dynamic tests): return urls of content that contains a paragraph type.
-r, --referenceUrl=referenceUrl [default: http://dev-drupal-8-composer-ci.pantheonsite.io] reference url
-t, --testUrl=testUrl [default: https://google.com] test url
-u, --urlListSource=urlListSource url list source coming from support module
DESCRIPTION
...
Edit your default settings in .o3-clirc.yaml. Then run:
$ o3-cli generate config (if you haven't run already)
$ o3-cli generate tests-backstop (if you have no test config yet)
$ o3-cli backstop reference
$ o3-cli backstop test
_See code: src/commands/backstop.js_
Describe the command here
USAGE
$ o3-cli backstop-wizardOPTIONS
-u, --o3cli_service_endpoint=o3cli_service_endpoint url list source coming from support module
DESCRIPTION
Create a
_See code: src/commands/backstop-wizard.js_
Run behat tests
USAGE
$ o3-cli behatOPTIONS
-n, --name=name name to print
DESCRIPTION
...
Extra documentation goes here
_See code: src/commands/behat.js_
cypress wrapper with mocha reporter integration
USAGE
$ o3-cli cypress COMMANDARGUMENTS
COMMAND (run|open) "run" to run tests with mocha reporter. "open" to open cypress ui.
OPTIONS
-b, --browser=browser [default: chrome] browser
-e, --env=env env flags
-h, --headless Run headless
-s, --spec=spec tests to run relative to o3-clirc.yaml declared cypress_config_path variable
-t, --testUrl=testUrl [default: http://dev-drupal-8-composer-ci.pantheonsite.io] test url
DESCRIPTION
cypress wrapper with mocha reporter integration
_See code: src/commands/cypress.js_
Run Eslint code sniffer
USAGE
$ o3-cli eslint [DIRECTORIES]ARGUMENTS
DIRECTORIES directories
OPTIONS
-f, --format=format format
-i, --ignore-path=ignore-path ignore
DESCRIPTION
...
"./vendor/bin/Eslint --standard=Drupal --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md
--ignore=node_modules,bower_components,vendor ./web/themes",
_See code: src/commands/eslint.js_
Generate circleci or automated tests boilerplates. Run this command from the root of your repo.
USAGE
$ o3-cli generate BOILERPLATEARGUMENTS
BOILERPLATE (config|tests-eslint|tests-backstop|tests-cypress|ci-drupal8-composer|ci-drupal8|ci-wordpress|ci-wordpres
s|ci-npm-publish|ci-heroku) Name of boilerplate directory
_See code: src/commands/generate.js_
display help for o3-cli
USAGE
$ o3-cli help [COMMAND]ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
_See code: @oclif/plugin-help_
Run phpcs code sniffer
USAGE
$ o3-cli phpcs [ROOTDIR]ARGUMENTS
ROOTDIR [default: web/modules/custom,web/themes] Generate CI and automated test boierplates
OPTIONS
-i, --ignore=ignore [default: node_modules,bower_components,vendor] ignore
-s, --standard=standard [default: Drupal,DrupalPractice] standard
-x, --extensions=extensions [default: php,module,inc,install,test,profile,theme,css,info,txt,md] extensions
DESCRIPTION
...
"./vendor/bin/phpcs --standard=Drupal --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md
--ignore=node_modules,bower_components,vendor ./web/themes",
_See code: src/commands/phpcs.js_
Run php lint
USAGE
$ o3-cli phplint [ROOTDIR]ARGUMENTS
ROOTDIR [default: web/modules/custom,web/themes] Generate CI and automated test boierplates
OPTIONS
-x, --exclude=exclude extensions
-x, --extensions=extensions [default: php,module,inc,install,test,profile,theme] extensions
DESCRIPTION
...
"./vendor/bin/phplint",
_See code: src/commands/phplint.js_
Run phpunit.
USAGE
$ o3-cli phpunit [ROOTDIR]ARGUMENTS
ROOTDIR [default: web/core, web/modules/custom] Directories that contain unit tests that need to be run
OPTIONS
-c, --configuration=configuration [default: web/core/phpunit.xml.dist] configuration
-t, --testsuite=testsuite [default: unit] testsuite
DESCRIPTION
...
Edit your default settings in .o3-clirc.yaml. Then run:
$ o3-cli phpunit
_See code: src/commands/phpunit.js_
Describe the command here
USAGE
$ o3-cli setupOPTIONS
-u, --o3cli_service_endpoint=o3cli_service_endpoint url list source coming from support module
DESCRIPTION
...
Extra documentation goes here
_See code: src/commands/setup.js_