angular-docs-cn/tools/gulp-tasks
Igor Minar fb6a31cbd6 build: exclude ivy commit messages from the release notes (#27532)
there is still too much churn to make this info useful in the release notes, advanced
developers can use git log to find out what's going on with ivy.

PR Close #27532
2018-12-11 11:22:53 -08:00
..
cldr fix(common): register locale data for all equivalent closure locales (#25867) 2018-09-10 13:59:56 -07:00
README.md build: add the `tslint` gulp task (#14481) 2017-02-14 14:16:50 -08:00
changelog.js build: exclude ivy commit messages from the release notes (#27532) 2018-12-11 11:22:53 -08:00
check-cycle.js build: update npm dependencies (#19328) 2017-09-22 13:20:52 -07:00
cldr.js build: update npm dependencies (#19328) 2017-09-22 13:20:52 -07:00
format.js style: update gulp task to format untracked and diff files separately (#24969) 2018-09-27 12:09:08 -07:00
lint.js refactor: ensure all 'TODO's are consistent (#23252) 2018-04-13 13:11:01 -07:00
platform-script-path.js build: update npm dependencies (#19328) 2017-09-22 13:20:52 -07:00
serve.js build: update npm dependencies (#19328) 2017-09-22 13:20:52 -07:00
source-map-test.js build: update npm dependencies (#19328) 2017-09-22 13:20:52 -07:00
tools-build.js build: update npm dependencies (#19328) 2017-09-22 13:20:52 -07:00
validate-commit-message.js ci: validate commit messages correctly when not on master (#19685) 2017-10-17 10:38:29 -07:00

README.md

Gulp Tasks folder

This folder contains one file for each task (or group of related tasks) for the project's gulpfile. The dependencies between the tasks is kept in the gulpfile.

Task File Structure

Each task is defined by a factory function that accepts gulp as a parameter. Each file exports either one factory or an object of factories.

E.g. The build.js file contains only one task:

module.exports = (gulp) => (done) => {
  ...
};

E.g. The format.js file contains two tasks:

module.exports = {
  // Check source code for formatting errors (clang-format)
  enforce: (gulp) => () => {
    ...
  },

  // Format the source code with clang-format (see .clang-format)
  format: (gulp) => () => {
    ...
  }
};

Loading Tasks

The tasks are loaded in the gulp file, by requiring them. There is a helper called loadTask(fileName, taskName) will do this for us, where the taskName is optional if the file only exports one task.

E.g. Loading the task that will run the build, from a task file that contains only one task.

gulp.task('build.sh', loadTask('build'));

E.g. Loading the task that will enforce formatting, from a task file that contains more than one task:

gulp.task('format:enforce', loadTask('format', 'enforce'));

E.g. Loading a task that has dependencies:

gulp.task('lint', ['format:enforce', 'tools:build'], loadTask('lint'));