README.md 9.79 KB
Newer Older
Philipp Nowinski's avatar
Philipp Nowinski committed
1
[![sgalinski Internet Services](https://www.sgalinski.de/fileadmin/files/for-external-usage/logo.svg  "sgalinski")](https://www.sgalinski.de/typo3-produkte-webentwicklung/gulp-frontend-toolchain/)
Philipp Nowinski's avatar
Philipp Nowinski committed
2

Philipp Nowinski's avatar
Philipp Nowinski committed
3
# sgalinski command line interface
Philipp Nowinski's avatar
Philipp Nowinski committed
4

Philipp Nowinski's avatar
Philipp Nowinski committed
5
> **Please note:**
Philipp Nowinski's avatar
Philipp Nowinski committed
6
> The CLI is intended to be used with bash or zsh. In order for scss-lint to work, you need to have ruby installed on your machine.
Philipp Nowinski's avatar
Philipp Nowinski committed
7

Philipp Nowinski's avatar
Philipp Nowinski committed
8
## Installation
Philipp Nowinski's avatar
Philipp Nowinski committed
9

10
Move the 'sgc-core' folder inside your project root and execute the install script.
Philipp Nowinski's avatar
Philipp Nowinski committed
11 12

```bash
13 14 15 16 17 18 19 20 21
./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.

```bash
./sgc-core/install.sh --local
Philipp Nowinski's avatar
Philipp Nowinski committed
22 23
```

Philipp Nowinski's avatar
Philipp Nowinski committed
24 25 26 27 28 29 30 31 32 33 34 35
### Windows

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.
* Install NVM for Windows: https://github.com/coreybutler/nvm-windows
* You might run into an error where the SGC is not able to install the scss_lint ruby gem. This is due to an SSL error
with rubygems that occurs on Windows. In this case, you will have to install scss_lint manually. Read more about that
error here: https://gist.github.com/luislavena/f064211759ee0f806c88
* You have to open git-bash with administrator privileges to run the installation script 

36 37 38 39 40 41 42 43 44 45
## SGC Releases

Please note that the following steps need to be executed before a new release:

* Raise version number (according to SEMVER) in the following files:
 * composer.json
 * package.json
 * core/version.conf
* Add a git-tag with the new version number

46 47 48 49 50 51 52 53 54 55 56
## 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
Philipp Nowinski's avatar
Philipp Nowinski committed
57
* ```sgc open {sites}``` Opens a set of URLs in the default browser, that you can define inside your .sgc-config.json
58 59 60

You can call every command with the ```--production``` flag. This will prevent the toolchain from generating SourceMaps.

Philipp Nowinski's avatar
Philipp Nowinski committed
61 62
## Configuration

63 64 65 66 67 68
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!
Philipp Nowinski's avatar
Philipp Nowinski committed
69 70 71

### directories

Philipp Nowinski's avatar
Philipp Nowinski committed
72 73 74 75
Holds the paths to the css, sass, javascript, images, sprites, 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*
Philipp Nowinski's avatar
Philipp Nowinski committed
76

77
### abovethefold (enterprise feature)
Philipp Nowinski's avatar
Philipp Nowinski committed
78 79 80 81 82 83 84 85

Configuration for the critical path css.

* template: *path to the src template*
* dest: *path to the destination*

### js

Philipp Nowinski's avatar
Philipp Nowinski committed
86 87 88
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.

89
* compiler: *es6|typescript* (enterprise feature)
Philipp Nowinski's avatar
Philipp Nowinski committed
90
* libraryPaths: *additional locations that should be searched when resolving CommonJS require statements*
Philipp Nowinski's avatar
Philipp Nowinski committed
91 92
* excludeFromQa: *glob patterns with locations that hold JavaScript that does not need to be linted (vendor stuff)

93
### images (enterprise feature)
Philipp Nowinski's avatar
Philipp Nowinski committed
94 95 96 97 98 99 100

* 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.

Philipp Nowinski's avatar
Philipp Nowinski committed
101 102 103 104 105 106 107 108
### 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.

Philipp Nowinski's avatar
Philipp Nowinski committed
109 110
## Usage
You can run a specific task on a specific component, or start a watcher that will fire up BrowserSync and run tasks when
Philipp Nowinski's avatar
Philipp Nowinski committed
111
source files change. Extensions that will be watched are defined in your .sgc-config.json file for each project.
Philipp Nowinski's avatar
Philipp Nowinski committed
112 113 114 115

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

```bash
Philipp Nowinski's avatar
Philipp Nowinski committed
116
sgc css --ext project_base
Philipp Nowinski's avatar
Philipp Nowinski committed
117 118 119 120 121 122 123
```

There are a few available tasks you need to remember:

### default/watch task

```bash
Philipp Nowinski's avatar
Philipp Nowinski committed
124
sgc
Philipp Nowinski's avatar
Philipp Nowinski committed
125 126 127 128 129 130
```
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.

Philipp Nowinski's avatar
Philipp Nowinski committed
131
### sprite task (will be called by the css task automatically)
Philipp Nowinski's avatar
Philipp Nowinski committed
132 133

```bash
Philipp Nowinski's avatar
Philipp Nowinski committed
134
sgc css:sprites --ext [extension name]
Philipp Nowinski's avatar
Philipp Nowinski committed
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
```

Triggers sprite generation inside the given directory.

Assumptions:

* all sprite images are inside images/sprites, relative to the given path.
* all sprite images are PNGs.
* there is a sass directory, next to the images folder.

This task will generate a png inside the images folder, containing all the sprites and a .scss file inside the sass
folder, which will provide the necessary mixins. To use the sprites inside your SASS code, import the _sprite.scss file.
You can then use the following mixins:

```scss
// will output css for a sprite image 'box.png'
.element {
Philipp Nowinski's avatar
Philipp Nowinski committed
152
	@include sprite ($box);
Philipp Nowinski's avatar
Philipp Nowinski committed
153 154 155 156
}
```

The @sprite mixin already contains width and height. If you need these values for something else, use the @sprite-width
Philipp Nowinski's avatar
Philipp Nowinski committed
157
and @sprite-height functions.
Philipp Nowinski's avatar
Philipp Nowinski committed
158

Philipp Nowinski's avatar
Philipp Nowinski committed
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
### css:svg task (will be called by the css task automatically)
```bash
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.

```scss
@import 'svg'; // imports the file with the generated mixins (inside your Sass-root)

.icon-globe {
    @include inline-svg($icon-globe); // inserts the file icon-globe.svg as an inlined background-image
}
```


176
### css:abovethefold (will be called by the css task automatically) (enterprise feature)
Philipp Nowinski's avatar
Philipp Nowinski committed
177 178 179 180 181 182 183 184 185 186 187 188 189
```bash
svg css:abovethefold
```

This task will read the html file you specified as abovethefold.template, read every <link> 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](https://docs.typo3.org/typo3cms/TyposcriptReference/Setup/Config/Index.html#pagerenderertemplatefile).
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.

Philipp Nowinski's avatar
Philipp Nowinski committed
190 191 192
### css task

```bash
Philipp Nowinski's avatar
Philipp Nowinski committed
193
sgc css --ext [extension name]
Philipp Nowinski's avatar
Philipp Nowinski committed
194 195 196 197 198 199 200 201 202
```

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.

203
### images task (enterprise feature)
Philipp Nowinski's avatar
Philipp Nowinski committed
204 205

```bash
Philipp Nowinski's avatar
Philipp Nowinski committed
206
sgc images --ext [extension name]
Philipp Nowinski's avatar
Philipp Nowinski committed
207 208 209 210 211 212 213 214
```

Optimizes all images for the given path.

Assumptions:

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

215
### optimize images in fileadmin and uploads (enterprise feature)
Philipp Nowinski's avatar
Philipp Nowinski committed
216 217

```bash
Philipp Nowinski's avatar
Philipp Nowinski committed
218
sgc images:uploaded
Philipp Nowinski's avatar
Philipp Nowinski committed
219 220
```

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

224
# Extending the sgc with your own modules (enterprise feature)
Philipp Nowinski's avatar
Philipp Nowinski committed
225

226
You can easily extend the sgc functionality by writing your own modules. Simply create a sgc-scripts folder next to sgc-core
Philipp Nowinski's avatar
Philipp Nowinski committed
227 228 229 230 231
and put your custom scripts in there. Right now only shell-scripts with are supported, other languages might follow in the future.

Execute your custom scripts by calling sgc <scriptName>

```
232 233
+ sgc-core
+ sgc-scripts
Philipp Nowinski's avatar
Philipp Nowinski committed
234 235 236 237 238 239 240 241 242
    - updateInstance.sh
    - updateDeployData.sh
```


```bash
sgc updateInstance
```

Philipp Nowinski's avatar
Philipp Nowinski committed
243 244
# Troubleshooting

Philipp Nowinski's avatar
Philipp Nowinski committed
245 246 247 248 249
## Timeouts of the registry while installing the toolchain

Please try to remove the npm-shrinkgwrap.json file and execute the following commands:

```bash
250
cd sgc-core
Philipp Nowinski's avatar
Philipp Nowinski committed
251 252 253 254
rm -rf node_modules
npm set registry http://registry.npmjs.org/
npm install
```