Commit 089212ee authored by Philipp Nowinski's avatar Philipp Nowinski

[FEATURE] add complete list of commands to README

parent 19fa75be
......@@ -33,6 +33,20 @@ with rubygems that occurs on Windows. In this case, you will have to install scs
error here: https://gist.github.com/luislavena/f064211759ee0f806c88
* You have to open git-bash with administrator privileges to run the installation script
## Available Commands
* ```sgc```: Loads a BrowserSync instance and listens for file changes (triggers css and js compilation)
* ```sgc -s```: Loads the BrowserSync instance, but prevents it from automatically open in the browser
* ```sgc -d domain.dev```: Starts the BrowserSync instance with the specified dev-domain (must be configured in .sgc-config.json)
* ```sgc css```: Runs the CSS QA task (linting) and compiles all CSS files
* ```sgc css:qa```: Runs only the CSS QA task (linting)
* ```sgc js```: Runs the JS QA task (linting) and compiles all JS/TS files
* ```sgc js:qa```: Runs only the JS QA task (linting)
* ```sgc releaseExtension --ext {extension name}```: Starts a questionaire wich helps to update an extension according to SEMVER (updates composer.json and ext_emconf.php)
* ```sgc lighthouse```: **experimental** runs a lighthouse test suite against your site
You can call every command with the ```--production``` flag. This will prevent the toolchain from generating SourceMaps.
## Configuration
To configure the frontend build process to your needs, you will have to modify the .sgc-config.json that the installer
......
......@@ -3,7 +3,7 @@
"description": "sgalinski command line interface",
"homepage": "https://www.sgalinski.de",
"license": ["SEE LICENSE IN LICENSE.md"],
"version": "2.3.1",
"version": "2.4.0",
"replace": {
"sgc-core": "self.version"
}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment