Skip to content

esbuild: Move duplicated config into a shared file #526

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
OrkunTokdemir wants to merge 1 commit into
base: dev
Choose a base branch
from
+165 −368
Open

esbuild: Move duplicated config into a shared file #526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 133 additions & 0 deletions common/esbuild-config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
// Copyright (C) 2025 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only

import { exec } from 'child_process';

/** @type BuildOptions */
const baseConfig = {
bundle: true,
minify: process.env.NODE_ENV === 'production',
sourcemap: process.env.NODE_ENV !== 'production'
};

// Shared base for code that runs in a Node-based context (extension + tests).
/** @type BuildOptions */
const nodeBaseConfig = {
...baseConfig,
platform: 'node',
mainFields: ['module', 'main'],
tsconfig: './tsconfig.json',
format: 'cjs'
};

async function execCmd(command) {
return new Promise((resolve, reject) => {
exec(command, (error, stdout, stderr) => {
if (error) {
reject([error, stdout, stderr]);
return;
}
resolve(stdout);
});
});
}

async function typeCheck(incremental) {
const command = incremental
? 'npx tsc --incremental --noEmit'
: 'npx tsc --noEmit';
await execCmd(command).then(
(stdout) => {
if (stdout.length > 0) {
console.log(stdout);
}
},
([error, stdout, stderr]) => {
console.error(error.message);
if (stderr.length > 0) {
console.error(stderr);
}

if (stdout.length > 0) {
console.error(stdout);
}

process.exit(1);
}
);
}

/**
* Runs the type-check + esbuild build/watch/test pipeline shared by every Qt
* VS Code extension.
*
* `build` and `context` are injected by the caller: each extension bundles its
* own copy of esbuild in its local node_modules, and this module lives in the
* monorepo root where 'esbuild' cannot be resolved.
*
* @param {object} options
* @param {Function} options.build esbuild's `build`
* @param {Function} options.context esbuild's `context`
* @param {string[]} options.testEntryPoints entry points for the test build
* @param {string} [options.entryPoint] extension entry point
* (default './src/extension.ts')
* @param {BuildOptions[]} [options.extraConfigs] extra configs built and watched
* alongside the extension (e.g. webviews)
* @param {boolean} [options.incremental] pass --incremental to the type-check
* (default true)
*/
export async function runEsbuild({
build,
context,
testEntryPoints,
entryPoint = './src/extension.ts',
extraConfigs = [],
incremental = true
}) {
// Config for extension source code (to be run in a Node-based context)
/** @type BuildOptions */
const extensionConfig = {
...nodeBaseConfig,
entryPoints: [entryPoint],
outfile: './out/extension.js',
external: ['vscode']
};

// Config for extension test source code (to be run in a Node-based context)
/** @type BuildOptions */
const extensionTestConfig = {
...nodeBaseConfig,
entryPoints: testEntryPoints,
outdir: './out/test/',
external: ['vscode', './reporters/parallel-buffered', './worker.js']
};

await typeCheck(incremental);

const args = process.argv.slice(2);
try {
if (args.includes('--watch')) {
for (const config of [extensionConfig, ...extraConfigs]) {
const ctx = await context({ ...config });
await ctx.watch();
await ctx.dispose();
}
console.log('[watch] build finished');
} else if (args.includes('--test')) {
await build(extensionTestConfig);
console.log('[tests] build complete');
} else {
// Build extension and any extra (e.g. webview) code
for (const config of [extensionConfig, ...extraConfigs]) {
await build(config);
}
console.log('build complete');
}
} catch (err) {
process.stderr.write(
/** @type any */ (err)?.stderr ??
(err instanceof Error ? err.message : String(err))
);
process.exit(1);
}
}
100 changes: 8 additions & 92 deletions qt-core/esbuild.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,103 +1,19 @@
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only

import { exec } from 'child_process';
import { build, context } from 'esbuild';

/** @type BuildOptions */
const baseConfig = {
bundle: true,
minify: process.env.NODE_ENV === 'production',
sourcemap: process.env.NODE_ENV !== 'production'
};
import { runEsbuild } from '../common/esbuild-config.mjs';

// Config for extension source code (to be run in a Node-based context)
/** @type BuildOptions */
const extensionConfig = {
...baseConfig,
platform: 'node',
mainFields: ['module', 'main'],
tsconfig: './tsconfig.json',
format: 'cjs',
entryPoints: ['./src/extension.ts'],
outfile: './out/extension.js',
external: ['vscode']
};

// Config for extension test source code (to be run in a Node-based context)
/** @type BuildOptions */
const extensionTestConfig = {
...baseConfig,
platform: 'node',
mainFields: ['module', 'main'],
tsconfig: './tsconfig.json',
format: 'cjs',
entryPoints: [
await runEsbuild({
build,
context,
entryPoint: './src/extension.ts',
testEntryPoints: [
'./test/runTest.ts',
'./test/suite/index.ts',
'./test/helper.mts',
'./test/suite/extension.test.mts',
'./test/suite/commands.test.mts'
],
outdir: './out/test/',
external: ['vscode', './reporters/parallel-buffered', './worker.js']
};

async function execCmd(command) {
return new Promise((resolve, reject) => {
exec(command, (error, stdout, stderr) => {
if (error) {
reject([error, stdout, stderr]);
return;
}
resolve(stdout);
});
});
}

await execCmd('npx tsc --incremental --noEmit').then(
(stdout) => {
if (stdout.length > 0) {
console.log(stdout);
}
},
([error, stdout, stderr]) => {
console.error(error.message);
if (stderr.length > 0) {
console.error(stderr);
}

if (stdout.length > 0) {
console.error(stdout);
}

process.exit(1);
}
);

// Build script
(async () => {
const args = process.argv.slice(2);
try {
if (args.includes('--watch')) {
const extCtx = await context({
...extensionConfig
});
await extCtx.watch();
await extCtx.dispose();
console.log('[watch] build finished');
} else {
if (args.includes('--test')) {
await build(extensionTestConfig);
console.log('[tests] build complete');
} else {
// Build extension and webview code
await build(extensionConfig);
console.log('build complete');
}
}
} catch (err) {
process.stderr.write(err.stderr);
process.exit(1);
}
})();
]
});
102 changes: 8 additions & 94 deletions qt-cpp/esbuild.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,38 +1,15 @@
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only

import { exec } from 'child_process';
import { build, context } from 'esbuild';

/** @type BuildOptions */
const baseConfig = {
bundle: true,
minify: process.env.NODE_ENV === 'production',
sourcemap: process.env.NODE_ENV !== 'production'
};
import { runEsbuild } from '../common/esbuild-config.mjs';

// Config for extension source code (to be run in a Node-based context)
/** @type BuildOptions */
const extensionConfig = {
...baseConfig,
platform: 'node',
mainFields: ['module', 'main'],
tsconfig: './tsconfig.json',
format: 'cjs',
entryPoints: ['./src/extension.ts'],
outfile: './out/extension.js',
external: ['vscode']
};

// Config for extension test source code (to be run in a Node-based context)
/** @type BuildOptions */
const extensionTestConfig = {
...baseConfig,
platform: 'node',
mainFields: ['module', 'main'],
tsconfig: './tsconfig.json',
format: 'cjs',
entryPoints: [
await runEsbuild({
build,
context,
entryPoint: './src/extension.ts',
testEntryPoints: [
'./test/runTest.mts',
'./test/runTest.build.mts',
'./test/runTest.natvis.mts',
Expand All @@ -44,68 +21,5 @@ const extensionTestConfig = {
'./test/suite/commands.test.mts',
'./test/suite/build.test.mts',
'./test/suite/natvis.test.mts'
],
outdir: './out/test/',
external: ['vscode', './reporters/parallel-buffered', './worker.js']
};

async function execCmd(command) {
return new Promise((resolve, reject) => {
exec(command, (error, stdout, stderr) => {
if (error) {
reject([error, stdout, stderr]);
return;
}
resolve(stdout);
});
});
}

await execCmd('npx tsc --noEmit').then(
(stdout) => {
if (stdout.length > 0) {
console.log(stdout);
}
},
([error, stdout, stderr]) => {
console.error(error.message);
if (stderr.length > 0) {
console.error(stderr);
}

if (stdout.length > 0) {
console.error(stdout);
}

process.exit(1);
}
);

// Build script
(async () => {
const args = process.argv.slice(2);
try {
if (args.includes('--watch')) {
const extCtx = await context({
...extensionConfig
});
await extCtx.watch();
await extCtx.dispose();
console.log('[watch] build finished');
} else {
if (args.includes('--test')) {
await build(extensionTestConfig);
console.log('[tests] build complete');
} else {
await build(extensionConfig);
console.log('build complete');
}
}
} catch (err) {
process.stderr.write(
/** @type any */ (err)?.stderr ??
(err instanceof Error ? err.message : String(err))
);
process.exit(1);
}
})();
]
});
Loading
Loading