From ed267d03bd50b613b7cba2ad831590affc7e0cb6 Mon Sep 17 00:00:00 2001 From: Daniel Hensby Date: Mon, 14 Mar 2016 16:16:38 +0000 Subject: [PATCH] Updating required node version --- docs/en/05_Contributing/01_Code.md | 16 +++++++++++----- package.json | 3 ++- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/docs/en/05_Contributing/01_Code.md b/docs/en/05_Contributing/01_Code.md index 197d9c166..322ed9c3a 100644 --- a/docs/en/05_Contributing/01_Code.md +++ b/docs/en/05_Contributing/01_Code.md @@ -277,35 +277,41 @@ The [Node.js](https://nodejs.org) JavaScript runtime is the foundation of our cl The configuration for an npm package goes in `package.json`. You'll see one in the root directory of `framework`. As well as being used for defining dependencies and basic package information, the `package.json` file has some handy scripts. +``` +$ npm run bundle +``` + +`bundle` generates the lib and leftandmain JavaScript bundles. + ``` $ npm run thirdparty ``` -This script copies JavaScript files from the `node_modules` directory into the `thirdparty` directory. The `node_modules` directory is not part of source control, so you'll need to run this command if you have upgraded, or added a module. +`thirdparty` copies JavaScript files from the `node_modules` directory into the `thirdparty` directory. The `node_modules` directory is not part of source control, so you'll need to run this command if you have upgraded, or added a module. ``` $ npm run sanity ``` -This script makes sure files in `thirdparty` match files copied from `node_modules`. You should never commit custom changes to a library file. This script will catch them if you do :smile: +`sanity` makes sure files in `thirdparty` match files copied from `node_modules`. You should never commit custom changes to a library file. This script will catch them if you do :smile: ``` $ npm run css ``` -This script will compile all of the .scss files into minified .css files. ProTip: run with the `--development` flag to compile non-minified css and watch for every time a .scss file is changed. +`css` will compile all of the .scss files into minified .css files. ProTip: run with the `--development` flag to compile non-minified css and watch for every time a .scss file is changed. ``` $ npm run sprites ``` -This script generates sprites from the individual image files in `admin/images/sprites/src`. +`sprites` generates sprites from the individual image files in `admin/images/sprites/src`. ``` $ npm run lock ``` -Generates a "shrinkwrap" file containing all npm package versions and writes it to `npm-shrinkwrap.json`. +`lock` generates a "shrinkwrap" file containing all npm package versions and writes it to `npm-shrinkwrap.json`. Run this command whenever a new package is added to `package.json`, or when updating packages. Commit the resulting `npm-shrinkwrap.json`. This uses a third party [npm-shrinkwrap](https://github.com/uber/npm-shrinkwrap) library diff --git a/package.json b/package.json index ed14d1aa7..03783b382 100644 --- a/package.json +++ b/package.json @@ -7,10 +7,11 @@ "test": "tests" }, "engines": { - "node": "~4.2.0" + "node": "^4.2.0" }, "scripts": { "build": "gulp build", + "bundle": "gulp bundle", "sanity": "gulp sanity", "thirdparty": "gulp thirdparty", "css": "gulp css",