From e35f9f382f1933e7af969edd5aa54c0d57104c2f Mon Sep 17 00:00:00 2001 From: Alexander Wunschik Date: Tue, 8 Jan 2019 19:48:26 +0100 Subject: [PATCH] updated the docs so that only gulp-cli is installed globally --- docs/developers/contributing.md | 27 ++++++++++++++------------- package.json | 5 ----- 2 files changed, 14 insertions(+), 18 deletions(-) diff --git a/docs/developers/contributing.md b/docs/developers/contributing.md index 29056441748..9b97f024c73 100644 --- a/docs/developers/contributing.md +++ b/docs/developers/contributing.md @@ -4,8 +4,8 @@ New contributions to the library are welcome, but we ask that you please follow - Use tabs for indentation, not spaces. - Only change the individual files in `/src`. -- Check that your code will pass `eslint` code standards, `npm run gulp lint` will run this for you. -- Check that your code will pass tests, `npm run gulp test` will run tests for you. +- Check that your code will pass `eslint` code standards, `gulp lint` will run this for you. +- Check that your code will pass tests, `gulp test` will run tests for you. - 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](plugins.md) would be more appropriate. - Avoid breaking changes unless there is an upcoming major release, which are infrequent. We encourage people to write plugins for most new advanced features, so care a lot about backwards compatibility. @@ -22,22 +22,23 @@ Firstly, we need to ensure development dependencies are installed. With node and ```bash > npm install +> npm install -g gulp-cli ``` -This will install the local development dependencies for Chart.js including a CLI for the JavaScript task runner gulp. +This will install the local development dependencies for Chart.js, along with a CLI for the JavaScript task runner gulp. The following commands are now available from the repository root: ```bash -> npm run gulp build // build dist files in ./dist -> npm run gulp build --watch // build and watch for changes -> npm run gulp unittest // run tests from ./test/specs -> npm run gulp unittest --watch // run tests and watch for source changes -> npm run gulp unittest --coverage // run tests and generate coverage reports in ./coverage -> npm run gulp lint // perform code linting (ESLint) -> npm run gulp test // perform code linting and run unit tests -> npm run gulp docs // build the documentation in ./dist/docs -> npm run gulp docs --watch // starts the gitbook live reloaded server +> gulp build // build dist files in ./dist +> gulp build --watch // build and watch for changes +> 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 +> gulp docs --watch // starts the gitbook live reloaded server ``` More information can be found in [gulpfile.js](https://github.com/chartjs/Chart.js/blob/master/gulpfile.js). @@ -54,4 +55,4 @@ Guidelines for reporting bugs: - Isolate the problem to a simple test case - Please include a demonstration of the bug on a website such as [JS Bin](https://jsbin.com/), [JS Fiddle](https://jsfiddle.net/), or [Codepen](https://codepen.io/pen/). ([Template](https://codepen.io/pen?template=JXVYzq)) -Please provide any additional details associated with the bug, if it's browser or screen density specific, or only happens with a certain configuration or data. +Please provide any additional details associated with the bug, if it's browser or screen density specific, or only happens with a certain configuration or data. \ No newline at end of file diff --git a/package.json b/package.json index 7220bc93d07..bf913bf0aee 100644 --- a/package.json +++ b/package.json @@ -22,11 +22,6 @@ "bugs": { "url": "https://github.com/chartjs/Chart.js/issues" }, - "scripts": { - "gulp": "gulp", - "start": "npm run gulp build --watch", - "test": "npm run gulp test" - }, "devDependencies": { "coveralls": "^3.0.0", "eslint": "^5.9.0",