README

sgalinski CLI Task Runner

Installation

Move the 'sgc-core' folder inside your project root and execute the install script. If you are using composer, you
can install the sgc by running

composer require sgalinski/sgc-core

Then run the installer:

./sgc-core/install.sh

Local Installation

If you don't want to install the sgc command globally (e.g. in a server environment), just pass the --local flag to the install script.

./sgc-core/install.sh --local

Activation

If you purchased a license for the SGC, you will be provided with a
key that you need to set in your .sgc-config.json file.
Simply add a new field "license" at the bottom of the file and save your key here.

Windows

Please note:
While it is theoretically possible to run the sgc on Windows, this option is neither thoroughly tested,
nor is it advertised in any way. Things might have improved with Bash on Windows, but right now we do not have
the capacity to actively provide a stable version for Windows. Don't hesitate to get in touch with us
if you think you might be able to help out!

If you want to install the SGC on a Windows machine, there are some additional preparations are required:

All commands are to be executed in git-bash window, do not try to use the cmd! You'll probably already have the git-bash
installed if you are using git for Windows.

sgc images: runs the image optimizer on all images inside the folder you specified in the directories section of the .sgc-config.json

sgc images:uploaded: runs the image optimizer on all images inside the folder you specified in the images.optimize section of the .sgc-config.json

sgc open {sites} Opens a set of URLs in the default browser, that you can define inside your .sgc-config.json

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
will put into your projects root-directory.

Heads up
Prior to SGC 1.2.0, the config file was named config.json and lived inside the sgc-core/gulp folder. If this file is
still present, sgc will use it instead of the .sgc-config.json. It is highly advised to use .sgc-config.json instead!

directories

Holds the paths to the css, sass, javascript, images, sourcemaps and inline-svgs, relative to the extensions root.

webPath: path to your extension folder as seen from the web

basePath: path to your extension folder as seen from the filesystem

abovethefold

Configuration for the critical path css.

template: path to the src template

dest: path to the destination

js

The SGC will support you with writing next generation JavaScript and executing it in Browsers today, by transpiling it
to EcmaScript 5 compliant code. Currently EcmaScript 6 Syntax and TypeScript are supported.

compiler: es6|typescript

libraryPaths: additional locations that should be searched when resolving CommonJS require statements

excludeFromQa: *glob patterns with locations that hold JavaScript that does not need to be linted (vendor stuff)

images

optimize: locations of user uploaded images that should be optimized

extensions

A list of extensions that should be included in the watch task. Please note, that the very first extension in this list is expected to be your project_theme.

browsersync

BrowserSync is a neat tool that will help you during the development and testing process. When you run sgc, it will spin
up a small webserver that proxies the URL specified in your .sgc-config.json. If you change a JavaScript or Sass file
inside an extension that is on your watch list (see the option above), BrowserSync will automatically reload the page
or inject your changes directly into the browser. You can also open several instances of the BrowserSync URL in different
browser windows and BS will take care of synchronizing all input and scroll events between them.

Usage

You can run a specific task on a specific component, or start a watcher that will fire up BrowserSync and run tasks when
source files change. Extensions that will be watched are defined in your .sgc-config.json file for each project.

If you run a specific task, you need to specify the extension you want the task to run on with the --ext parameter.

sgc css --ext project_base

There are a few available tasks you need to remember:

default/watch task

sgc

Starts a project wide watcher that will trigger the css/javascript task when you change any .scss, or .js-file and opens
the website in your browser, as a browsersync session (changed js and css will automatically get injected when recompiled).

Hint: If you already have a browsersync instance open in your browser, you can pass the argument -s to restart the session without opening a browser.

css:svg task (will be called by the css task automatically)

sgc css:svg --ext [extension name]

Triggers the generation of Sass-mixins for all SVGs inside the given directory. Each mixin will enable the usage of the
associated SVG as a css background image.

css:abovethefold (will be called by the css task automatically)

svg css:abovethefold

This task will read the html file you specified as abovethefold.template, read every statement in it and replace
it with the css styles the referenced file contains, as an inline style tag. To make use of this feature, you should
create a separate css file in your project (abovethefold.scss -> abovethefold.css), as well as an html-template file
that references this stylesheet (note that the path needs to be relative to the template file). You can then set this
template file as your PageRenderTemplate.
All styles inside your abovethefold.css file will now be inlined directly into the HTML of your website. Note that you
should think about what to put in this file only styles that should be available directly after the render process on
every page should go there.

css task

sgc css --ext [extension name]

Triggers css compilation inside the given directory. Note, that this task will also run the sprite task before it starts.

Assumptions:

all scss files are inside the sass directory, relative to the given path.

all css files go into the stylesheets directory, relative to the given path.

images task

sgc images --ext [extension name]

Optimizes all images for the given path.

Assumptions:

all images are inside the image directory, relative to the given path.

optimize images in fileadmin and uploads

sgc images:uploaded

This tasks optimizes all images (png, jpg, gif, svg) inside the folders you specified in the sgc-config.json file. You might want to
run this task on a regular basis to compress user uploaded media.

Extending the sgc with your own modules

You can easily extend the sgc functionality by writing your own modules. Simply create a sgc-scripts folder next to sgc-core
and put your custom scripts in there. Right now only shell-scripts with are supported, other languages might follow in the future.