mirror of
https://github.com/Microsoft/vscode
synced 2024-11-05 18:29:38 +00:00
535 lines
16 KiB
JavaScript
535 lines
16 KiB
JavaScript
/*---------------------------------------------------------------------------------------------
|
|
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
* Licensed under the MIT License. See License.txt in the project root for license information.
|
|
*--------------------------------------------------------------------------------------------*/
|
|
|
|
const gulp = require('gulp');
|
|
const path = require('path');
|
|
const util = require('./lib/util');
|
|
const { getVersion } = require('./lib/getVersion');
|
|
const task = require('./lib/task');
|
|
const optimize = require('./lib/optimize');
|
|
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 root = path.dirname(__dirname);
|
|
const sha1 = getVersion(root);
|
|
const semver = require('./monaco/package.json').version;
|
|
const headerVersion = semver + '(' + sha1 + ')';
|
|
|
|
// Build
|
|
|
|
const editorEntryPoints = [
|
|
{
|
|
name: 'vs/editor/editor.main',
|
|
include: [],
|
|
exclude: ['vs/css', 'vs/nls'],
|
|
prepend: [
|
|
{ path: 'out-editor-build/vs/css.js', amdModuleId: 'vs/css' },
|
|
{ path: 'out-editor-build/vs/nls.js', amdModuleId: 'vs/nls' }
|
|
],
|
|
},
|
|
{
|
|
name: 'vs/base/common/worker/simpleWorker',
|
|
include: ['vs/editor/common/services/editorSimpleWorker'],
|
|
exclude: ['vs/nls'],
|
|
prepend: [
|
|
{ path: 'vs/loader.js' },
|
|
{ path: 'vs/nls.js', amdModuleId: 'vs/nls' },
|
|
{ path: 'vs/base/worker/workerMain.js' }
|
|
],
|
|
dest: 'vs/base/worker/workerMain.js'
|
|
}
|
|
];
|
|
|
|
const editorResources = [
|
|
'out-editor-build/vs/base/browser/ui/codicons/**/*.ttf'
|
|
];
|
|
|
|
const BUNDLED_FILE_HEADER = [
|
|
'/*!-----------------------------------------------------------',
|
|
' * Copyright (c) Microsoft Corporation. All rights reserved.',
|
|
' * Version: ' + headerVersion,
|
|
' * Released under the MIT license',
|
|
' * https://github.com/microsoft/vscode/blob/main/LICENSE.txt',
|
|
' *-----------------------------------------------------------*/',
|
|
''
|
|
].join('\n');
|
|
|
|
const languages = i18n.defaultLanguages.concat([]); // i18n.defaultLanguages.concat(process.env.VSCODE_QUALITY !== 'stable' ? i18n.extraLanguages : []);
|
|
|
|
const extractEditorSrcTask = task.define('extract-editor-src', () => {
|
|
const apiusages = monacoapi.execute().usageContent;
|
|
const extrausages = fs.readFileSync(path.join(root, 'build', 'monaco', 'monaco.usage.recipe')).toString();
|
|
standalone.extractEditor({
|
|
sourcesRoot: path.join(root, 'src'),
|
|
entryPoints: [
|
|
'vs/editor/editor.main',
|
|
'vs/editor/editor.worker',
|
|
'vs/base/worker/workerMain',
|
|
],
|
|
inlineEntryPoints: [
|
|
apiusages,
|
|
extrausages
|
|
],
|
|
shakeLevel: 2, // 0-Files, 1-InnerFile, 2-ClassMembers
|
|
importIgnorePattern: /(^vs\/css!)/,
|
|
destRoot: path.join(root, 'out-editor-src'),
|
|
redirects: []
|
|
});
|
|
});
|
|
|
|
// Disable mangling for the editor, as it complicates debugging & quite a few users rely on private/protected fields.
|
|
const compileEditorAMDTask = task.define('compile-editor-amd', compilation.compileTask('out-editor-src', 'out-editor-build', true, { disableMangle: true }));
|
|
|
|
const optimizeEditorAMDTask = task.define('optimize-editor-amd', optimize.optimizeTask(
|
|
{
|
|
out: 'out-editor',
|
|
amd: {
|
|
src: 'out-editor-build',
|
|
entryPoints: editorEntryPoints,
|
|
resources: editorResources,
|
|
loaderConfig: {
|
|
paths: {
|
|
'vs': 'out-editor-build/vs',
|
|
'vs/css': 'out-editor-build/vs/css.build',
|
|
'vs/nls': 'out-editor-build/vs/nls.build',
|
|
'vscode': 'empty:'
|
|
}
|
|
},
|
|
header: BUNDLED_FILE_HEADER,
|
|
bundleInfo: true,
|
|
languages
|
|
}
|
|
}
|
|
));
|
|
|
|
const minifyEditorAMDTask = task.define('minify-editor-amd', optimize.minifyTask('out-editor'));
|
|
|
|
const createESMSourcesAndResourcesTask = task.define('extract-editor-esm', () => {
|
|
standalone.createESMSourcesAndResources2({
|
|
srcFolder: './out-editor-src',
|
|
outFolder: './out-editor-esm',
|
|
outResourcesFolder: './out-monaco-editor-core/esm',
|
|
ignores: [
|
|
'inlineEntryPoint:0.ts',
|
|
'inlineEntryPoint:1.ts',
|
|
'vs/loader.js',
|
|
'vs/base/worker/workerMain.ts',
|
|
],
|
|
renames: {
|
|
'vs/nls.mock.ts': 'vs/nls.ts'
|
|
}
|
|
});
|
|
});
|
|
|
|
const compileEditorESMTask = task.define('compile-editor-esm', () => {
|
|
const KEEP_PREV_ANALYSIS = false;
|
|
const FAIL_ON_PURPOSE = false;
|
|
console.log(`Launching the TS compiler at ${path.join(__dirname, '../out-editor-esm')}...`);
|
|
let result;
|
|
if (process.platform === 'win32') {
|
|
result = cp.spawnSync(`..\\node_modules\\.bin\\tsc.cmd`, {
|
|
cwd: path.join(__dirname, '../out-editor-esm')
|
|
});
|
|
} else {
|
|
result = cp.spawnSync(`node`, [`../node_modules/.bin/tsc`], {
|
|
cwd: path.join(__dirname, '../out-editor-esm')
|
|
});
|
|
}
|
|
|
|
console.log(result.stdout.toString());
|
|
console.log(result.stderr.toString());
|
|
|
|
if (FAIL_ON_PURPOSE || result.status !== 0) {
|
|
console.log(`The TS Compilation failed, preparing analysis folder...`);
|
|
const destPath = path.join(__dirname, '../../vscode-monaco-editor-esm-analysis');
|
|
const keepPrevAnalysis = (KEEP_PREV_ANALYSIS && fs.existsSync(destPath));
|
|
const cleanDestPath = (keepPrevAnalysis ? Promise.resolve() : util.rimraf(destPath)());
|
|
return cleanDestPath.then(() => {
|
|
// build a list of files to copy
|
|
const files = util.rreddir(path.join(__dirname, '../out-editor-esm'));
|
|
|
|
if (!keepPrevAnalysis) {
|
|
fs.mkdirSync(destPath);
|
|
|
|
// initialize a new repository
|
|
cp.spawnSync(`git`, [`init`], {
|
|
cwd: destPath
|
|
});
|
|
|
|
// copy files from src
|
|
for (const file of files) {
|
|
const srcFilePath = path.join(__dirname, '../src', file);
|
|
const dstFilePath = path.join(destPath, file);
|
|
if (fs.existsSync(srcFilePath)) {
|
|
util.ensureDir(path.dirname(dstFilePath));
|
|
const contents = fs.readFileSync(srcFilePath).toString().replace(/\r\n|\r|\n/g, '\n');
|
|
fs.writeFileSync(dstFilePath, contents);
|
|
}
|
|
}
|
|
|
|
// create an initial commit to diff against
|
|
cp.spawnSync(`git`, [`add`, `.`], {
|
|
cwd: destPath
|
|
});
|
|
|
|
// create the commit
|
|
cp.spawnSync(`git`, [`commit`, `-m`, `"original sources"`, `--no-gpg-sign`], {
|
|
cwd: destPath
|
|
});
|
|
}
|
|
|
|
// copy files from tree shaken src
|
|
for (const file of files) {
|
|
const srcFilePath = path.join(__dirname, '../out-editor-src', file);
|
|
const dstFilePath = path.join(destPath, file);
|
|
if (fs.existsSync(srcFilePath)) {
|
|
util.ensureDir(path.dirname(dstFilePath));
|
|
const contents = fs.readFileSync(srcFilePath).toString().replace(/\r\n|\r|\n/g, '\n');
|
|
fs.writeFileSync(dstFilePath, contents);
|
|
}
|
|
}
|
|
|
|
console.log(`Open in VS Code the folder at '${destPath}' and you can analyze the compilation error`);
|
|
throw new Error('Standalone Editor compilation failed. If this is the build machine, simply launch `yarn run gulp editor-distro` on your machine to further analyze the compilation problem.');
|
|
});
|
|
}
|
|
});
|
|
|
|
/**
|
|
* Go over all .js files in `/out-monaco-editor-core/esm/` and make sure that all imports
|
|
* use `.js` at the end in order to be ESM compliant.
|
|
*/
|
|
const appendJSToESMImportsTask = task.define('append-js-to-esm-imports', () => {
|
|
const SRC_DIR = path.join(__dirname, '../out-monaco-editor-core/esm');
|
|
const files = util.rreddir(SRC_DIR);
|
|
for (const file of files) {
|
|
const filePath = path.join(SRC_DIR, file);
|
|
if (!/\.js$/.test(filePath)) {
|
|
continue;
|
|
}
|
|
|
|
const contents = fs.readFileSync(filePath).toString();
|
|
const lines = contents.split(/\r\n|\r|\n/g);
|
|
const /** @type {string[]} */result = [];
|
|
for (const line of lines) {
|
|
if (!/^import/.test(line) && !/^export \* from/.test(line)) {
|
|
// not an import
|
|
result.push(line);
|
|
continue;
|
|
}
|
|
if (/^import '[^']+\.css';/.test(line)) {
|
|
// CSS import
|
|
result.push(line);
|
|
continue;
|
|
}
|
|
const modifiedLine = (
|
|
line
|
|
.replace(/^import(.*)\'([^']+)\'/, `import$1'$2.js'`)
|
|
.replace(/^export \* from \'([^']+)\'/, `export * from '$1.js'`)
|
|
);
|
|
result.push(modifiedLine);
|
|
}
|
|
fs.writeFileSync(filePath, result.join('\n'));
|
|
}
|
|
});
|
|
|
|
/**
|
|
* @param {string} contents
|
|
*/
|
|
function toExternalDTS(contents) {
|
|
const lines = contents.split(/\r\n|\r|\n/);
|
|
let killNextCloseCurlyBrace = false;
|
|
for (let i = 0; i < lines.length; i++) {
|
|
const line = lines[i];
|
|
|
|
if (killNextCloseCurlyBrace) {
|
|
if ('}' === line) {
|
|
lines[i] = '';
|
|
killNextCloseCurlyBrace = false;
|
|
continue;
|
|
}
|
|
|
|
if (line.indexOf(' ') === 0) {
|
|
lines[i] = line.substr(4);
|
|
} else if (line.charAt(0) === '\t') {
|
|
lines[i] = line.substr(1);
|
|
}
|
|
|
|
continue;
|
|
}
|
|
|
|
if ('declare namespace monaco {' === line) {
|
|
lines[i] = '';
|
|
killNextCloseCurlyBrace = true;
|
|
continue;
|
|
}
|
|
|
|
if (line.indexOf('declare namespace monaco.') === 0) {
|
|
lines[i] = line.replace('declare namespace monaco.', 'export namespace ');
|
|
}
|
|
|
|
if (line.indexOf('declare let MonacoEnvironment') === 0) {
|
|
lines[i] = `declare global {\n let MonacoEnvironment: Environment | undefined;\n}`;
|
|
}
|
|
|
|
if (line.indexOf('\tMonacoEnvironment?') === 0) {
|
|
lines[i] = ` MonacoEnvironment?: Environment | undefined;`;
|
|
}
|
|
}
|
|
return lines.join('\n').replace(/\n\n\n+/g, '\n\n');
|
|
}
|
|
|
|
/**
|
|
* @param {{ (path: string): boolean }} testFunc
|
|
*/
|
|
function filterStream(testFunc) {
|
|
return es.through(function (data) {
|
|
if (!testFunc(data.relative)) {
|
|
return;
|
|
}
|
|
this.emit('data', data);
|
|
});
|
|
}
|
|
|
|
const finalEditorResourcesTask = task.define('final-editor-resources', () => {
|
|
return es.merge(
|
|
// other assets
|
|
es.merge(
|
|
gulp.src('build/monaco/LICENSE'),
|
|
gulp.src('build/monaco/ThirdPartyNotices.txt'),
|
|
gulp.src('src/vs/monaco.d.ts')
|
|
).pipe(gulp.dest('out-monaco-editor-core')),
|
|
|
|
// place the .d.ts in the esm folder
|
|
gulp.src('src/vs/monaco.d.ts')
|
|
.pipe(es.through(function (data) {
|
|
this.emit('data', new File({
|
|
path: data.path.replace(/monaco\.d\.ts/, 'editor.api.d.ts'),
|
|
base: data.base,
|
|
contents: Buffer.from(toExternalDTS(data.contents.toString()))
|
|
}));
|
|
}))
|
|
.pipe(gulp.dest('out-monaco-editor-core/esm/vs/editor')),
|
|
|
|
// package.json
|
|
gulp.src('build/monaco/package.json')
|
|
.pipe(es.through(function (data) {
|
|
const json = JSON.parse(data.contents.toString());
|
|
json.private = false;
|
|
data.contents = Buffer.from(JSON.stringify(json, null, ' '));
|
|
this.emit('data', data);
|
|
}))
|
|
.pipe(gulp.dest('out-monaco-editor-core')),
|
|
|
|
// version.txt
|
|
gulp.src('build/monaco/version.txt')
|
|
.pipe(es.through(function (data) {
|
|
data.contents = Buffer.from(`monaco-editor-core: https://github.com/microsoft/vscode/tree/${sha1}`);
|
|
this.emit('data', data);
|
|
}))
|
|
.pipe(gulp.dest('out-monaco-editor-core')),
|
|
|
|
// README.md
|
|
gulp.src('build/monaco/README-npm.md')
|
|
.pipe(es.through(function (data) {
|
|
this.emit('data', new File({
|
|
path: data.path.replace(/README-npm\.md/, 'README.md'),
|
|
base: data.base,
|
|
contents: data.contents
|
|
}));
|
|
}))
|
|
.pipe(gulp.dest('out-monaco-editor-core')),
|
|
|
|
// dev folder
|
|
es.merge(
|
|
gulp.src('out-editor/**/*')
|
|
).pipe(gulp.dest('out-monaco-editor-core/dev')),
|
|
|
|
// min folder
|
|
es.merge(
|
|
gulp.src('out-editor-min/**/*')
|
|
).pipe(filterStream(function (path) {
|
|
// no map files
|
|
return !/(\.js\.map$)|(nls\.metadata\.json$)|(bundleInfo\.json$)/.test(path);
|
|
})).pipe(es.through(function (data) {
|
|
// tweak the sourceMappingURL
|
|
if (!/\.js$/.test(data.path)) {
|
|
this.emit('data', data);
|
|
return;
|
|
}
|
|
|
|
const relativePathToMap = path.relative(path.join(data.relative), path.join('min-maps', data.relative + '.map'));
|
|
|
|
let strContents = data.contents.toString();
|
|
const newStr = '//# sourceMappingURL=' + relativePathToMap.replace(/\\/g, '/');
|
|
strContents = strContents.replace(/\/\/# sourceMappingURL=[^ ]+$/, newStr);
|
|
|
|
data.contents = Buffer.from(strContents);
|
|
this.emit('data', data);
|
|
})).pipe(gulp.dest('out-monaco-editor-core/min')),
|
|
|
|
// min-maps folder
|
|
es.merge(
|
|
gulp.src('out-editor-min/**/*')
|
|
).pipe(filterStream(function (path) {
|
|
// no map files
|
|
return /\.js\.map$/.test(path);
|
|
})).pipe(gulp.dest('out-monaco-editor-core/min-maps'))
|
|
);
|
|
});
|
|
|
|
gulp.task('extract-editor-src',
|
|
task.series(
|
|
util.rimraf('out-editor-src'),
|
|
extractEditorSrcTask
|
|
)
|
|
);
|
|
|
|
gulp.task('editor-distro',
|
|
task.series(
|
|
task.parallel(
|
|
util.rimraf('out-editor-src'),
|
|
util.rimraf('out-editor-build'),
|
|
util.rimraf('out-editor-esm'),
|
|
util.rimraf('out-monaco-editor-core'),
|
|
util.rimraf('out-editor'),
|
|
util.rimraf('out-editor-min')
|
|
),
|
|
extractEditorSrcTask,
|
|
task.parallel(
|
|
task.series(
|
|
compileEditorAMDTask,
|
|
optimizeEditorAMDTask,
|
|
minifyEditorAMDTask
|
|
),
|
|
task.series(
|
|
createESMSourcesAndResourcesTask,
|
|
compileEditorESMTask,
|
|
appendJSToESMImportsTask
|
|
)
|
|
),
|
|
finalEditorResourcesTask
|
|
)
|
|
);
|
|
|
|
const bundleEditorESMTask = task.define('editor-esm-bundle-webpack', () => {
|
|
const webpack = require('webpack');
|
|
const webpackGulp = require('webpack-stream');
|
|
|
|
const result = es.through();
|
|
|
|
const webpackConfigPath = path.join(root, 'build/monaco/monaco.webpack.config.js');
|
|
|
|
const webpackConfig = {
|
|
...require(webpackConfigPath),
|
|
...{ mode: 'production' }
|
|
};
|
|
|
|
const webpackDone = (err, stats) => {
|
|
if (err) {
|
|
result.emit('error', err);
|
|
return;
|
|
}
|
|
const { compilation } = stats;
|
|
if (compilation.errors.length > 0) {
|
|
result.emit('error', compilation.errors.join('\n'));
|
|
}
|
|
if (compilation.warnings.length > 0) {
|
|
result.emit('data', compilation.warnings.join('\n'));
|
|
}
|
|
};
|
|
|
|
return webpackGulp(webpackConfig, webpack, webpackDone)
|
|
.pipe(gulp.dest('out-editor-esm-bundle'));
|
|
});
|
|
|
|
gulp.task('editor-esm-bundle',
|
|
task.series(
|
|
task.parallel(
|
|
util.rimraf('out-editor-src'),
|
|
util.rimraf('out-editor-esm'),
|
|
util.rimraf('out-monaco-editor-core'),
|
|
util.rimraf('out-editor-esm-bundle'),
|
|
),
|
|
extractEditorSrcTask,
|
|
createESMSourcesAndResourcesTask,
|
|
compileEditorESMTask,
|
|
appendJSToESMImportsTask,
|
|
bundleEditorESMTask,
|
|
)
|
|
);
|
|
|
|
gulp.task('monacodts', task.define('monacodts', () => {
|
|
const result = monacoapi.execute();
|
|
fs.writeFileSync(result.filePath, result.content);
|
|
fs.writeFileSync(path.join(root, 'src/vs/editor/common/standalone/standaloneEnums.ts'), result.enums);
|
|
return Promise.resolve(true);
|
|
}));
|
|
|
|
//#region monaco type checking
|
|
|
|
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) {
|
|
args.push('-w');
|
|
}
|
|
const child = cp.spawn(`node`, args, {
|
|
cwd: path.join(__dirname, '..'),
|
|
// stdio: [null, 'pipe', 'inherit']
|
|
});
|
|
const errors = [];
|
|
const reporter = createReporter('monaco');
|
|
|
|
/** @type {NodeJS.ReadWriteStream | undefined} */
|
|
let report;
|
|
// eslint-disable-next-line no-control-regex
|
|
const magic = /[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g; // https://stackoverflow.com/questions/25245716/remove-all-ansi-colors-styles-from-strings
|
|
|
|
child.stdout.on('data', data => {
|
|
let str = String(data);
|
|
str = str.replace(magic, '').trim();
|
|
if (str.indexOf('Starting compilation') >= 0 || str.indexOf('File change detected') >= 0) {
|
|
errors.length = 0;
|
|
report = reporter.end(false);
|
|
|
|
} else if (str.indexOf('Compilation complete') >= 0) {
|
|
report.end();
|
|
|
|
} else if (str) {
|
|
const match = /(.*\(\d+,\d+\): )(.*: )(.*)/.exec(str);
|
|
if (match) {
|
|
// trying to massage the message so that it matches the gulp-tsb error messages
|
|
// e.g. src/vs/base/common/strings.ts(663,5): error TS2322: Type '1234' is not assignable to type 'string'.
|
|
const fullpath = path.join(root, match[1]);
|
|
const message = match[3];
|
|
reporter(fullpath + message);
|
|
} else {
|
|
reporter(str);
|
|
}
|
|
}
|
|
});
|
|
child.on('exit', resolve);
|
|
child.on('error', reject);
|
|
});
|
|
};
|
|
}
|
|
|
|
const monacoTypecheckWatchTask = task.define('monaco-typecheck-watch', createTscCompileTask(true));
|
|
exports.monacoTypecheckWatchTask = monacoTypecheckWatchTask;
|
|
|
|
const monacoTypecheckTask = task.define('monaco-typecheck', createTscCompileTask(false));
|
|
exports.monacoTypecheckTask = monacoTypecheckTask;
|
|
|
|
//#endregion
|