Coverage data are now generated by running `gulp unittest` with the `--coverage` argument: unit tests are then executed a single time on Travis. The gulp `coverage` task has been removed and `karma.coverage.conf.ci.js` merged into `karma.conf.ci.js`.
Update documentation with gulp commands (and remove them from `README.md`) and remove unused `config.jshintrc` (oversight from #3256). Delete `thankyou.md` which has been merged into `README.md`.
script:
- gulp build
- - gulp test
- - gulp coverage
+ - gulp test --coverage
- gulp package
- gulp bower
- cat ./coverage/lcov.info | ./node_modules/.bin/coveralls
## Contributing
-Before submitting an issue or a pull request to the project, please take a moment to look over the [contributing guidelines](https://github.com/chartjs/Chart.js/blob/master/CONTRIBUTING.md) first.
+Before submitting an issue or a pull request, please take a moment to look over the [contributing guidelines](https://github.com/chartjs/Chart.js/blob/master/CONTRIBUTING.md) first. For support using Chart.js, please post questions with the [`chartjs` tag on Stack Overflow](http://stackoverflow.com/questions/tagged/chartjs).
-For support using Chart.js, please post questions with the [`chartjs` tag on Stack Overflow](http://stackoverflow.com/questions/tagged/chartjs).
+## Building
+Instructions on building and testing Chart.js can be found in [the documentation](https://github.com/chartjs/Chart.js/blob/master/docs/developers/contributing.md#building-and-testing).
-## Building and Testing
-
-To build, run `gulp build`.
-
-To test, run `gulp test`.
-
-To test against code standards, run `gulp lint`.
-
-More information on building and testing can be found in [gulpfile.js](gulpfile.js).
-
-Thanks to [BrowserStack](https://browserstack.com) for allowing our team to test on thousands of browsers.
+## Thanks
+- [BrowserStack](https://browserstack.com) for allowing our team to test on thousands of browsers.
+- [@n8agrin](https://twitter.com/n8agrin) for the Twitter handle donation.
## License
+++ /dev/null
-{
- "node": true,
- "unused": true,
- "predef": [ "require", "module" ]
-}
\ No newline at end of file
- Keep pull requests concise, and document new functionality in the relevant `.md` file.
- Consider whether your changes are useful for all users, or if creating a Chart.js plugin would be more appropriate.
-# Building Chart.js
+# Building and Testing
Chart.js uses <a href="http://gulpjs.com/" target="_blank">gulp</a> to build the library into a single JavaScript file.
Firstly, we need to ensure development dependencies are installed. With node and npm installed, after cloning the Chart.js repo to a local directory, and navigating to that directory in the command line, we can run the following:
```bash
-npm install
-npm install -g gulp
+> npm install
+> npm install -g gulp
```
This will install the local development dependencies for Chart.js, along with a CLI for the JavaScript task runner <a href="http://gulpjs.com/" target="_blank">gulp</a>.
-Now, we can run the `gulp build` task.
+The following commands are now available from the repository root:
```bash
-gulp build
+> gulp build // build Chart.js in ./dist
+> gulp unittest // run tests from ./test/specs
+> gulp unittest --watch // run tests and watch for source changes
+> gulp unittest --coverage // run tests and generate coverage reports in ./coverage
+> gulp lint // perform code linting (ESLint)
+> gulp test // perform code linting and run unit tests
+> gulp docs // build the documentation in ./dist/docs
```
-# Bugs & issues
+More information can be found in [gulpfile.js](https://github.com/chartjs/Chart.js/blob/master/gulpfile.js).
+
+# Bugs and Issues
Please report these on the GitHub page - at <a href="https://github.com/chartjs/Chart.js" target="_blank">github.com/chartjs/Chart.js</a>. If you could include a link to a simple <a href="http://jsbin.com/" target="_blank">jsbin</a> or similar to demonstrate the issue, that'd be really helpful.
gulp.task('bower', bowerTask);
gulp.task('build', buildTask);
gulp.task('package', packageTask);
-gulp.task('coverage', coverageTask);
gulp.task('watch', watchTask);
gulp.task('lint', lintTask);
gulp.task('docs', docsTask);
configFile: path.join(__dirname, 'karma.conf.js'),
singleRun: !argv.watch,
files: startTest(),
- }, done).start();
-}
-
-function coverageTask(done) {
- new karma.Server({
- configFile: path.join(__dirname, 'karma.coverage.conf.js'),
- files: startTest(),
- singleRun: true,
+ args: {
+ coverage: !!argv.coverage
+ }
}, done).start();
}
/* eslint camelcase: 0 */
module.exports = function(karma) {
+ var args = karma.args || {};
var config = {
browsers: ['Firefox'],
frameworks: ['browserify', 'jasmine'],
config.browsers.push('Chrome');
}
+ if (args.coverage) {
+ config.reporters.push('coverage');
+ config.browserify.transform = ['browserify-istanbul'];
+
+ // https://github.com/karma-runner/karma-coverage/blob/master/docs/configuration.md
+ config.coverageReporter = {
+ dir: 'coverage/',
+ reporters: [
+ {type: 'html', subdir: 'report-html'},
+ {type: 'lcovonly', subdir: '.', file: 'lcov.info'}
+ ]
+ };
+ }
+
karma.set(config);
};
+++ /dev/null
-module.exports = function(config) {
- var configuration = {
- browsers: ['Firefox'],
- frameworks: ['browserify', 'jasmine'],
- reporters: ['progress', 'coverage'],
-
- preprocessors: {
- './test/jasmine.index.js': ['browserify'],
- './src/**/*.js': ['browserify']
- },
-
- browserify: {
- debug: true,
- transform: [['browserify-istanbul', {
- instrumenterConfig: {
- embed: true
- }
- }]]
- },
-
- coverageReporter: {
- dir: 'coverage/',
- reporters: [
- { type: 'html', subdir: 'report-html' },
- { type: 'lcovonly', subdir: '.', file: 'lcov.info' }
- ]
- }
- };
-
- // If on the CI, use the CI chrome launcher
- if (process.env.TRAVIS) {
- configuration.browsers.push('Chrome_travis_ci');
- configuration.customLaunchers = {
- Chrome_travis_ci: {
- base: 'Chrome',
- flags: ['--no-sandbox']
- }
- };
- } else {
- configuration.browsers.push('Chrome');
- }
-
- config.set(configuration);
-};
\ No newline at end of file
+++ /dev/null
-## Thanks go out to:
-
-- **@n8agrin** - Twitter handle donation!
projects / thirdparty / Chart.js.git / commitdiff
