600402d440
All the docs related files (docs-app, doc-gen, content, etc) are now to be found inside the `/aio` folder. The related gulp tasks have been moved from the top level gulp file to a new one inside the `/aio` folder. The structure of the `/aio` folder now looks like: ``` /aio/ build/ # gulp tasks content/ #MARKDOWN FILES for devguides, cheatsheet, etc devguides/ cheatsheets/ transforms/ #dgeni packages, templates, etc src/ app/ assets/ content/ #HTML + JSON build artifacts produced by dgeni from /aio/content. #This dir is .gitignored-ed e2e/ #protractor tests for the doc viewer app node_modules/ #dependencies for both the doc viewer builds and the dgeni stuff #This dir is .gitignored-ed gulpfile.js #Tasks for generating docs and building & deploying the doc viewer ``` Closes #14361 |
||
---|---|---|
.. | ||
README.md | ||
build.js | ||
changelog.js | ||
check-cycle.js | ||
format.js | ||
lint.js | ||
platform-script-path.js | ||
public-api.js | ||
serve.js | ||
tools-build.js | ||
validate-commit-message.js |
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 contans 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'));