vanilla / vanilla-cli
Vanilla Forums Command Line Interface. Simplify common forum development related tasks.
Installs: 841
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 14
Forks: 4
Open Issues: 21
Type:project
Requires
- php: >=5.6.0
- vanilla/garden-cli: ~1.0
- dev-master
- v1.8.1
- v1.8.0
- v1.7.1
- v1.7.0
- v1.6.3
- v1.6.2
- 1.6.1
- 1.6.0
- v1.5.0
- v1.4.3
- v1.4.1
- v1.4.0
- v1.3.1
- v1.3.0
- v1.2.0
- v1.1.0
- v1.0.1
- v1.0.0
- dev-dependabot/npm_and_yarn/decode-uri-component-0.2.2
- dev-dependabot/npm_and_yarn/terser-4.8.1
- dev-dependabot/npm_and_yarn/copy-props-2.0.5
- dev-dependabot/npm_and_yarn/path-parse-1.0.7
- dev-dependabot/npm_and_yarn/hosted-git-info-2.8.9
- dev-dependabot/npm_and_yarn/y18n-3.2.2
- dev-dependabot/npm_and_yarn/elliptic-6.5.4
- dev-dependabot/npm_and_yarn/ini-1.3.7
- dev-fix/natives
- dev-fix/compile-@vanillafourms
- dev-feature/build-watch
- dev-feature/move-core-build
- dev-fix/autoprefixer
- dev-fix/bootstrap-order-hot
- dev-fix/watching-dashboard
- dev-fix/path
- dev-feature/@vanilla-root-scss
- dev-fix/alias-calculation
- dev-fix/bundle-tests
- dev-feature/gdn-container
This package is auto-updated.
Last update: 2023-02-03 16:04:00 UTC
README
This tool is used to make various tasks easier for developers working on Vanilla Forums core or addons.
Current functionalities include:
- 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.
Table of Contents
Installation
See our Installation Docs and our Quickstart Guide.
Basic Usage
- From the command line:
vanilla --help
or
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.
- Getting Started
- Build Tools
- Addon Utilities
- Build Tool Quickstart Guide
- Build Process - Core
- Build Process - 1.0
- Build Process - Legacy
- How Bundling Works
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:
The NodeTools tests are run using jest.
$ 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.
PHP
Ensure you IDE is properly configured for XDebug
.
How to setup PHPStorm for XDebug
Running the Debugger
Just export XDEBUG_CONFIG
from your shell, set up your IDE to listen for XDebug, and run your vanilla command.
export XDEBUG_CONFIG="idekey=PHPSTORM" vanilla some-command --some-argument