Skip to content

Commit 251e60a

Browse files
author
Marco Solazzi
committed
Merge branch 'hotfix/4.0.3'
2 parents c7ef05e + 653e0d6 commit 251e60a

File tree

3 files changed

+19
-18
lines changed

3 files changed

+19
-18
lines changed

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,13 @@ WOK is a loosely opinionated boilerplate for web development built with flexibil
1616
* Development server and asset live-reload with [BrowserSync](http://www.browsersync.io/) and [Weinre](http://people.apache.org/~pmuellr/weinre/) remote debugging
1717
* Incremental deploy with [rsync](https://rsync.samba.org/) or [lftp](http://lftp.yar.ru/)
1818
* Remote backup / rollback (UNIX SSH environments only)
19-
* more to come... (project scaffolding, jade support)
19+
2020

2121

2222
## Requirements
2323

24-
* Node.js >= 4.0.0 (we strongly succest to use something like [nvm](https://github.com/creationix/nvm))
24+
* Node.js >= 4.0.0 (we strongly suggest to use something like [nvm](https://github.com/creationix/nvm))
25+
* npm3 (`npm install -g npm@3`)
2526
* bower (`npm install -g bower`)
2627
* gulp cli (`npm install -g gulp`)
2728

@@ -40,23 +41,23 @@ From project root:
4041

4142
#### JavaScript linting
4243

43-
Wok comes with preconfigured [eslint](http://eslint.org/) linting based on the [airbnb base preset](https://www.npmjs.com/package/eslint-config-airbnb-base).
44+
Wok comes with preconfigured [eslint](http://eslint.org/) linting based on the [airbnb base preset](https://www.npmjs.com/package/eslint-config-airbnb-base).
4445
You can lint your JavaScript files by running: `gulp lint:js`.
45-
46+
4647
If you want to use _in editor_ linting, please follow the setup instructions [your editor](http://eslint.org/docs/user-guide/integrations#editors)
4748

4849
*Note*: eslint preset expects ES6 syntax, anyway Wok doesn't provide any transpiler (ie: Babel) out of the box. The wiki provides recipes to use [webpack 1.x](https://github.com/fevrcoding/wok/wiki/Gulp:-webpack-and-ES6) or [Browserify](https://github.com/fevrcoding/wok/wiki/Gulp:-browserify-and-ES6)
4950

5051
#### SCSS linting
5152

52-
For **SCSS linting** you can choose [stylelint](http://stylelint.io/) or [scss-lint](https://github.com/brigade/scss-lint).
53-
The latter
53+
For **SCSS linting** you can choose [stylelint](http://stylelint.io/) or [scss-lint](https://github.com/brigade/scss-lint).
54+
The latter
5455

55-
Linting via **stylelint** is available as a gulp task: `gulp list:scss`.
56+
Linting via **stylelint** is available as a gulp task: `gulp lint:scss`.
5657
Available editor extensions for in-editor linting are listed [here](http://stylelint.io/user-guide/complementary-tools/)
5758

58-
Linting via **scss-lint** requires [Ruby 2+](http://rubyinstaller.org/downloads/) installed on your system and the global scss-lint gem (`gem install scss_lint`)
59-
It's available as a npm script: `npm run scss-lint`.
59+
Linting via **scss-lint** requires [Ruby 2+](http://rubyinstaller.org/downloads/) installed on your system and the global scss-lint gem (`gem install scss_lint`)
60+
It's available as a npm script: `npm run scss-lint`.
6061
Available editor extensions for in-editor linting are listed [here](https://github.com/brigade/scss-lint#editor-integration) for your editor
6162

6263
## Configuration
@@ -119,22 +120,22 @@ To generate a production ready build add the `--production` parameter:
119120

120121

121122
gulp --production
122-
123+
123124

124125
### Deploy and rollback:
125126

126127
#### SSH and rsync
127128

128-
By default WOK implements a simple set of deploy tasks requiring SSH remote access and [rsync](https://rsync.samba.org).
129+
By default WOK implements a simple set of deploy tasks requiring SSH remote access and [rsync](https://rsync.samba.org).
129130

130131
To deploy and rollback with rsync first setup your remote hosts in `build/gulp-config/hosts.js`, then run:
131-
132+
132133
#deploy to remote staging server. A backup of the deploy target folder (`paths.dist.root`) will be stored in `paths.backup`.
133134
gulp deploy --remotehost=staging
134-
135+
135136
#deploy a production build to remote production server
136137
gulp deploy --production --remotehost=production
137-
138+
138139
#rollback to the previous version in the remote production server
139140
gulp remote --command=rollback --remotehost=production
140141

@@ -154,11 +155,11 @@ When paired with Phing or other deployment systems, remember to set `buildOnly`
154155

155156
* `dev`: one time development build (also runs as default task)
156157
* `lint`: runs both JavaScript and SCSS linters
157-
* `bump`: bumps semver version of `package.json` and `bower.json` files. Accepts a `--type` parameter with value `major|minor|patch|prerelease`. Defaults to `patch`.
158+
* `bump`: bumps semver version of `package.json` and `bower.json` files. Accepts a `--type` parameter with value `major|minor|patch|prerelease`. Defaults to `patch`.
158159

159160
## Project Info
160161

161162
WOK was created by [Marco Solazzi](https://github.com/dwightjack) with contributions from [Matteo Guidotto](https://github.com/mguidotto) and [Umberto Quintarelli](https://github.com/quincia).
162163

163-
Original work Copyright © 2014 Intesys S.r.l., released under the MIT license.
164+
Original work Copyright © 2014 Intesys S.r.l., released under the MIT license.
164165
Modified work Copyright © 2015-2016 Marco Solazzi, released under the MIT license.

bower.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "wok",
3-
"version": "4.0.2",
3+
"version": "4.0.3",
44
"authors": [
55
"Marco Solazzi <[email protected]>",
66
"Matteo Guidotto <[email protected]>",

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "wok",
33
"description": "A Static Website Boilerplate",
4-
"version": "4.0.2",
4+
"version": "4.0.3",
55
"license": "MIT",
66
"repository": {
77
"type": "git",

0 commit comments

Comments
 (0)