From 97d9103684fb08d51df4f4a81c9878c7588facec Mon Sep 17 00:00:00 2001 From: Simon Brunel Date: Thu, 25 Aug 2016 21:13:27 +0200 Subject: [PATCH] #3182 Gulp task to generate bower.json file --- .gitignore | 1 + .travis.yml | 1 + docs/00-Getting-Started.md | 20 ++++---------------- gulpfile.js | 19 ++++++++++++++++++- 4 files changed, 24 insertions(+), 17 deletions(-) diff --git a/.gitignore b/.gitignore index 27254e97e3f..478edb5eca4 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ .DS_Store .idea +bower.json diff --git a/.travis.yml b/.travis.yml index 4643c405e4e..df409f0ec88 100644 --- a/.travis.yml +++ b/.travis.yml @@ -15,6 +15,7 @@ script: - gulp test - gulp coverage - gulp package + - gulp bower - cat ./coverage/lcov.info | ./node_modules/.bin/coveralls notifications: diff --git a/docs/00-Getting-Started.md b/docs/00-Getting-Started.md index d6e9f0f2716..a04925f55ee 100644 --- a/docs/00-Getting-Started.md +++ b/docs/00-Getting-Started.md @@ -5,7 +5,7 @@ anchor: getting-started ### Download Chart.js -You can download the latest version of [Chart.js on GitHub](https://github.com/chartjs/Chart.js/releases/latest) or just use these [Chart.js CDN](https://cdnjs.com/libraries/Chart.js) links. +You can download the latest version of [Chart.js on GitHub](https://github.com/chartjs/Chart.js/releases/latest) or just use these [Chart.js CDN](https://cdnjs.com/libraries/Chart.js) links. If you download or clone the repository, you must run `gulp build` to generate the dist files. Chart.js no longer comes with prebuilt release versions, so an alternative option to downloading the repo is **strongly** advised. ### Installation @@ -18,24 +18,12 @@ npm install chart.js --save #### bower -Bower support has been dropped since version 2.2.0 but you can still use Chart.js with Bower thanks to [bower-npm-resolver](https://www.npmjs.com/package/bower-npm-resolver). - -First, add the resolver in your .bowerrc file: -```json -{ - "resolvers": [ - "bower-npm-resolver" - ] -} -``` - -Then: - ```bash -npm install -g bower-npm-resolver -bower install npm:chart.js --save +bower install Chart.js --save ``` +> Note: Bower native support has been reintroduced at version 2.2.3 (previously dropped at version 2.2.0). + ### Selecting the Correct Build Chart.js provides two different builds that are available for your use. The `Chart.js` and `Chart.min.js` files include Chart.js and the accompanying color parsing library. If this version is used and you require the use of the time axis, [Moment.js](http://momentjs.com/) will need to be included before Chart.js. diff --git a/gulpfile.js b/gulpfile.js index cec632ed476..37048fbb64b 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -48,6 +48,7 @@ var testFiles = [ '!./test/defaultConfig.tests.js', ]; +gulp.task('bower', bowerTask); gulp.task('build', buildTask); gulp.task('package', packageTask); gulp.task('coverage', coverageTask); @@ -65,9 +66,25 @@ gulp.task('library-size', librarySizeTask); gulp.task('module-sizes', moduleSizesTask); gulp.task('_open', _openTask); gulp.task('dev', ['server', 'default']); - gulp.task('default', ['build', 'watch']); +/** + * Generates the bower.json manifest file which will be pushed along release tags. + * Specs: https://github.com/bower/spec/blob/master/json.md + */ +function bowerTask() { + var json = JSON.stringify({ + name: package.name, + description: package.description, + homepage: package.homepage, + license: package.license, + version: package.version, + main: outDir + "Chart.js" + }, null, 2); + + return file('bower.json', json, { src: true }) + .pipe(gulp.dest('./')); +} function buildTask() {