2017 © Pedro Peláez
 

project vanilla-cli

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

image

vanilla/vanilla-cli

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  • Wednesday, August 1, 2018
  • by tburry
  • Repository
  • 9 Watchers
  • 0 Stars
  • 51 Installations
  • TypeScript
  • 0 Dependents
  • 0 Suggesters
  • 1 Forks
  • 21 Open issues
  • 44 Versions
  • 38 % Grown

The README.md

Vanilla's Command Line Interface

This tool is used to make various tasks easier for developers working on Vanilla Forums core or addons., (*1)

Current functionalities include:, (*2)

  • Building frontend assets (scripts, stylesheets, and images)
  • Generating cache files for addons
  • Converting addons' info arrays to json

See the vanilla-cli docs for documentation about the different commands., (*3)

Table of Contents

Installation

See our Installation Docs and our Quickstart Guide., (*4)

Basic Usage

  • From the command line:
vanilla --help

or, (*5)

vanilla SOME_COMMAND --help
  • From other php applications:
require('{{VANILLA_CLI_DIRECTORY}}/vendor/autoload.php');
$cli = new \Vanilla\Cli\Cli();
try {
    $cli->run($args); // Must be: array('vanilla', '{{COMMAND_NAME}}'[, options...])
} catch (Exception $e) {
    ...
}

Documentation

More detailed usage documentation can be found at our official vanilla-cli docs., (*6)

Tests

Some of the node.js build processes have unit and integration tests. Be sure that these pass before making pull requests. To run the tests:, (*7)

The NodeTools tests are run using jest., (*8)

$ yarn install

$ yarn test
# Or 
$ yarn test --watch

Debugging

During local development you may want to run a debugger. This is supported for the primary PHP process., (*9)

PHP

Ensure you IDE is properly configured for XDebug., (*10)

How to setup PHPStorm for XDebug, (*11)

Debugging in VsCode, (*12)

Running the Debugger

Just export XDEBUG_CONFIG from your shell, set up your IDE to listen for XDebug, and run your vanilla command., (*13)

export XDEBUG_CONFIG="idekey=PHPSTORM"
vanilla some-command --some-argument

The Versions

01/08 2018

dev-fix/autoprefixer

dev-fix/autoprefixer

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

17/07 2018

dev-master

9999999-dev

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

17/07 2018

dev-fix/bootstrap-order-hot

dev-fix/bootstrap-order-hot

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

12/07 2018

dev-fix/watching-dashboard

dev-fix/watching-dashboard

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

28/06 2018

dev-fix/path

dev-fix/path

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

28/06 2018

dev-feature/@vanilla-root-scss

dev-feature/@vanilla-root-scss

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

25/06 2018

dev-fix/alias-calculation

dev-fix/alias-calculation

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

08/06 2018

dev-fix/bundle-tests

dev-fix/bundle-tests

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

30/05 2018

dev-fix/cache-path

dev-fix/cache-path

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

28/05 2018

dev-fix/pin-version

dev-fix/pin-version

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

28/05 2018

dev-fix/webpack-regression

dev-fix/webpack-regression

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

24/05 2018

dev-refactor/typescript

dev-refactor/typescript

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

23/05 2018

dev-feature/no-core-addon

dev-feature/no-core-addon

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

07/05 2018

dev-feature/gdn-container

dev-feature/gdn-container

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

20/04 2018

dev-fix/hard-source-using-all-cpu

dev-fix/hard-source-using-all-cpu

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

18/04 2018

dev-feature/pretty-flag

dev-feature/pretty-flag

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

18/04 2018

dev-fix/format-on-hot

dev-fix/format-on-hot

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

17/04 2018

dev-feature/fix-watch

dev-feature/fix-watch

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

17/04 2018

dev-feature/typescript-coding-standard

dev-feature/typescript-coding-standard

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

13/04 2018

dev-feature/re-organize-build-output

dev-feature/re-organize-build-output

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

03/04 2018

dev-fix/config-defaults

dev-fix/config-defaults

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

20/03 2018

v1.5.0

1.5.0.0

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

02/02 2018

dev-feature/quill-support

dev-feature/quill-support

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

02/02 2018

dev-fix/version-bump

dev-fix/version-bump

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

11/01 2018

v1.4.3

1.4.3.0

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

05/01 2018

dev-fix/incorrect-message

dev-fix/incorrect-message

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

02/01 2018

v1.4.1

1.4.1.0

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

28/12 2017

dev-fix/live-reload-port

dev-fix/live-reload-port

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

28/12 2017

dev-fix/babel-parsing

dev-fix/babel-parsing

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

21/12 2017

v1.4.0

1.4.0.0

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

21/12 2017

dev-feature/core-build-process

dev-feature/core-build-process

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

21/12 2017

dev-feature/readme-update

dev-feature/readme-update

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

06/12 2017

v1.3.1

1.3.1.0

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

06/12 2017

dev-fix/linting-process

dev-fix/linting-process

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

01/12 2017

dev-fix/usability-issues

dev-fix/usability-issues

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

21/11 2017

dev-refactor/addonmanager-trait

dev-refactor/addonmanager-trait

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

17/11 2017

v1.3.0

1.3.0.0

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

06/11 2017

v1.2.0

1.2.0.0

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

27/10 2017

v1.1.0

1.1.0.0

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

27/10 2017

dev-fix/watch-src-folder

dev-fix/watch-src-folder

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

15/10 2017

dev-feature/binary-build

dev-feature/binary-build

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

12/10 2017

v1.0.1

1.0.1.0

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

19/08 2017

v1.0.0

1.0.0.0

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard

15/08 2017

dev-fix/remove-vscode

dev-fix/remove-vscode

Vanilla Forums Command Line Interface. Simplify common forum development related tasks.

  Sources   Download

MIT

The Requires

 

by Todd Burry
by Adam Charron
by Alexandre (DaazKu) Chouinard