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

Updated Moving to NPM and Grunt (markdown)

Paul Spencer
2013-08-04 17:30:01 -07:00
parent be11716198
commit dd68c03f23
1 changed files with 20 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
Moving-to-NPM-and-Grunt.md

@@ -127,13 +127,10 @@ Both `npm install` and `npm install ol3` will process the `package.json` depende
what grunt tasks are required (based on npm script targets) and how we can potentially satisfy them
* install - probably custom code here
* install / update dependencies
* install - install / update dependencies
* status: not started
* [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`
* it would be nice to pick up environment variables that would use existing versions that a developer might install elsewhere and avoid downloading/installing dependencies
* how do we make sure the dependencies are updated? Is there an automatic way to do this or is it the responsibility of the developer to periodically do something (clean perhaps?) to trigger an update
* perhaps install always updates the dependencies to the current version (if not overridden by env variables) and the check task only installs if missing?
@@ -142,29 +139,35 @@ what grunt tasks are required (based on npm script targets) and how we can poten
* (@twpayne) glsl-unit latest npm package does not work, use https://code.google.com/p/glsl-unit/ instead
* check - custom code
* check - checks for dependencies, runs lint and test
* status: not started
* check for the existence of a dependency
* other tasks use this to ensure dependencies are available
* should differentiate between dependencies we can install and ones we can't
* may possibly install missing dependencies
* might collapse with install task
* todo - [https://npmjs.org/package/grunt-todos](https://npmjs.org/package/grunt-todos)
* todo - outputs a list of TODO and FIXME comments in the source code
* status: not started
* uses [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)
* may want to investigate how this works, the wrapper claims to embed a specific version with local modifications. In my mind, we should avoid embedded versions if possible.
* lint - runs gjslint on the source code
* status: complete
* uses [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)
* build - builds ol.js, ol-simple.js, ol-whitespace.js (touch ol.css)
* status: not started
* uses [https://npmjs.org/package/grunt-closure-compiler](https://npmjs.org/package/grunt-closure-compiler)
* doc - [https://npmjs.org/package/grunt-jsdoc](https://npmjs.org/package/grunt-jsdoc)
* build documentation
* doc - build documentation
* status: complete
* uses [https://npmjs.org/package/grunt-jsdoc](https://npmjs.org/package/grunt-jsdoc)
* reallyclean - [https://npmjs.org/package/grunt-exec](https://npmjs.org/package/grunt-exec)
* this runs a git command to remove all untracked items from the working folder
* reallyclean - this runs a git command to remove all untracked items from the working folder
* status: complete
* serve - custom code
* starts a local web server that serves the examples, related static files and the js files in various modes to support debugging the examples
* serve - starts a local web server that serves the examples, related static files and the js files in various modes to support debugging the examples
* status: not started
## Notes and Related Information