Skip to content

build: simplify and put timers into the bootstrap script #2565

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
matyasf merged 1 commit into from
Jun 5, 2026
Merged

build: simplify and put timers into the bootstrap script #2565

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
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
"packages/*"
],
"scripts": {
"build:themes": "ui-scripts build-themes",
"prestart": "pnpm run bootstrap",
"start": "pnpm --filter docs-app start",
"start:watch": "pnpm --filter docs-app start:watch",
Expand All @@ -30,6 +29,7 @@
"build": "pnpm -r --stream build",
"build:watch": "pnpm -r --stream build:watch",
"build:docs": "pnpm --filter docs-app bundle",
"build:themes": "ui-scripts build-themes",
"build:tokens": "ui-scripts generate-all-tokens",
"build:types": "tsc -b tsconfig.references.json",
"build:ts": "pnpm --filter @instructure/ui-icons prepare-build && pnpm run build:types",
Expand Down
2 changes: 0 additions & 2 deletions packages/__docs__/globals.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,7 @@ import { LoremIpsum } from 'lorem-ipsum'
import moment from 'moment'
// @ts-expect-error no type declarations for moment locales side-effect import
import 'moment/min/locales'

import { mirrorHorizontalPlacement } from '@instructure/ui-position'

import { getComponentsForVersion } from './versioned-components'
import { dark, light } from '@instructure/ui-themes'
import { debounce } from '@instructure/debounce'
Expand Down
2 changes: 1 addition & 1 deletion packages/ui-table/src/Table/__tests__/Table.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ describe('<Table />', async () => {
<Table.Body>
test
<span>test</span>
{/* @ts-ignore error is normal here */}
{/* @ts-expect-error error is normal here */}
<Table.Row>
test
<span>test</span>
Expand Down
10 changes: 4 additions & 6 deletions regression-test/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

120 changes: 62 additions & 58 deletions scripts/bootstrap.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,71 +23,75 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
const { execSync, fork } = require('child_process')
const { execSync } = require('child_process')
const path = require('path')

const opts = { stdio: 'inherit' }
function buildProject() {
console.info('Fetching design tokens...')
try {
execSync(
'pnpm --filter @instructure/ui-scripts update @instructure/instructure-design-tokens',
opts
)
} catch (error) {
Comment on lines -32 to -37

@matyasf matyasf May 27, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

these try..catch blocks were not needed, this script exits already if there is an error

console.error(
"'pnpm --filter @instructure/ui-scripts update @instructure/instructure-design-tokens' failed",
error
)
process.exit(1)
}

console.info('Building themes...')
try {
execSync('pnpm run build:themes', opts)
} catch (error) {
console.error("'pnpm run build:themes' failed", error)
process.exit(1)
}
function format(ms) {
return `${(ms / 1000).toFixed(1)}s`
}

execSync('pnpm --filter @instructure/ui-icons prepare-build', opts)

// Executes a ui-codemods script to generate a versioned components list
// from the ui metapackage's latest re-export file. This is required for
// the updateInstUIImportVersions codemod's diagnose mode.
execSync(
'pnpm --filter @instructure/ui-codemods generate:versioned-exports',
opts
)

console.info('Building packages with Babel...')
try {
execSync('pnpm run build', opts)
} catch (error) {
console.error("'pnpm run build' failed", error)
process.exit(1)
function mark(name) {
console.log(`\n================================================`)
console.log(`${name}...`)
if (steps.length) {
steps[steps.length - 1].duration =
Date.now() - steps[steps.length - 1].start
}
steps.push({ name, start: Date.now(), duration: 0 })
}

console.info('Generating tokens...')
try {
execSync('pnpm run build:tokens', opts)
} catch (error) {
console.error("'pnpm run build:tokens' failed", error)
process.exit(1)
}
const steps = []
const bootstrapStart = Date.now()

console.info('Building TypeScript declarations...')
try {
execSync('pnpm run build:types', opts)
} catch (error) {
console.error("'pnpm run build:types' failed", error)
process.exit(1)
}
}
mark('Deleting build artifacts')
execSync(path.resolve('scripts/clean.js'), opts)

Check warning

Code scanning / CodeQL

Shell command built from environment values Medium

This shell command depends on an uncontrolled
absolute path
Loading
.

function bootstrap() {
execSync(path.resolve('scripts/clean.js'), opts)
buildProject()
}
mark('Fetching design tokens')
execSync(
'pnpm --filter @instructure/ui-scripts update @instructure/instructure-design-tokens',
opts
)

mark('Building themes')
execSync('pnpm run build:themes', opts)

bootstrap()
mark('Preparing icons')
execSync('pnpm --filter @instructure/ui-icons prepare-build', opts)

mark('Generating package list for codemods')
execSync(
'pnpm --filter @instructure/ui-codemods generate:versioned-exports',
opts
)

mark('Building packages with Babel')
execSync('pnpm run build', opts)

mark('Generating design tokens')
execSync('pnpm run build:tokens', opts)

mark('Building TypeScript declarations')
execSync('pnpm run build:types', opts)

// Log build time summary. Assumes that the build is not parallel
steps[steps.length - 1].duration = Date.now() - steps[steps.length - 1].start

const total = Date.now() - bootstrapStart
const nameW = Math.max(...steps.map((s) => s.name.length))
const durW = Math.max(
...steps.map((s) => format(s.duration).length),
format(total).length
)
const tableWidth = nameW + durW + 7

console.log('\n' + '='.repeat(tableWidth))
console.log(' Bootstrap Summary')
console.log('='.repeat(tableWidth))
for (const s of steps) {
console.log(` ${s.name.padEnd(nameW)} ${format(s.duration).padStart(durW)}`)
}
console.log('-'.repeat(tableWidth))
console.log(` ${'Total'.padEnd(nameW)} ${format(total).padStart(durW)}`)
console.log('='.repeat(tableWidth))
12 changes: 5 additions & 7 deletions scripts/clean.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,10 @@ const path = require('path')
const { execSync } = require('child_process')

const NODE_PACKAGES = [
'ui-icons-build',
'ui-babel-preset',
'ui-codemods',
'ui-scripts',
'command-utils',
'instui-cli',
'babel-plugin-transform-imports',
'pkg-utils'
]
Expand Down Expand Up @@ -61,7 +59,7 @@ async function deleteDirs(dirs = []) {
)
}

// deletes built files from tooling packages (NODE_PACKAGES const)
// deletes build artifacts from all packages
async function clean() {
const packagesPath = path.resolve('./packages')
const packageDirs = await fs.readdir(packagesPath, { withFileTypes: true })
Expand All @@ -88,7 +86,7 @@ async function clean() {
function removeNodeModules() {
try {
// Use native find command - 10-100x faster than Node.js recursive scan
console.error('Finding node_modules directories...')
console.info('Finding node_modules directories...')
execSync(
'find . -name "node_modules" -type d -prune -exec rm -rf {} + 2>/dev/null || true',
{ stdio: 'inherit' }
Expand All @@ -100,17 +98,17 @@ function removeNodeModules() {
}

async function main() {
console.error('Deleting built files from tooling packages...')
console.info('Deleting build artifacts...')
await clean()

const args = process.argv.slice(2)
if (args.length > 0 && args[0] === '--nuke_node') {
console.error('Deleting node_modules recursively...')
console.info('Deleting node_modules recursively...')
removeNodeModules()
}
}

main().catch((error) => {
console.error('Clean script failed:', error)
console.info('clean.js failed:', error)
process.exit(1)
})
Loading