5615928df9
Switches our tslint setup to the standard `tslint.json` linter excludes. The set of files that need to be linted is specified through a Yarn script. For IDEs, open files are linted with the closest tslint configuration, if the tslint IDE extension is set up, and the source file is not excluded. We cannot use the language service plugin for tslint as we have multiple nested tsconfig files, and we don't want to add the plugin to each tsconfig. We could reduce that bloat by just extending from a top-level tsconfig that defines the language service plugin, but unfortunately the tslint plugin does not allow the use of tslint configs which are not part of the tsconfig project. This is problematic since the tslint configuration is at the project root, and we don't want to copy tslint configurations next to each tsconfig file. Additionally, linting of `d.ts` files has been re-enabled. This has been disabled in the past and a TODO has been left. This commit fixes the lint issues and re-enables linting. PR Close #35800
57 lines
1.4 KiB
Markdown
57 lines
1.4 KiB
Markdown
# 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:
|
|
|
|
```js
|
|
module.exports = (gulp) => (done) => {
|
|
...
|
|
};
|
|
```
|
|
|
|
E.g. The `format.js` file contains two tasks:
|
|
|
|
```js
|
|
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.
|
|
|
|
```js
|
|
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:
|
|
|
|
```js
|
|
gulp.task('format:enforce', loadTask('format', 'enforce'));
|
|
```
|
|
|
|
E.g. Loading a task that has dependencies:
|
|
|
|
```js
|
|
gulp.task('lint', ['format:enforce'], loadTask('lint'));
|
|
```
|