angular-docs-cn/tools/gulp-tasks
Miško Hevery 466f5c67d6 docs(zone.js): update release docs instructions (#32128)
PR Close #32128
2019-08-13 16:55:03 -07:00
..
cldr feat(ivy): use i18n locale data to determine the plural form of ICU expressions (#29249) 2019-05-30 15:09:02 -04:00
README.md
changelog-zonejs.js docs(zone.js): update release docs instructions (#32128) 2019-08-13 16:55:03 -07:00
changelog.js ci: add ivy commits to generated CHANGELOG (#32114) 2019-08-12 16:03:37 -07:00
check-cycle.js ci: move e2e tests from travis to circleci (#27937) 2019-01-07 15:35:09 -08:00
cldr.js
format.js build: fix formatting tasks by ignoring the `zone.js/` directory (#31295) 2019-06-26 13:29:29 -07:00
lint.js build: move zone.js to angular repo (#30962) 2019-06-20 11:27:39 -07:00
platform-script-path.js
serve.js build: switch example e2e tests to bazel (#28402) 2019-01-28 19:21:09 -08:00
source-map-test.js
tools-build.js
validate-commit-message.js build: ensure fixup commits match an earlier, unmerged commit (#32023) 2019-08-09 15:12:38 -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'));