@harmoniclabs/monaco-editor 0.52.0

package/build/releaseMetadata.ts

@@ -0,0 +1,280 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See LICENSE in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import glob = require('glob');
+import path = require('path');
+import fs = require('fs');
+import { REPO_ROOT } from './utils';
+import { ensureDir } from './fs';
+
+const customFeatureLabels = {
+	'vs/editor/browser/controller/coreCommands': 'coreCommands',
+	'vs/editor/contrib/caretOperations/caretOperations': 'caretOperations',
+	'vs/editor/contrib/caretOperations/transpose': 'transpose',
+	'vs/editor/contrib/colorPicker/colorDetector': 'colorDetector',
+	'vs/editor/contrib/rename/onTypeRename': 'onTypeRename',
+	'vs/editor/contrib/gotoSymbol/link/goToDefinitionAtPosition': 'gotoSymbol',
+	'vs/editor/contrib/snippet/snippetController2': 'snippets',
+	'vs/editor/standalone/browser/quickAccess/standaloneGotoLineQuickAccess': 'gotoLine',
+	'vs/editor/standalone/browser/quickAccess/standaloneCommandsQuickAccess': 'quickCommand',
+	'vs/editor/standalone/browser/quickAccess/standaloneGotoSymbolQuickAccess': 'quickOutline',
+	'vs/editor/standalone/browser/quickAccess/standaloneHelpQuickAccess': 'quickHelp'
+};
+
+function getBasicLanguages(): Promise<{ label: string; entry: string }[]> {
+	return new Promise((resolve, reject) => {
+		glob(
+			'./out/monaco-editor/esm/vs/basic-languages/*/*.contribution.js',
+			{ cwd: path.dirname(__dirname) },
+			(err, files) => {
+				if (err) {
+					reject(err);
+					return;
+				}
+
+				resolve(
+					files.map((file) => {
+						const entry = file.substring('./out/monaco-editor/esm/'.length).replace(/\.js$/, '');
+						const label = path.basename(file).replace(/\.contribution\.js$/, '');
+						return {
+							label: label,
+							entry: entry
+						};
+					})
+				);
+			}
+		);
+	});
+}
+
+function readAdvancedLanguages(): Promise<string[]> {
+	return new Promise((resolve, reject) => {
+		glob(
+			'./out/monaco-editor/esm/vs/language/*/monaco.contribution.js',
+			{ cwd: path.dirname(__dirname) },
+			(err, files) => {
+				if (err) {
+					reject(err);
+					return;
+				}
+
+				resolve(
+					files
+						.map((file) => file.substring('./out/monaco-editor/esm/vs/language/'.length))
+						.map((file) => file.substring(0, file.length - '/monaco.contribution.js'.length))
+				);
+			}
+		);
+	});
+}
+
+function getAdvancedLanguages(): Promise<
+	{ label: string; entry: string; worker: { id: string; entry: string } }[]
+> {
+	return readAdvancedLanguages().then((languages) => {
+		let result = [];
+		for (const lang of languages) {
+			let shortLang = lang === 'typescript' ? 'ts' : lang;
+			const entry = `vs/language/${lang}/monaco.contribution`;
+			checkFileExists(entry);
+			const workerId = `vs/language/${lang}/${shortLang}Worker`;
+			const workerEntry = `vs/language/${lang}/${shortLang}.worker`;
+			checkFileExists(workerEntry);
+			result.push({
+				label: lang,
+				entry: entry,
+				worker: {
+					id: workerId,
+					entry: workerEntry
+				}
+			});
+		}
+		return result;
+	});
+
+	function checkFileExists(moduleName) {
+		const filePath = path.join(REPO_ROOT, 'out/monaco-editor/esm', `${moduleName}.js`);
+		if (!fs.existsSync(filePath)) {
+			console.error(`Could not find ${filePath}.`);
+			process.exit(1);
+		}
+	}
+}
+
+export function generateMetadata() {
+	return Promise.all([getBasicLanguages(), getAdvancedLanguages()]).then(
+		([basicLanguages, advancedLanguages]) => {
+			basicLanguages.sort((a, b) => strcmp(a.entry, b.entry));
+			advancedLanguages.sort((a, b) => strcmp(a.entry, b.entry));
+
+			let i = 0,
+				len = basicLanguages.length;
+			let j = 0,
+				lenJ = advancedLanguages.length;
+			let languages = [];
+			while (i < len || j < lenJ) {
+				if (i < len && j < lenJ) {
+					if (basicLanguages[i].label === advancedLanguages[j].label) {
+						let entry = [];
+						entry.push(basicLanguages[i].entry);
+						entry.push(advancedLanguages[j].entry);
+						languages.push({
+							label: basicLanguages[i].label,
+							entry: entry,
+							worker: advancedLanguages[j].worker
+						});
+						i++;
+						j++;
+					} else if (basicLanguages[i].label < advancedLanguages[j].label) {
+						languages.push(basicLanguages[i]);
+						i++;
+					} else {
+						languages.push(advancedLanguages[j]);
+						j++;
+					}
+				} else if (i < len) {
+					languages.push(basicLanguages[i]);
+					i++;
+				} else {
+					languages.push(advancedLanguages[j]);
+					j++;
+				}
+			}
+
+			const features = getFeatures();
+
+			const dtsContents = `
+/*!----------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Released under the MIT license
+ * https://github.com/microsoft/monaco-editor/blob/main/LICENSE.txt
+ *----------------------------------------------------------------*/
+
+export interface IWorkerDefinition {
+	id: string;
+	entry: string;
+}
+
+export interface IFeatureDefinition {
+	label: string;
+	entry: string | string[] | undefined;
+	worker?: IWorkerDefinition;
+}
+
+export const features: IFeatureDefinition[];
+
+export const languages: IFeatureDefinition[];
+
+export type EditorLanguage = ${languages.map((el) => `'${el.label}'`).join(' | ')};
+
+export type EditorFeature = ${features.map((el) => `'${el.label}'`).join(' | ')};
+
+export type NegatedEditorFeature = ${features.map((el) => `'!${el.label}'`).join(' | ')};
+
+`;
+			const dtsDestination = path.join(REPO_ROOT, 'out/monaco-editor/esm/metadata.d.ts');
+			ensureDir(path.dirname(dtsDestination));
+			fs.writeFileSync(dtsDestination, dtsContents.replace(/\r\n/g, '\n'));
+
+			const jsContents = `
+exports.features = ${JSON.stringify(features, null, '  ')};
+exports.languages = ${JSON.stringify(languages, null, '  ')};
+`;
+			const jsDestination = path.join(REPO_ROOT, 'out/monaco-editor/esm/metadata.js');
+			ensureDir(path.dirname(jsDestination));
+			fs.writeFileSync(jsDestination, jsContents.replace(/\r\n/g, '\n'));
+
+			for (const feature of [...features, ...languages]) {
+				const entries = [].concat(feature.entry);
+				for (const entry of entries) {
+					const dtsDestination = path.join(REPO_ROOT, 'out/monaco-editor/esm', entry) + '.d.ts';
+					ensureDir(path.dirname(dtsDestination));
+					fs.writeFileSync(dtsDestination, 'export {}\n');
+				}
+			}
+		}
+	);
+}
+
+function strcmp(a: string, b: string) {
+	if (a < b) {
+		return -1;
+	}
+	if (a > b) {
+		return 1;
+	}
+	return 0;
+}
+
+function getFeatures(): { label: string; entry: string | string[] }[] {
+	const skipImports = [
+		'vs/editor/browser/widget/codeEditorWidget',
+		'vs/editor/browser/widget/diffEditorWidget',
+		'vs/editor/browser/widget/diffNavigator',
+		'vs/editor/common/standaloneStrings',
+		'vs/editor/contrib/tokenization/tokenization',
+		'vs/editor/editor.all',
+		'vs/base/browser/ui/codicons/codiconStyles',
+		'vs/editor/contrib/gotoSymbol/documentSymbols'
+	];
+
+	let features: string[] = [];
+	const files =
+		fs
+			.readFileSync(path.join(REPO_ROOT, 'out/monaco-editor/esm/vs/editor/edcore.main.js'))
+			.toString() +
+		fs
+			.readFileSync(path.join(REPO_ROOT, 'out/monaco-editor/esm/vs/editor/editor.all.js'))
+			.toString();
+	files.split(/\r\n|\n/).forEach((line) => {
+		const m = line.match(/import '([^']+)'/);
+		if (m) {
+			const tmp = path.posix.join('vs/editor', m[1]).replace(/\.js$/, '');
+			if (skipImports.indexOf(tmp) === -1) {
+				features.push(tmp);
+			}
+		}
+	});
+
+	let result: { label: string; entry: any }[] = features.map((feature) => {
+		/** @type {string} */ let label;
+		if (customFeatureLabels[feature]) {
+			label = customFeatureLabels[feature];
+		} else {
+			const m1 = feature.match(/^vs\/editor\/contrib\/([^\/]+)/);
+			if (m1) {
+				// for editor/contrib features, use the first segment
+				label = m1[1];
+			} else {
+				// for everything else, use the last segment folder
+				label = path.basename(path.dirname(feature));
+			}
+		}
+		return {
+			label: label,
+			entry: feature
+		};
+	});
+
+	result.sort((a, b) => {
+		const labelCmp = strcmp(a.label, b.label);
+		if (labelCmp === 0) {
+			return strcmp(a.entry, b.entry);
+		}
+		return labelCmp;
+	});
+
+	for (let i = 0; i < result.length; i++) {
+		if (i + 1 < result.length && result[i].label === result[i + 1].label) {
+			if (typeof result[i].entry === 'string') {
+				result[i].entry = [result[i].entry];
+			}
+			result[i].entry.push(result[i + 1].entry);
+			result.splice(i + 1, 1);
+		}
+	}
+
+	return result;
+}

package/build/simpleserver.ts

@@ -0,0 +1,69 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import fs = require('fs');
+import path = require('path');
+import http = require('http');
+import yaserver = require('yaserver');
+import { REPO_ROOT } from './utils';
+import { ensureDir } from './fs';
+
+generateTestSamplesTask();
+
+const SERVER_ROOT = path.normalize(path.join(REPO_ROOT, '../'));
+createSimpleServer(SERVER_ROOT, 8080);
+createSimpleServer(SERVER_ROOT, 8088);
+
+function generateTestSamplesTask() {
+	const sampleNames = fs.readdirSync(path.join(REPO_ROOT, 'test/manual/samples'));
+	let samples = sampleNames.map((sampleName) => {
+		const samplePath = path.join(REPO_ROOT, 'test/manual/samples', sampleName);
+		const sampleContent = fs.readFileSync(samplePath).toString();
+		return {
+			name: sampleName,
+			content: sampleContent
+		};
+	});
+
+	// Add samples from website
+	{
+		let sampleNames = fs.readdirSync(path.join(REPO_ROOT, 'website/index/samples'));
+		sampleNames = sampleNames.filter((name) => /^sample/.test(name));
+
+		samples = samples.concat(
+			sampleNames.map((sampleName) => {
+				const samplePath = path.join(REPO_ROOT, 'website/index/samples', sampleName);
+				const sampleContent = fs.readFileSync(samplePath).toString();
+				return {
+					name: sampleName,
+					content: sampleContent
+				};
+			})
+		);
+	}
+
+	const prefix =
+		'//This is a generated file via `npm run simpleserver`\ndefine([], function() { return';
+	const suffix = '; });';
+
+	const destination = path.join(REPO_ROOT, 'test/manual/generated/all-samples.js');
+	ensureDir(path.dirname(destination));
+	fs.writeFileSync(destination, prefix + JSON.stringify(samples, null, '\t') + suffix);
+}
+
+function createSimpleServer(rootDir: string, port: number) {
+	yaserver
+		.createServer({
+			rootDir: rootDir
+		})
+		.then((staticServer) => {
+			const server = http.createServer((request, response) => {
+				return staticServer.handle(request, response);
+			});
+			server.listen(port, '127.0.0.1', () => {
+				console.log(`Running at http://127.0.0.1:${port}`);
+			});
+		});
+}

package/build/tsconfig.json

@@ -0,0 +1,8 @@
+{
+	"compilerOptions": {
+		"noEmit": true,
+		"module": "CommonJS",
+		"esModuleInterop": true
+	},
+	"include": ["./**/*"]
+}

package/build/utils.ts

@@ -0,0 +1,291 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as fs from 'fs';
+import * as path from 'path';
+import * as cp from 'child_process';
+import * as esbuild from 'esbuild';
+import alias from 'esbuild-plugin-alias';
+import * as glob from 'glob';
+import { ensureDir } from './fs';
+
+export const REPO_ROOT = path.join(__dirname, '../');
+
+/**
+ * Launch the typescript compiler synchronously over a project.
+ */
+export function runTsc(_projectPath: string) {
+	const projectPath = path.join(REPO_ROOT, _projectPath);
+	console.log(`Launching compiler at ${_projectPath}...`);
+	const res = cp.spawnSync(
+		process.execPath,
+		[path.join(__dirname, '../node_modules/typescript/lib/tsc.js'), '-p', projectPath],
+		{ stdio: 'inherit' }
+	);
+	console.log(`Compiled ${_projectPath}`);
+	if (res.status !== 0) {
+		process.exit(res.status);
+	}
+}
+
+/**
+ * Launch prettier on a specific file.
+ */
+export function prettier(_filePath: string) {
+	const filePath = path.join(REPO_ROOT, _filePath);
+	cp.spawnSync(
+		process.execPath,
+		[path.join(__dirname, '../node_modules/prettier/bin-prettier.js'), '--write', filePath],
+		{ stdio: 'inherit' }
+	);
+
+	console.log(`Ran prettier over ${_filePath}`);
+}
+
+/**
+ * Transform an external .d.ts file to an internal .d.ts file
+ */
+export function massageAndCopyDts(source: string, destination: string, namespace: string) {
+	const absoluteSource = path.join(REPO_ROOT, source);
+	const absoluteDestination = path.join(REPO_ROOT, destination);
+
+	const lines = fs
+		.readFileSync(absoluteSource)
+		.toString()
+		.split(/\r\n|\r|\n/);
+
+	let result = [
+		`/*---------------------------------------------------------------------------------------------`,
+		` *  Copyright (c) Microsoft Corporation. All rights reserved.`,
+		` *  Licensed under the MIT License. See License.txt in the project root for license information.`,
+		` *--------------------------------------------------------------------------------------------*/`,
+		``,
+		`declare namespace ${namespace} {`
+	];
+	for (let line of lines) {
+		if (/^import/.test(line)) {
+			continue;
+		}
+		if (line === 'export {};') {
+			continue;
+		}
+		line = line.replace(/    /g, '\t');
+		line = line.replace(/declare /g, '');
+		if (line.length > 0) {
+			line = `\t${line}`;
+			result.push(line);
+		}
+	}
+	result.push(`}`);
+	result.push(``);
+
+	ensureDir(path.dirname(absoluteDestination));
+	fs.writeFileSync(absoluteDestination, result.join('\n'));
+
+	prettier(destination);
+}
+
+export function build(options: import('esbuild').BuildOptions) {
+	esbuild.build(options).then((result) => {
+		if (result.errors.length > 0) {
+			console.error(result.errors);
+		}
+		if (result.warnings.length > 0) {
+			console.error(result.warnings);
+		}
+	});
+}
+
+export function buildESM(options: { base: string; entryPoints: string[]; external: string[] }) {
+	build({
+		entryPoints: options.entryPoints,
+		bundle: true,
+		target: 'esnext',
+		format: 'esm',
+		drop: ['debugger'],
+		define: {
+			AMD: 'false'
+		},
+		banner: {
+			js: bundledFileHeader
+		},
+		external: options.external,
+		outbase: `src/${options.base}`,
+		outdir: `out/languages/bundled/esm/vs/${options.base}/`,
+		plugins: [
+			alias({
+				'vscode-nls': path.join(__dirname, 'fillers/vscode-nls.ts')
+			})
+		]
+	});
+}
+
+function buildOneAMD(
+	type: 'dev' | 'min',
+	options: {
+		base: string;
+		entryPoint: string;
+		amdModuleId: string;
+		amdDependencies?: string[];
+		external?: string[];
+	}
+) {
+	if (!options.amdDependencies) {
+		options.amdDependencies = [];
+	}
+	options.amdDependencies.unshift('require');
+
+	const opts: esbuild.BuildOptions = {
+		entryPoints: [options.entryPoint],
+		bundle: true,
+		target: 'esnext',
+		format: 'iife',
+		drop: ['debugger'],
+		define: {
+			AMD: 'true'
+		},
+		globalName: 'moduleExports',
+		banner: {
+			js: `${bundledFileHeader}define("${options.amdModuleId}", [${(options.amdDependencies || [])
+				.map((dep) => `"${dep}"`)
+				.join(',')}],(require)=>{`
+		},
+		footer: {
+			js: 'return moduleExports;\n});'
+		},
+		outbase: `src/${options.base}`,
+		outdir: `out/languages/bundled/amd-${type}/vs/${options.base}/`,
+		plugins: [
+			alias({
+				'vscode-nls': path.join(__dirname, '../build/fillers/vscode-nls.ts'),
+				'monaco-editor-core': path.join(__dirname, '../src/fillers/monaco-editor-core-amd.ts')
+			})
+		],
+		external: ['vs/editor/editor.api', ...(options.external || [])]
+	};
+	if (type === 'min') {
+		opts.minify = true;
+	}
+	build(opts);
+}
+
+export function buildAMD(options: {
+	base: string;
+	entryPoint: string;
+	amdModuleId: string;
+	amdDependencies?: string[];
+	external?: string[];
+}) {
+	buildOneAMD('dev', options);
+	buildOneAMD('min', options);
+}
+
+function getGitVersion() {
+	const git = path.join(REPO_ROOT, '.git');
+	const headPath = path.join(git, 'HEAD');
+	let head;
+
+	try {
+		head = fs.readFileSync(headPath, 'utf8').trim();
+	} catch (e) {
+		return void 0;
+	}
+
+	if (/^[0-9a-f]{40}$/i.test(head)) {
+		return head;
+	}
+
+	const refMatch = /^ref: (.*)$/.exec(head);
+
+	if (!refMatch) {
+		return void 0;
+	}
+
+	const ref = refMatch[1];
+	const refPath = path.join(git, ref);
+
+	try {
+		return fs.readFileSync(refPath, 'utf8').trim();
+	} catch (e) {
+		// noop
+	}
+
+	const packedRefsPath = path.join(git, 'packed-refs');
+	let refsRaw;
+
+	try {
+		refsRaw = fs.readFileSync(packedRefsPath, 'utf8').trim();
+	} catch (e) {
+		return void 0;
+	}
+
+	const refsRegex = /^([0-9a-f]{40})\s+(.+)$/gm;
+	let refsMatch;
+	const refs = {};
+
+	while ((refsMatch = refsRegex.exec(refsRaw))) {
+		refs[refsMatch[2]] = refsMatch[1];
+	}
+
+	return refs[ref];
+}
+
+export const bundledFileHeader = (() => {
+	const sha1 = getGitVersion();
+	const semver = require('../package.json').version;
+	const headerVersion = semver + '(' + sha1 + ')';
+
+	const BUNDLED_FILE_HEADER = [
+		'/*!-----------------------------------------------------------------------------',
+		' * Copyright (c) Microsoft Corporation. All rights reserved.',
+		' * Version: ' + headerVersion,
+		' * Released under the MIT license',
+		' * https://github.com/microsoft/monaco-editor/blob/main/LICENSE.txt',
+		' *-----------------------------------------------------------------------------*/',
+		''
+	].join('\n');
+
+	return BUNDLED_FILE_HEADER;
+})();
+
+export interface IFile {
+	path: string;
+	contents: Buffer;
+}
+
+export function readFiles(
+	pattern: string,
+	options: { base: string; ignore?: string[]; dot?: boolean }
+): IFile[] {
+	let files = glob.sync(pattern, { cwd: REPO_ROOT, ignore: options.ignore, dot: options.dot });
+	// remove dirs
+	files = files.filter((file) => {
+		const fullPath = path.join(REPO_ROOT, file);
+		const stats = fs.statSync(fullPath);
+		return stats.isFile();
+	});
+
+	const base = options.base;
+	return files.map((file) => readFile(file, base));
+}
+
+export function readFile(file: string, base: string = '') {
+	const baseLength = base === '' ? 0 : base.endsWith('/') ? base.length : base.length + 1;
+	const fullPath = path.join(REPO_ROOT, file);
+	const contents = fs.readFileSync(fullPath);
+	const relativePath = file.substring(baseLength);
+	return {
+		path: relativePath,
+		contents
+	};
+}
+
+export function writeFiles(files: IFile[], dest: string) {
+	for (const file of files) {
+		const fullPath = path.join(REPO_ROOT, dest, file.path);
+		ensureDir(path.dirname(fullPath));
+		fs.writeFileSync(fullPath, file.contents);
+	}
+}