Merge pull request #276826 from microsoft/dev/mjbvz/gulp-mjs

Convert gulpfiles to modules

Author: mjbvz

build/gulpfile.cli.js renamed to build/gulpfile.cli.mjs

@@ -3,21 +3,25 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-'use strict';
-
-const es = require('event-stream');
-const gulp = require('gulp');
-const path = require('path');
-const fancyLog = require('fancy-log');
-const ansiColors = require('ansi-colors');
-const cp = require('child_process');
-const { tmpdir } = require('os');
-const { existsSync, mkdirSync, rmSync } = require('fs');
-
-const task = require('./lib/task');
-const watcher = require('./lib/watch');
-const { debounce } = require('./lib/util');
-const createReporter = require('./lib/reporter').createReporter;
+import es from 'event-stream';
+import gulp from 'gulp';
+import * as path from 'path';
+import fancyLog from 'fancy-log';
+import ansiColors from 'ansi-colors';
+import * as cp from 'child_process';
+import { tmpdir } from 'os';
+import { existsSync, mkdirSync, rmSync } from 'fs';
+import task from './lib/task.js';
+import watcher from './lib/watch/index.js';
+import utilModule from './lib/util.js';
+import reporterModule from './lib/reporter.js';
+import untar from 'gulp-untar';
+import gunzip from 'gulp-gunzip';
+import { fileURLToPath } from 'url';
+
+const { debounce } = utilModule;
+const { createReporter } = reporterModule;
+const __dirname = import.meta.dirname
 
 const root = 'cli';
 const rootAbs = path.resolve(__dirname, '..', root);
@@ -80,8 +84,6 @@ const compileFromSources = (callback) => {
 };
 
 const acquireBuiltOpenSSL = (callback) => {
-	const untar = require('gulp-untar');
-	const gunzip = require('gulp-gunzip');
 	const dir = path.join(tmpdir(), 'vscode-openssl-download');
 	mkdirSync(dir, { recursive: true });
 

build/gulpfile.compile.js renamed to build/gulpfile.compile.mjs

@@ -2,15 +2,12 @@
  *  Copyright (c) Microsoft Corporation. All rights reserved.
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
-
 //@ts-check
-'use strict';
-
-const gulp = require('gulp');
-const util = require('./lib/util');
-const date = require('./lib/date');
-const task = require('./lib/task');
-const compilation = require('./lib/compilation');
+import gulp from 'gulp';
+import util from './lib/util.js';
+import date from './lib/date.js';
+import task from './lib/task.js';
+import compilation from './lib/compilation.js';
 
 /**
  * @param {boolean} disableMangle
@@ -25,11 +22,9 @@ function makeCompileBuildTask(disableMangle) {
 }
 
 // Local/PR compile, including nls and inline sources in sourcemaps, minification, no mangling
-const compileBuildWithoutManglingTask = task.define('compile-build-without-mangling', makeCompileBuildTask(true));
+export const compileBuildWithoutManglingTask = task.define('compile-build-without-mangling', makeCompileBuildTask(true));
 gulp.task(compileBuildWithoutManglingTask);
-exports.compileBuildWithoutManglingTask = compileBuildWithoutManglingTask;
 
 // CI compile, including nls and inline sources in sourcemaps, mangling, minification, for build
-const compileBuildWithManglingTask = task.define('compile-build-with-mangling', makeCompileBuildTask(false));
+export const compileBuildWithManglingTask = task.define('compile-build-with-mangling', makeCompileBuildTask(false));
 gulp.task(compileBuildWithManglingTask);
-exports.compileBuildWithManglingTask = compileBuildWithManglingTask;

build/gulpfile.editor.js renamed to build/gulpfile.editor.mjs

@@ -2,27 +2,30 @@
  *  Copyright (c) Microsoft Corporation. All rights reserved.
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
-
 //@ts-check
-
-const gulp = require('gulp');
-const path = require('path');
-const util = require('./lib/util');
-const { getVersion } = require('./lib/getVersion');
-const task = require('./lib/task');
-const es = require('event-stream');
-const File = require('vinyl');
-const i18n = require('./lib/i18n');
-const standalone = require('./lib/standalone');
-const cp = require('child_process');
-const compilation = require('./lib/compilation');
-const monacoapi = require('./lib/monaco-api');
-const fs = require('fs');
-const filter = require('gulp-filter');
-
+import gulp from 'gulp';
+import * as path from 'path';
+import util from './lib/util.js';
+import getVersionModule from './lib/getVersion.js';
+import task from './lib/task.js';
+import es from 'event-stream';
+import File from 'vinyl';
+import i18n from './lib/i18n.js';
+import standalone from './lib/standalone.js';
+import * as cp from 'child_process';
+import compilation from './lib/compilation.js';
+import monacoapi from './lib/monaco-api.js';
+import * as fs from 'fs';
+import filter from 'gulp-filter';
+import reporterModule from './lib/reporter.js';
+import monacoPackage from './monaco/package.json' with { type: 'json' };
+
+const __dirname = import.meta.dirname
+const { getVersion } = getVersionModule;
+const { createReporter } = reporterModule;
 const root = path.dirname(__dirname);
 const sha1 = getVersion(root);
-const semver = require('./monaco/package.json').version;
+const semver = monacoPackage.version;
 const headerVersion = semver + '(' + sha1 + ')';
 
 const BUNDLED_FILE_HEADER = [
@@ -233,8 +236,6 @@ gulp.task('monacodts', task.define('monacodts', () => {
  */
 function createTscCompileTask(watch) {
 	return () => {
-		const createReporter = require('./lib/reporter').createReporter;
-
 		return new Promise((resolve, reject) => {
 			const args = ['./node_modules/.bin/tsc', '-p', './src/tsconfig.monaco.json', '--noEmit'];
 			if (watch) {
@@ -281,11 +282,9 @@ function createTscCompileTask(watch) {
 	};
 }
 
-const monacoTypecheckWatchTask = task.define('monaco-typecheck-watch', createTscCompileTask(true));
-exports.monacoTypecheckWatchTask = monacoTypecheckWatchTask;
+export const monacoTypecheckWatchTask = task.define('monaco-typecheck-watch', createTscCompileTask(true));
 
-const monacoTypecheckTask = task.define('monaco-typecheck', createTscCompileTask(false));
-exports.monacoTypecheckTask = monacoTypecheckTask;
+export const monacoTypecheckTask = task.define('monaco-typecheck', createTscCompileTask(false));
 
 //#endregion
 

build/gulpfile.extensions.js renamed to build/gulpfile.extensions.mjs

@@ -4,23 +4,31 @@
  *--------------------------------------------------------------------------------------------*/
 
 // Increase max listeners for event emitters
-require('events').EventEmitter.defaultMaxListeners = 100;
-
-const gulp = require('gulp');
-const path = require('path');
-const nodeUtil = require('util');
-const es = require('event-stream');
-const filter = require('gulp-filter');
-const util = require('./lib/util');
-const { getVersion } = require('./lib/getVersion');
-const task = require('./lib/task');
-const watcher = require('./lib/watch');
-const createReporter = require('./lib/reporter').createReporter;
-const glob = require('glob');
+import { EventEmitter } from 'events';
+EventEmitter.defaultMaxListeners = 100;
+
+import gulp from 'gulp';
+import * as path from 'path';
+import * as nodeUtil from 'util';
+import es from 'event-stream';
+import filter from 'gulp-filter';
+import util from './lib/util.js';
+import getVersionModule from './lib/getVersion.js';
+import task from './lib/task.js';
+import watcher from './lib/watch/index.js';
+import reporterModule from './lib/reporter.js';
+import glob from 'glob';
+import plumber from 'gulp-plumber';
+import ext from './lib/extensions.js';
+import tsb from './lib/tsb/index.js';
+import sourcemaps from 'gulp-sourcemaps';
+import { fileURLToPath } from 'url';
+
+const __dirname = import.meta.dirname
+const { getVersion } = getVersionModule;
+const { createReporter } = reporterModule;
 const root = path.dirname(__dirname);
 const commit = getVersion(root);
-const plumber = require('gulp-plumber');
-const ext = require('./lib/extensions');
 
 // To save 250ms for each gulp startup, we are caching the result here
 // const compilations = glob.sync('**/tsconfig.json', {
@@ -92,9 +100,6 @@ const tasks = compilations.map(function (tsconfigFile) {
 	const baseUrl = getBaseUrl(out);
 
 	function createPipeline(build, emitError, transpileOnly) {
-		const tsb = require('./lib/tsb');
-		const sourcemaps = require('gulp-sourcemaps');
-
 		const reporter = createReporter('extensions');
 
 		overrideOptions.inlineSources = Boolean(build);
@@ -191,30 +196,25 @@ const tasks = compilations.map(function (tsconfigFile) {
 const transpileExtensionsTask = task.define('transpile-extensions', task.parallel(...tasks.map(t => t.transpileTask)));
 gulp.task(transpileExtensionsTask);
 
-const compileExtensionsTask = task.define('compile-extensions', task.parallel(...tasks.map(t => t.compileTask)));
+export const compileExtensionsTask = task.define('compile-extensions', task.parallel(...tasks.map(t => t.compileTask)));
 gulp.task(compileExtensionsTask);
-exports.compileExtensionsTask = compileExtensionsTask;
 
-const watchExtensionsTask = task.define('watch-extensions', task.parallel(...tasks.map(t => t.watchTask)));
+export const watchExtensionsTask = task.define('watch-extensions', task.parallel(...tasks.map(t => t.watchTask)));
 gulp.task(watchExtensionsTask);
-exports.watchExtensionsTask = watchExtensionsTask;
 
 const compileExtensionsBuildLegacyTask = task.define('compile-extensions-build-legacy', task.parallel(...tasks.map(t => t.compileBuildTask)));
 gulp.task(compileExtensionsBuildLegacyTask);
 
 //#region Extension media
 
-const compileExtensionMediaTask = task.define('compile-extension-media', () => ext.buildExtensionMedia(false));
+export const compileExtensionMediaTask = task.define('compile-extension-media', () => ext.buildExtensionMedia(false));
 gulp.task(compileExtensionMediaTask);
-exports.compileExtensionMediaTask = compileExtensionMediaTask;
 
-const watchExtensionMedia = task.define('watch-extension-media', () => ext.buildExtensionMedia(true));
+export const watchExtensionMedia = task.define('watch-extension-media', () => ext.buildExtensionMedia(true));
 gulp.task(watchExtensionMedia);
-exports.watchExtensionMedia = watchExtensionMedia;
 
-const compileExtensionMediaBuildTask = task.define('compile-extension-media-build', () => ext.buildExtensionMedia(false, '.build/extensions'));
+export const compileExtensionMediaBuildTask = task.define('compile-extension-media-build', () => ext.buildExtensionMedia(false, '.build/extensions'));
 gulp.task(compileExtensionMediaBuildTask);
-exports.compileExtensionMediaBuildTask = compileExtensionMediaBuildTask;
 
 //#endregion
 
@@ -223,8 +223,7 @@ exports.compileExtensionMediaBuildTask = compileExtensionMediaBuildTask;
 /**
  * Cleans the build directory for extensions
  */
-const cleanExtensionsBuildTask = task.define('clean-extensions-build', util.rimraf('.build/extensions'));
-exports.cleanExtensionsBuildTask = cleanExtensionsBuildTask;
+export const cleanExtensionsBuildTask = task.define('clean-extensions-build', util.rimraf('.build/extensions'));
 
 /**
  * brings in the marketplace extensions for the build
@@ -235,32 +234,29 @@ const bundleMarketplaceExtensionsBuildTask = task.define('bundle-marketplace-ext
  * Compiles the non-native extensions for the build
  * @note this does not clean the directory ahead of it. See {@link cleanExtensionsBuildTask} for that.
  */
-const compileNonNativeExtensionsBuildTask = task.define('compile-non-native-extensions-build', task.series(
+export const compileNonNativeExtensionsBuildTask = task.define('compile-non-native-extensions-build', task.series(
 	bundleMarketplaceExtensionsBuildTask,
 	task.define('bundle-non-native-extensions-build', () => ext.packageNonNativeLocalExtensionsStream(false, false).pipe(gulp.dest('.build')))
 ));
 gulp.task(compileNonNativeExtensionsBuildTask);
-exports.compileNonNativeExtensionsBuildTask = compileNonNativeExtensionsBuildTask;
 
 /**
  * Compiles the native extensions for the build
  * @note this does not clean the directory ahead of it. See {@link cleanExtensionsBuildTask} for that.
  */
-const compileNativeExtensionsBuildTask = task.define('compile-native-extensions-build', () => ext.packageNativeLocalExtensionsStream(false, false).pipe(gulp.dest('.build')));
+export const compileNativeExtensionsBuildTask = task.define('compile-native-extensions-build', () => ext.packageNativeLocalExtensionsStream(false, false).pipe(gulp.dest('.build')));
 gulp.task(compileNativeExtensionsBuildTask);
-exports.compileNativeExtensionsBuildTask = compileNativeExtensionsBuildTask;
 
 /**
  * Compiles the extensions for the build.
  * This is essentially a helper task that combines {@link cleanExtensionsBuildTask}, {@link compileNonNativeExtensionsBuildTask} and {@link compileNativeExtensionsBuildTask}
  */
-const compileAllExtensionsBuildTask = task.define('compile-extensions-build', task.series(
+export const compileAllExtensionsBuildTask = task.define('compile-extensions-build', task.series(
 	cleanExtensionsBuildTask,
 	bundleMarketplaceExtensionsBuildTask,
 	task.define('bundle-extensions-build', () => ext.packageAllLocalExtensionsStream(false, false).pipe(gulp.dest('.build'))),
 ));
 gulp.task(compileAllExtensionsBuildTask);
-exports.compileAllExtensionsBuildTask = compileAllExtensionsBuildTask;
 
 // This task is run in the compilation stage of the CI pipeline. We only compile the non-native extensions since those can be fully built regardless of platform.
 // This defers the native extensions to the platform specific stage of the CI pipeline.
@@ -278,13 +274,11 @@ gulp.task(task.define('extensions-ci-pr', task.series(compileExtensionsBuildPull
 
 //#endregion
 
-const compileWebExtensionsTask = task.define('compile-web', () => buildWebExtensions(false));
+export const compileWebExtensionsTask = task.define('compile-web', () => buildWebExtensions(false));
 gulp.task(compileWebExtensionsTask);
-exports.compileWebExtensionsTask = compileWebExtensionsTask;
 
-const watchWebExtensionsTask = task.define('watch-web', () => buildWebExtensions(true));
+export const watchWebExtensionsTask = task.define('watch-web', () => buildWebExtensions(true));
 gulp.task(watchWebExtensionsTask);
-exports.watchWebExtensionsTask = watchWebExtensionsTask;
 
 /**
  * @param {boolean} isWatch

build/gulpfile.js renamed to build/gulpfile.mjs

@@ -3,17 +3,23 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-'use strict';
+import { EventEmitter } from 'events';
+import glob from 'glob';
+import gulp from 'gulp';
+import { createRequire } from 'node:module';
+import { fileURLToPath } from 'url';
+import { monacoTypecheckTask /* , monacoTypecheckWatchTask */ } from './gulpfile.editor.mjs';
+import { compileExtensionMediaTask, compileExtensionsTask, watchExtensionsTask } from './gulpfile.extensions.mjs';
+import compilation from './lib/compilation.js';
+import task from './lib/task.js';
+import util from './lib/util.js';
 
-// Increase max listeners for event emitters
-require('events').EventEmitter.defaultMaxListeners = 100;
+EventEmitter.defaultMaxListeners = 100;
 
-const gulp = require('gulp');
-const util = require('./lib/util');
-const task = require('./lib/task');
-const { transpileTask, compileTask, watchTask, compileApiProposalNamesTask, watchApiProposalNamesTask } = require('./lib/compilation');
-const { monacoTypecheckTask/* , monacoTypecheckWatchTask */ } = require('./gulpfile.editor');
-const { compileExtensionsTask, watchExtensionsTask, compileExtensionMediaTask } = require('./gulpfile.extensions');
+const require = createRequire(import.meta.url);
+const __dirname = import.meta.dirname
+
+const { transpileTask, compileTask, watchTask, compileApiProposalNamesTask, watchApiProposalNamesTask } = compilation;
 
 // API proposal names
 gulp.task(compileApiProposalNamesTask);
@@ -49,5 +55,5 @@ process.on('unhandledRejection', (reason, p) => {
 });
 
 // Load all the gulpfiles only if running tasks other than the editor tasks
-require('glob').sync('gulpfile.*.{js,mjs}', { cwd: __dirname })
+glob.sync('gulpfile.*.{mjs,js}', { cwd: __dirname })
 	.forEach(f => require(`./${f}`));