Skip to content

build: Add build step before generating the schema #7589

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

Merged
camdecoster merged 8 commits into from
Oct 20, 2025
Merged

build: Add build step before generating the schema #7589

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
fd910a1
Linting/formatting
camdecoster Oct 15, 2025
dbe27df
Move esbuild configs to one file, update references
camdecoster Oct 15, 2025
8c44130
Add build step to schema npm script
camdecoster Oct 15, 2025
c8818ec
Linting/formatting
camdecoster Oct 16, 2025
0ff3ebb
Move build step into schema script
camdecoster Oct 16, 2025
9b651a9
Add descriptions to esbuild configs
camdecoster Oct 20, 2025
b61a0b8
Fix repo URL
camdecoster Oct 20, 2025
570640c
Move reused code into new file
camdecoster Oct 20, 2025
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
Prev Previous commit
Next Next commit
Move esbuild configs to one file, update references
  • Loading branch information
@camdecoster
camdecoster committed Oct 15, 2025
commit dbe27dffa2d27025cc597d16d72741de4d928710
1 change: 1 addition & 0 deletions biome.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"files": {
"maxSize": 10000000,
"includes": [
"**/esbuild-config.js",
"**/src/**",
"**/lib/**",
"**/test/**",
Expand Down
7 changes: 1 addition & 6 deletions devtools/regl_codegen/server.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import minimist from 'minimist';

import constants from '../../tasks/util/constants.js';
import { build } from 'esbuild';
import config from '../../esbuild-config.js';
import { esbuildConfig as config } from '../../esbuild-config.js';

var args = minimist(process.argv.slice(2), {});
var PORT = args.port || 3000;
Expand Down Expand Up @@ -64,11 +64,6 @@ server.listen(PORT);
// open up browser window
open('http://localhost:' + PORT + '/devtools/regl_codegen/index' + (strict ? '-strict' : '') + '.html');

var devtoolsPath = path.join(constants.pathToRoot, 'devtools/regl_codegen');
config.entryPoints = [path.join(devtoolsPath, 'devtools.js')];
config.outfile = './build/regl_codegen-bundle.js';
config.sourcemap = false;
config.minify = false;
await build(config);

function getMockFiles() {
Expand Down
32 changes: 3 additions & 29 deletions devtools/test_dashboard/server.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,51 +7,25 @@ import minimist from 'minimist';

import constants from '../../tasks/util/constants.js';
import { context, build } from 'esbuild';
import config from '../../esbuild-config.js';

import { glsl } from 'esbuild-plugin-glsl';
import { devtoolsConfig, localDevConfig } from '../../esbuild-config.js';

var args = minimist(process.argv.slice(2), {});
var PORT = args.port || 3000;
var strict = args.strict;
var mathjax3 = args.mathjax3;
var mathjax3chtml = args.mathjax3chtml;

if (strict) {
config.entryPoints = ['./lib/index-strict.js'];
}

config.outfile = './build/plotly.js';
if (strict) localDevConfig.entryPoints = ['./lib/index-strict.js'];

var mockFolder = constants.pathToTestImageMocks;

// mock list
await getMockFiles().then(readFiles).then(createMocksList).then(saveMockListToFile);

// Devtools config
var devtoolsConfig = {
entryPoints: [path.join(constants.pathToRoot, 'devtools', 'test_dashboard', 'devtools.js')],
outfile: path.join(constants.pathToRoot, 'build', 'test_dashboard-bundle.js'),
format: 'cjs',
globalName: 'Tabs',
bundle: true,
minify: false,
sourcemap: false,
plugins: [
glsl({
minify: true
})
],
define: {
global: 'window'
},
target: 'es2016',
logLevel: 'info'
};

build(devtoolsConfig);

var ctx = await context(config);
var ctx = await context(localDevConfig);
devServer();
console.log('watching esbuild...');
await ctx.watch();
Expand Down
59 changes: 44 additions & 15 deletions esbuild-config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,59 @@
var glsl = require('esbuild-plugin-glsl').glsl;
var environmentPlugin = require('esbuild-plugin-environment').environmentPlugin;
const { environmentPlugin } = require('esbuild-plugin-environment');
const { glsl } = require('esbuild-plugin-glsl');
const InlineCSSPlugin = require('esbuild-plugin-inline-css');
const path = require('path');
const constants = require('./tasks/util/constants.js');

module.exports = {
// Default config used when building library
const esbuildConfig = {
entryPoints: ['./lib/index.js'],
format: 'iife',
globalName: 'Plotly',
bundle: true,
minify: false,
sourcemap: false,
plugins: [
InlineCSSPlugin(),
glsl({
minify: true,
}),
environmentPlugin({
NODE_DEBUG: false,
}),
],
plugins: [InlineCSSPlugin(), glsl({ minify: true }), environmentPlugin({ NODE_DEBUG: false })],
alias: {
stream: 'stream-browserify',
stream: 'stream-browserify'
},
define: {
global: 'window',
'define.amd': 'false',
'define.amd': 'false'
},
target: 'es2016',
logLevel: 'info',
logLevel: 'info'
};

const devtoolsConfig = {
Copy link
Contributor

@emilykl emilykl Oct 16, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@camdecoster Could you add a comment above each of these configs explaining what it's used for (to the extent that you know)?

Copy link
Contributor Author

@camdecoster camdecoster Oct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll come up with something, but the variable names were my attempt at a description.

entryPoints: [path.join(constants.pathToRoot, 'devtools', 'test_dashboard', 'devtools.js')],
outfile: path.join(constants.pathToRoot, 'build', 'test_dashboard-bundle.js'),
format: 'cjs',
globalName: 'Tabs',
bundle: true,
minify: false,
sourcemap: false,
plugins: [glsl({ minify: true })],
define: { global: 'window' },
target: 'es2016',
logLevel: 'info'
};

const localDevConfig = {
...esbuildConfig,
outfile: './build/plotly.js'
};

const localDevReglCodegenConfig = {
...esbuildConfig,
entryPoints: [path.join(constants.pathToRoot, 'devtools/regl_codegen', 'devtools.js')],
outfile: './build/regl_codegen-bundle.js',
sourcemap: false,
minify: false
};

module.exports = {
devtoolsConfig,
esbuildConfig,
localDevConfig,
localDevReglCodegenConfig,
};
2 changes: 1 addition & 1 deletion tasks/util/bundle_wrapper.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import prependFile from 'prepend-file';

import { build } from 'esbuild';

import esbuildConfig from '../../esbuild-config.js';
import { esbuildConfig } from '../../esbuild-config.js';
import esbuildPluginStripMeta from '../../tasks/compress_attributes.js';

import common from './common.js';
Expand Down
2 changes: 1 addition & 1 deletion test/jasmine/karma.conf.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
var path = require('path');
var minimist = require('minimist');
var constants = require('../../tasks/util/constants');
var esbuildConfig = require('../../esbuild-config.js');
const { esbuildConfig } = require('../../esbuild-config.js');

var isCI = Boolean(process.env.CI);

Expand Down