Merge remote-tracking branch 'origin/main' into tyriar/258480

Author: Tyriar

build/buildfile.js

@@ -2,6 +2,7 @@
  *  Copyright (c) Microsoft Corporation. All rights reserved.
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
+// @ts-check
 
 /**
  * @param {string} name

build/eslint.js

@@ -2,7 +2,7 @@
  *  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 es = require('event-stream');
 const vfs = require('vinyl-fs');
 const { eslintFilter } = require('./filters');

build/filters.js

@@ -2,6 +2,7 @@
  *  Copyright (c) Microsoft Corporation. All rights reserved.
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
+// @ts-check
 
 /**
  * Hygiene works by creating cascading subsets of all our files and

build/gulp-eslint.js

@@ -6,24 +6,28 @@
 'use strict';
 
 const { ESLint } = require('eslint');
-const { Transform } = require('stream');
+const { Transform, default: Stream } = require('stream');
 const { relative } = require('path');
 const fancyLog = require('fancy-log');
 
 /**
- * @param {Function} action - A function to handle all ESLint results
- * @returns {stream} gulp file stream
+ * @typedef {ESLint.LintResult[] & { errorCount: number, warningCount: number}} ESLintResults
+ */
+
+/**
+ * @param {(results: ESLintResults) => void} action - A function to handle all ESLint results
  */
 function eslint(action) {
 	const linter = new ESLint({});
 	const formatter = linter.loadFormatter('compact');
 
+	/** @type {ESLintResults} results */
 	const results = [];
 	results.errorCount = 0;
 	results.warningCount = 0;
 
 	return transform(
-		async (file, enc, cb) => {
+		async (file, _enc, cb) => {
 			const filePath = relative(process.cwd(), file.path);
 
 			if (file.isNull()) {
@@ -67,6 +71,10 @@ function eslint(action) {
 		});
 }
 
+/**
+ * @param {Stream.TransformOptions['transform']} transform
+ * @param {Stream.TransformOptions['flush']} flush
+ */
 function transform(transform, flush) {
 	return new Transform({
 		objectMode: true,

build/gulpfile.cli.js

@@ -12,7 +12,7 @@ const fancyLog = require('fancy-log');
 const ansiColors = require('ansi-colors');
 const cp = require('child_process');
 const { tmpdir } = require('os');
-const { promises: fs, existsSync, mkdirSync, rmSync } = require('fs');
+const { existsSync, mkdirSync, rmSync } = require('fs');
 
 const task = require('./lib/task');
 const watcher = require('./lib/watch');
@@ -58,36 +58,6 @@ const hasLocalRust = (() => {
 	};
 })();
 
-const debounceEsStream = (fn, duration = 100) => {
-	let handle = undefined;
-	let pending = [];
-	const sendAll = (pending) => (event, ...args) => {
-		for (const stream of pending) {
-			pending.emit(event, ...args);
-		}
-	};
-
-	return es.map(function (_, callback) {
-		console.log('defer');
-		if (handle !== undefined) {
-			clearTimeout(handle);
-		}
-
-		handle = setTimeout(() => {
-			handle = undefined;
-
-			const previous = pending;
-			pending = [];
-			fn()
-				.on('error', sendAll('error'))
-				.on('data', sendAll('data'))
-				.on('end', sendAll('end'));
-		}, duration);
-
-		pending.push(this);
-	});
-};
-
 const compileFromSources = (callback) => {
 	const proc = cp.spawn('cargo', ['--color', 'always', 'build'], {
 		cwd: root,

build/gulpfile.extensions.js

@@ -92,16 +92,6 @@ const tasks = compilations.map(function (tsconfigFile) {
 	const out = path.join(srcRoot, 'out');
 	const baseUrl = getBaseUrl(out);
 
-	let headerId, headerOut;
-	const index = relativeDirname.indexOf('/');
-	if (index < 0) {
-		headerId = 'vscode.' + relativeDirname;
-		headerOut = 'out';
-	} else {
-		headerId = 'vscode.' + relativeDirname.substr(0, index);
-		headerOut = relativeDirname.substr(index + 1) + '/out';
-	}
-
 	function createPipeline(build, emitError, transpileOnly) {
 		const tsb = require('./lib/tsb');
 		const sourcemaps = require('gulp-sourcemaps');
@@ -248,7 +238,7 @@ const bundleMarketplaceExtensionsBuildTask = task.define('bundle-marketplace-ext
  */
 const compileNonNativeExtensionsBuildTask = task.define('compile-non-native-extensions-build', task.series(
 	bundleMarketplaceExtensionsBuildTask,
-	task.define('bundle-non-native-extensions-build', () => ext.packageNonNativeLocalExtensionsStream().pipe(gulp.dest('.build')))
+	task.define('bundle-non-native-extensions-build', () => ext.packageNonNativeLocalExtensionsStream(false, false).pipe(gulp.dest('.build')))
 ));
 gulp.task(compileNonNativeExtensionsBuildTask);
 exports.compileNonNativeExtensionsBuildTask = compileNonNativeExtensionsBuildTask;
@@ -257,7 +247,7 @@ exports.compileNonNativeExtensionsBuildTask = compileNonNativeExtensionsBuildTas
  * 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().pipe(gulp.dest('.build')));
+const compileNativeExtensionsBuildTask = task.define('compile-native-extensions-build', () => ext.packageNativeLocalExtensionsStream(false, false).pipe(gulp.dest('.build')));
 gulp.task(compileNativeExtensionsBuildTask);
 exports.compileNativeExtensionsBuildTask = compileNativeExtensionsBuildTask;
 

build/gulpfile.js

@@ -11,7 +11,7 @@ require('events').EventEmitter.defaultMaxListeners = 100;
 const gulp = require('gulp');
 const util = require('./lib/util');
 const task = require('./lib/task');
-const { transpileClientSWC, transpileTask, compileTask, watchTask, compileApiProposalNamesTask, watchApiProposalNamesTask } = require('./lib/compilation');
+const { transpileTask, compileTask, watchTask, compileApiProposalNamesTask, watchApiProposalNamesTask } = require('./lib/compilation');
 const { monacoTypecheckTask/* , monacoTypecheckWatchTask */ } = require('./gulpfile.editor');
 const { compileExtensionsTask, watchExtensionsTask, compileExtensionMediaTask } = require('./gulpfile.extensions');
 

build/gulpfile.vscode.web.js

@@ -93,6 +93,10 @@ const vscodeWebEntryPoints = [
  * @param {object} product The parsed product.json file contents
  */
 const createVSCodeWebFileContentMapper = (extensionsRoot, product) => {
+	/**
+	 * @param {string} path
+	 * @returns {((content: string) => string) | undefined}
+	 */
 	return path => {
 		if (path.endsWith('vs/platform/product/common/product.js')) {
 			return content => {
@@ -138,6 +142,10 @@ const minifyVSCodeWebTask = task.define('minify-vscode-web', task.series(
 ));
 gulp.task(minifyVSCodeWebTask);
 
+/**
+ * @param {string} sourceFolderName
+ * @param {string} destinationFolderName
+ */
 function packageTask(sourceFolderName, destinationFolderName) {
 	const destination = path.join(BUILD_ROOT, destinationFolderName);
 

build/gulpfile.vscode.win32.js

@@ -2,7 +2,6 @@
  *  Copyright (c) Microsoft Corporation. All rights reserved.
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
-
 'use strict';
 
 const gulp = require('gulp');

build/hygiene.js

@@ -2,6 +2,7 @@
  *  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 filter = require('gulp-filter');
 const es = require('event-stream');
@@ -20,6 +21,10 @@ const copyrightHeaderLines = [
 	' *--------------------------------------------------------------------------------------------*/',
 ];
 
+/**
+ * @param {string[] | NodeJS.ReadWriteStream} some
+ * @param {boolean} linting
+ */
 function hygiene(some, linting = true) {
 	const eslint = require('./gulp-eslint');
 	const gulpstylelint = require('./stylelint');
@@ -39,6 +44,7 @@ function hygiene(some, linting = true) {
 	});
 
 	const unicode = es.through(function (file) {
+		/** @type {string[]} */
 		const lines = file.contents.toString('utf8').split(/\r\n|\r|\n/);
 		file.__lines = lines;
 		const allowInComments = lines.some(line => /allow-any-unicode-comment-file/.test(line));
@@ -76,6 +82,7 @@ function hygiene(some, linting = true) {
 	});
 
 	const indentation = es.through(function (file) {
+		/** @type {string[]} */
 		const lines = file.__lines || file.contents.toString('utf8').split(/\r\n|\r|\n/);
 		file.__lines = lines;
 
@@ -125,14 +132,13 @@ function hygiene(some, linting = true) {
 				);
 				errorCount++;
 			}
-			cb(null, file);
+			cb(undefined, file);
 		} catch (err) {
 			cb(err);
 		}
 	});
 
 	let input;
-
 	if (Array.isArray(some) || typeof some === 'string' || !some) {
 		const options = { base: '.', follow: true, allowEmpty: true };
 		if (some) {
@@ -164,6 +170,7 @@ function hygiene(some, linting = true) {
 		.pipe(filter(copyrightFilter))
 		.pipe(copyrights);
 
+	/** @type {import('stream').Stream[]} */
 	const streams = [
 		result.pipe(filter(tsFormattingFilter)).pipe(formatting)
 	];
@@ -220,6 +227,9 @@ function hygiene(some, linting = true) {
 
 module.exports.hygiene = hygiene;
 
+/**
+ * @param {string[]} paths
+ */
 function createGitIndexVinyls(paths) {
 	const cp = require('child_process');
 	const repositoryPath = process.cwd();
@@ -294,12 +304,14 @@ if (require.main === module) {
 
 					createGitIndexVinyls(some)
 						.then(
-							(vinyls) =>
-								new Promise((c, e) =>
+							(vinyls) => {
+								/** @type {Promise<void>} */
+								return (new Promise((c, e) =>
 									hygiene(es.readArray(vinyls).pipe(filter(all)))
 										.on('end', () => c())
 										.on('error', e)
-								)
+								))
+							}
 						)
 						.catch((err) => {
 							console.error();