Skip to content

Commit af95b7d

Browse files
committed
Adopt task.define (better task names)
1 parent bb6a790 commit af95b7d

12 files changed

Lines changed: 75 additions & 111 deletions

build/gulpfile.compile.js

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,8 @@ const compilation = require('./lib/compilation');
1111
const { compileExtensionsBuildTask } = require('./gulpfile.extensions');
1212

1313
// Full compile, including nls and inline sources in sourcemaps, for build
14-
const compileClientBuildTask = task.series(util.rimraf('out-build'), compilation.compileTask('src', 'out-build', true));
15-
compileClientBuildTask.displayName = 'compile-client-build';
14+
const compileClientBuildTask = task.define('compile-client-build', task.series(util.rimraf('out-build'), compilation.compileTask('src', 'out-build', true)));
1615

1716
// All Build
18-
const compileBuildTask = task.parallel(compileClientBuildTask, compileExtensionsBuildTask);
19-
compileBuildTask.displayName = 'compile-build';
20-
17+
const compileBuildTask = task.define('compile-build', task.parallel(compileClientBuildTask, compileExtensionsBuildTask));
2118
exports.compileBuildTask = compileBuildTask;

build/gulpfile.editor.js

Lines changed: 14 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ var BUNDLED_FILE_HEADER = [
6161

6262
const languages = i18n.defaultLanguages.concat([]); // i18n.defaultLanguages.concat(process.env.VSCODE_QUALITY !== 'stable' ? i18n.extraLanguages : []);
6363

64-
const extractEditorSrcTask = function () {
64+
const extractEditorSrcTask = task.define('extract-editor-src', () => {
6565
console.log(`If the build fails, consider tweaking shakeLevel below to a lower value.`);
6666
const apiusages = monacoapi.execute().usageContent;
6767
const extrausages = fs.readFileSync(path.join(root, 'build', 'monaco', 'monaco.usage.recipe')).toString();
@@ -96,13 +96,11 @@ const extractEditorSrcTask = function () {
9696
importIgnorePattern: /(^vs\/css!)|(promise-polyfill\/polyfill)/,
9797
destRoot: path.join(root, 'out-editor-src')
9898
});
99-
};
100-
extractEditorSrcTask.displayName = 'extract-editor-src';
99+
});
101100

102-
const compileEditorAMDTask = compilation.compileTask('out-editor-src', 'out-editor-build', true);
103-
compileEditorAMDTask.displayName = 'compile-editor-amd';
101+
const compileEditorAMDTask = task.define('compile-editor-amd', compilation.compileTask('out-editor-src', 'out-editor-build', true));
104102

105-
const optimizeEditorAMDTask = common.optimizeTask({
103+
const optimizeEditorAMDTask = task.define('optimize-editor-amd', common.optimizeTask({
106104
src: 'out-editor-build',
107105
entryPoints: editorEntryPoints,
108106
resources: editorResources,
@@ -119,13 +117,11 @@ const optimizeEditorAMDTask = common.optimizeTask({
119117
bundleInfo: true,
120118
out: 'out-editor',
121119
languages: languages
122-
});
123-
optimizeEditorAMDTask.displayName = 'optimize-editor-amd';
120+
}));
124121

125-
const minifyEditorAMDTask = common.minifyTask('out-editor');
126-
minifyEditorAMDTask.displayName = 'minify-editor-amd';
122+
const minifyEditorAMDTask = task.define('minify-editor-amd', common.minifyTask('out-editor'));
127123

128-
const createESMSourcesAndResourcesTask = function () {
124+
const createESMSourcesAndResourcesTask = task.define('extract-editor-esm', () => {
129125
standalone.createESMSourcesAndResources2({
130126
srcFolder: './out-editor-src',
131127
outFolder: './out-editor-esm',
@@ -146,10 +142,9 @@ const createESMSourcesAndResourcesTask = function () {
146142
'vs/nls.mock.ts': 'vs/nls.ts'
147143
}
148144
});
149-
};
150-
createESMSourcesAndResourcesTask.displayName = 'extract-editor-esm';
145+
});
151146

152-
const compileEditorESMTask = function () {
147+
const compileEditorESMTask = task.define('compile-editor-esm', () => {
153148
if (process.platform === 'win32') {
154149
const result = cp.spawnSync(`..\\node_modules\\.bin\\tsc.cmd`, {
155150
cwd: path.join(__dirname, '../out-editor-esm')
@@ -163,8 +158,7 @@ const compileEditorESMTask = function () {
163158
console.log(result.stdout.toString());
164159
console.log(result.stderr.toString());
165160
}
166-
};
167-
compileEditorESMTask.displayName = 'compile-editor-esm';
161+
});
168162

169163
function toExternalDTS(contents) {
170164
let lines = contents.split('\n');
@@ -210,7 +204,7 @@ function filterStream(testFunc) {
210204
});
211205
}
212206

213-
const finalEditorResourcesTask = function () {
207+
const finalEditorResourcesTask = task.define('final-editor-resources', () => {
214208
return es.merge(
215209
// other assets
216210
es.merge(
@@ -287,8 +281,7 @@ const finalEditorResourcesTask = function () {
287281
return /\.js\.map$/.test(path);
288282
})).pipe(gulp.dest('out-monaco-editor-core/min-maps'))
289283
);
290-
};
291-
finalEditorResourcesTask.displayName = 'final-editor-resources';
284+
});
292285

293286
gulp.task('editor-distro',
294287
task.series(
@@ -368,12 +361,10 @@ function createTscCompileTask(watch) {
368361
};
369362
}
370363

371-
const monacoTypecheckWatchTask = createTscCompileTask(true);
372-
monacoTypecheckWatchTask.displayName = 'monaco-typecheck-watch';
364+
const monacoTypecheckWatchTask = task.define('monaco-typecheck-watch', createTscCompileTask(true));
373365
exports.monacoTypecheckWatchTask = monacoTypecheckWatchTask;
374366

375-
const monacoTypecheckTask = createTscCompileTask(false);
376-
monacoTypecheckTask.displayName = 'monaco-typecheck';
367+
const monacoTypecheckTask = task.define('monaco-typecheck', createTscCompileTask(false));
377368
exports.monacoTypecheckTask = monacoTypecheckTask;
378369

379370
//#endregion

build/gulpfile.vscode.js

Lines changed: 25 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ const BUNDLED_FILE_HEADER = [
8888
' *--------------------------------------------------------*/'
8989
].join('\n');
9090

91-
const optimizeVSCodeTask = task.series(
91+
const optimizeVSCodeTask = task.define('optimize-vscode', task.series(
9292
task.parallel(
9393
util.rimraf('out-vscode'),
9494
compileBuildTask
@@ -102,30 +102,27 @@ const optimizeVSCodeTask = task.series(
102102
out: 'out-vscode',
103103
bundleInfo: undefined
104104
})
105-
);
106-
optimizeVSCodeTask.displayName = 'optimize-vscode';
105+
));
107106

108107

109-
const optimizeIndexJSTask = task.series(
108+
const optimizeIndexJSTask = task.define('optimize-index-js', task.series(
110109
optimizeVSCodeTask,
111110
() => {
112111
const fullpath = path.join(process.cwd(), 'out-vscode/bootstrap-window.js');
113112
const contents = fs.readFileSync(fullpath).toString();
114113
const newContents = contents.replace('[/*BUILD->INSERT_NODE_MODULES*/]', JSON.stringify(nodeModules));
115114
fs.writeFileSync(fullpath, newContents);
116115
}
117-
);
118-
optimizeIndexJSTask.displayName = 'optimize-index-js';
116+
));
119117

120118
const sourceMappingURLBase = `https://ticino.blob.core.windows.net/sourcemaps/${commit}`;
121-
const minifyVSCodeTask = task.series(
119+
const minifyVSCodeTask = task.define('minify-vscode', task.series(
122120
task.parallel(
123121
util.rimraf('out-vscode-min'),
124122
optimizeIndexJSTask
125123
),
126124
common.minifyTask('out-vscode', `${sourceMappingURLBase}/core`)
127-
);
128-
minifyVSCodeTask.displayName = 'minify-vscode';
125+
));
129126

130127
// Package
131128

@@ -214,11 +211,11 @@ function getElectron(arch) {
214211
};
215212
}
216213

217-
gulp.task('electron', task.series(util.rimraf('.build/electron'), getElectron(process.arch)));
218-
gulp.task('electron-ia32', task.series(util.rimraf('.build/electron'), getElectron('ia32')));
219-
gulp.task('electron-x64', task.series(util.rimraf('.build/electron'), getElectron('x64')));
220-
gulp.task('electron-arm', task.series(util.rimraf('.build/electron'), getElectron('arm')));
221-
gulp.task('electron-arm64', task.series(util.rimraf('.build/electron'), getElectron('arm64')));
214+
gulp.task(task.define('electron', task.series(util.rimraf('.build/electron'), getElectron(process.arch))));
215+
gulp.task(task.define('electron-ia32', task.series(util.rimraf('.build/electron'), getElectron('ia32'))));
216+
gulp.task(task.define('electron-x64', task.series(util.rimraf('.build/electron'), getElectron('x64'))));
217+
gulp.task(task.define('electron-arm', task.series(util.rimraf('.build/electron'), getElectron('arm'))));
218+
gulp.task(task.define('electron-arm64', task.series(util.rimraf('.build/electron'), getElectron('arm64'))));
222219

223220

224221
/**
@@ -458,15 +455,14 @@ BUILD_TARGETS.forEach(buildTarget => {
458455
const sourceFolderName = `out-vscode${dashed(minified)}`;
459456
const destinationFolderName = `VSCode${dashed(platform)}${dashed(arch)}`;
460457

461-
const vscodeTask = task.series(
458+
const vscodeTask = task.define(`vscode${dashed(platform)}${dashed(arch)}${dashed(minified)}`, task.series(
462459
task.parallel(
463460
minified ? minifyVSCodeTask : optimizeVSCodeTask,
464461
util.rimraf(path.join(buildRoot, destinationFolderName))
465462
),
466463
packageTask(platform, arch, sourceFolderName, destinationFolderName, opts)
467-
);
468-
vscodeTask.displayName = `vscode${dashed(platform)}${dashed(arch)}${dashed(minified)}`;
469-
gulp.task(vscodeTask.displayName, vscodeTask);
464+
));
465+
gulp.task(vscodeTask);
470466
});
471467
});
472468

@@ -491,7 +487,8 @@ const apiHostname = process.env.TRANSIFEX_API_URL;
491487
const apiName = process.env.TRANSIFEX_API_NAME;
492488
const apiToken = process.env.TRANSIFEX_API_TOKEN;
493489

494-
gulp.task('vscode-translations-push',
490+
gulp.task(task.define(
491+
'vscode-translations-push',
495492
task.series(
496493
optimizeVSCodeTask,
497494
function () {
@@ -507,9 +504,10 @@ gulp.task('vscode-translations-push',
507504
).pipe(i18n.pushXlfFiles(apiHostname, apiName, apiToken));
508505
}
509506
)
510-
);
507+
));
511508

512-
gulp.task('vscode-translations-export',
509+
gulp.task(task.define(
510+
'vscode-translations-export',
513511
task.series(
514512
optimizeVSCodeTask,
515513
function () {
@@ -524,7 +522,7 @@ gulp.task('vscode-translations-export',
524522
).pipe(vfs.dest('../vscode-translations-export'));
525523
}
526524
)
527-
);
525+
));
528526

529527
gulp.task('vscode-translations-pull', function () {
530528
return es.merge([...i18n.defaultLanguages, ...i18n.extraLanguages].map(language => {
@@ -575,7 +573,7 @@ gulp.task('upload-vscode-sourcemaps', () => {
575573
});
576574

577575
// This task is only run for the MacOS build
578-
const generateVSCodeConfigurationTask = () => {
576+
const generateVSCodeConfigurationTask = task.define('generate-vscode-configuration', () => {
579577
return new Promise((resolve, reject) => {
580578
const buildDir = process.env['AGENT_BUILDDIRECTORY'];
581579
if (!buildDir) {
@@ -610,11 +608,11 @@ const generateVSCodeConfigurationTask = () => {
610608
reject(err);
611609
});
612610
});
613-
};
614-
generateVSCodeConfigurationTask.displayName = 'generate-vscode-configuration';
611+
});
615612

616613
const allConfigDetailsPath = path.join(os.tmpdir(), 'configuration.json');
617-
gulp.task('upload-vscode-configuration',
614+
gulp.task(task.define(
615+
'upload-vscode-configuration',
618616
task.series(
619617
generateVSCodeConfigurationTask,
620618
() => {
@@ -642,7 +640,7 @@ gulp.task('upload-vscode-configuration',
642640
}));
643641
}
644642
)
645-
);
643+
));
646644

647645
function shouldSetupSettingsSearch() {
648646
const branch = process.env.BUILD_SOURCEBRANCH;

build/gulpfile.vscode.linux.js

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -242,30 +242,24 @@ BUILD_TARGETS.forEach((buildTarget) => {
242242

243243
{
244244
const debArch = getDebPackageArch(arch);
245-
const prepareDebTask = task.series(util.rimraf(`.build/linux/deb/${debArch}`), prepareDebPackage(arch));
246-
prepareDebTask.displayName = `vscode-linux-${arch}-prepare-deb`;
247-
// gulp.task(prepareDebTask.displayName, prepareDebTask);
248-
const buildDebTask = task.series(prepareDebTask, buildDebPackage(arch));
249-
buildDebTask.displayName = `vscode-linux-${arch}-build-deb`;
250-
gulp.task(buildDebTask.displayName, buildDebTask);
245+
const prepareDebTask = task.define(`vscode-linux-${arch}-prepare-deb`, task.series(util.rimraf(`.build/linux/deb/${debArch}`), prepareDebPackage(arch)));
246+
// gulp.task(prepareDebTask);
247+
const buildDebTask = task.define(`vscode-linux-${arch}-build-deb`, task.series(prepareDebTask, buildDebPackage(arch)));
248+
gulp.task(buildDebTask);
251249
}
252250

253251
{
254252
const rpmArch = getRpmPackageArch(arch);
255-
const prepareRpmTask = task.series(util.rimraf(`.build/linux/rpm/${rpmArch}`), prepareRpmPackage(arch));
256-
prepareRpmTask.displayName = `vscode-linux-${arch}-prepare-rpm`;
257-
// gulp.task(prepareRpmTask.displayName, prepareRpmTask);
258-
const buildRpmTask = task.series(prepareRpmTask, buildRpmPackage(arch));
259-
buildRpmTask.displayName = `vscode-linux-${arch}-build-rpm`;
260-
gulp.task(buildRpmTask.displayName, buildRpmTask);
253+
const prepareRpmTask = task.define(`vscode-linux-${arch}-prepare-rpm`, task.series(util.rimraf(`.build/linux/rpm/${rpmArch}`), prepareRpmPackage(arch)));
254+
// gulp.task(prepareRpmTask);
255+
const buildRpmTask = task.define(`vscode-linux-${arch}-build-rpm`, task.series(prepareRpmTask, buildRpmPackage(arch)));
256+
gulp.task(buildRpmTask);
261257
}
262258

263259
{
264-
const prepareSnapTask = task.series(util.rimraf(`.build/linux/snap/${arch}`), prepareSnapPackage(arch));
265-
prepareSnapTask.displayName = `vscode-linux-${arch}-prepare-snap`;
266-
gulp.task(prepareSnapTask.displayName, prepareSnapTask);
267-
const buildSnapTask = task.series(prepareSnapTask, buildSnapPackage(arch));
268-
buildSnapTask.displayName = `vscode-linux-${arch}-build-snap`;
269-
gulp.task(buildSnapTask.displayName, buildSnapTask);
260+
const prepareSnapTask = task.define(`vscode-linux-${arch}-prepare-snap`, task.series(util.rimraf(`.build/linux/snap/${arch}`), prepareSnapPackage(arch)));
261+
gulp.task(prepareSnapTask);
262+
const buildSnapTask = task.define(`vscode-linux-${arch}-build-snap`, task.series(prepareSnapTask, buildSnapPackage(arch)));
263+
gulp.task(buildSnapTask);
270264
}
271265
});

build/gulpfile.vscode.win32.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ function buildWin32Setup(arch, target) {
107107

108108
function defineWin32SetupTasks(arch, target) {
109109
const cleanTask = util.rimraf(setupDir(arch, target));
110-
gulp.task(`vscode-win32-${arch}-${target}-setup`, task.series(cleanTask, buildWin32Setup(arch, target)));
110+
gulp.task(task.define(`vscode-win32-${arch}-${target}-setup`, task.series(cleanTask, buildWin32Setup(arch, target))));
111111
}
112112

113113
defineWin32SetupTasks('ia32', 'system');
@@ -125,8 +125,8 @@ function archiveWin32Setup(arch) {
125125
};
126126
}
127127

128-
gulp.task('vscode-win32-ia32-archive', task.series(util.rimraf(zipDir('ia32')), archiveWin32Setup('ia32')));
129-
gulp.task('vscode-win32-x64-archive', task.series(util.rimraf(zipDir('x64')), archiveWin32Setup('x64')));
128+
gulp.task(task.define('vscode-win32-ia32-archive', task.series(util.rimraf(zipDir('ia32')), archiveWin32Setup('ia32'))));
129+
gulp.task(task.define('vscode-win32-x64-archive', task.series(util.rimraf(zipDir('x64')), archiveWin32Setup('x64'))));
130130

131131
function copyInnoUpdater(arch) {
132132
return () => {
@@ -142,5 +142,5 @@ function patchInnoUpdater(arch) {
142142
};
143143
}
144144

145-
gulp.task('vscode-win32-ia32-inno-updater', task.series(copyInnoUpdater('ia32'), patchInnoUpdater('ia32')));
146-
gulp.task('vscode-win32-x64-inno-updater', task.series(copyInnoUpdater('x64'), patchInnoUpdater('x64')));
145+
gulp.task(task.define('vscode-win32-ia32-inno-updater', task.series(copyInnoUpdater('ia32'), patchInnoUpdater('ia32'))));
146+
gulp.task(task.define('vscode-win32-x64-inno-updater', task.series(copyInnoUpdater('x64'), patchInnoUpdater('x64'))));

build/lib/compilation.js

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ const typesDts = [
7878
'!node_modules/@types/uglify-js/**/*',
7979
];
8080
function compileTask(src, out, build) {
81-
const result = function () {
81+
return function () {
8282
const compile = createCompile(src, build, true);
8383
const srcPipe = es.merge(gulp.src(`${src}/**`, { base: `${src}` }), gulp.src(typesDts));
8484
let generator = new MonacoGenerator(false);
@@ -90,12 +90,10 @@ function compileTask(src, out, build) {
9090
.pipe(compile())
9191
.pipe(gulp.dest(out));
9292
};
93-
result.displayName = `compile-task-${out}${build ? '-build' : ''}`;
94-
return result;
9593
}
9694
exports.compileTask = compileTask;
9795
function watchTask(out, build) {
98-
const result = function () {
96+
return function () {
9997
const compile = createCompile('src', build);
10098
const src = es.merge(gulp.src('src/**', { base: 'src' }), gulp.src(typesDts));
10199
const watchSrc = watch('src/**', { base: 'src' });
@@ -106,8 +104,6 @@ function watchTask(out, build) {
106104
.pipe(util.incremental(compile, src, true))
107105
.pipe(gulp.dest(out));
108106
};
109-
result.displayName = `watch-task-${out}${build ? '-build' : ''}`;
110-
return result;
111107
}
112108
exports.watchTask = watchTask;
113109
const REPO_SRC_FOLDER = path.join(__dirname, '../../src');

build/lib/compilation.ts

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ const typesDts = [
9090

9191
export function compileTask(src: string, out: string, build: boolean): () => NodeJS.ReadWriteStream {
9292

93-
const result = function () {
93+
return function () {
9494
const compile = createCompile(src, build, true);
9595

9696
const srcPipe = es.merge(
@@ -108,13 +108,11 @@ export function compileTask(src: string, out: string, build: boolean): () => Nod
108108
.pipe(compile())
109109
.pipe(gulp.dest(out));
110110
};
111-
result.displayName = `compile-task-${out}${build ? '-build' : ''}`;
112-
return result;
113111
}
114112

115113
export function watchTask(out: string, build: boolean): () => NodeJS.ReadWriteStream {
116114

117-
const result = function () {
115+
return function () {
118116
const compile = createCompile('src', build);
119117

120118
const src = es.merge(
@@ -131,8 +129,6 @@ export function watchTask(out: string, build: boolean): () => NodeJS.ReadWriteSt
131129
.pipe(util.incremental(compile, src, true))
132130
.pipe(gulp.dest(out));
133131
};
134-
result.displayName = `watch-task-${out}${build ? '-build' : ''}`;
135-
return result;
136132
}
137133

138134
const REPO_SRC_FOLDER = path.join(__dirname, '../../src');

0 commit comments

Comments
 (0)