ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated Moving to NPM and Grunt (markdown)

Paul Spencer
2013-07-18 07:55:08 -07:00
parent d22e666c76
commit cc717c33b5
1 changed files with 19 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Moving-to-NPM-and-Grunt.md
+19 -4
@@ -29,6 +29,8 @@ Both `npm install` and `npm install ol3` will process the `package.json` depende
### Current Situation ### Current Situation
**WIP** - this is an attempt to map what build.py currently does for various targets
* build - build `ol.css`, `ol.js`, `ol-simple.js` and `ol-whitespace.js` * build - build `ol.css`, `ol.js`, `ol-simple.js` and `ol-whitespace.js`
* check - runs `lint`, builds `ol.css`, `ol-all.js`, runs `test` * check - runs `lint`, builds `ol.css`, `ol-all.js`, runs `test`
@@ -65,13 +67,15 @@ Both `npm install` and `npm install ol3` will process the `package.json` depende
* host-examples - runs `build`, `host-resources`, `examples` * host-examples - runs `build`, `host-resources`, `examples`
## NPM scripts required ## NPM scripts
* postinstall - grunt install * postinstall - grunt install
* test - what Tim did! * test - what Tim did!
* build - build ol.js, ol-simple.js, ol-whitespace.js (touch ol.css) * build - grunt build
* doc - grunt doc
* lint - grunt lint * lint - grunt lint
@@ -83,12 +87,23 @@ Both `npm install` and `npm install ol3` will process the `package.json` depende
### Grunt Tasks ### Grunt Tasks
what grunt tasks are required (based on npm script targets) and how we can potentially satisfy them
* install - (custom code here) install / update dependencies * install - (custom code here) install / update dependencies
* todo ([https://npmjs.org/package/grunt-todos](https://npmjs.org/package/grunt-todos)) * [http://dl.google.com/closure-compiler/compiler-latest.zip](http://dl.google.com/closure-compiler/compiler-latest.zip)
* [http://closure-library.googlecode.com/files/closure-library-20130212-95c19e7f0f5f.zip](http://closure-library.googlecode.com/files/closure-library-20130212-95c19e7f0f5f.zip) - **or** `git clone https://code.google.com/p/closure-library/ build/closure-library`
* lint - ([https://npmjs.org/package/grunt-gjslint](https://npmjs.org/package/grunt-gjslint) which uses [https://github.com/jmendiara/node-closure-linter-wrapper](https://github.com/jmendiara/node-closure-linter-wrapper)) * todo - [https://npmjs.org/package/grunt-todos](https://npmjs.org/package/grunt-todos)
* lint - [https://npmjs.org/package/grunt-gjslint](https://npmjs.org/package/grunt-gjslint) which uses [https://github.com/jmendiara/node-closure-linter-wrapper](https://github.com/jmendiara/node-closure-linter-wrapper)
* build - [https://npmjs.org/package/grunt-closure-compiler](https://npmjs.org/package/grunt-closure-compiler)
* build ol.js, ol-simple.js, ol-whitespace.js (touch ol.css)
* doc - [https://npmjs.org/package/grunt-jsdoc](https://npmjs.org/package/grunt-jsdoc)
## Notes and Information ## Notes and Information
### Related issues and PRs ### Related issues and PRs