Skip to content

Commit

Permalink
chartjs#3182 Gulp task to generate bower.json file
Browse files Browse the repository at this point in the history
  • Loading branch information
simonbrunel committed Aug 28, 2016
1 parent 0ebe388 commit 97d9103
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 17 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@

.DS_Store
.idea
bower.json
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ script:
- gulp test
- gulp coverage
- gulp package
- gulp bower
- cat ./coverage/lcov.info | ./node_modules/.bin/coveralls

notifications:
Expand Down
20 changes: 4 additions & 16 deletions docs/00-Getting-Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
19 changes: 18 additions & 1 deletion gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand All @@ -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() {

Expand Down

0 comments on commit 97d9103

Please sign in to comment.