Skip to content

Commit

Permalink
👍🏼 improve: build performance (#2387)
Browse files Browse the repository at this point in the history
## Type of change

**PATCH: backwards compatible change**
  • Loading branch information
kellymears committed Jul 21, 2023
1 parent 96cb653 commit 9173aa7
Show file tree
Hide file tree
Showing 6 changed files with 86 additions and 73 deletions.
1 change: 1 addition & 0 deletions sources/@roots/bud-build/src/config/experiments.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ export const experiments: Factory<`experiments`> = async ({
}) =>
hooks.filter(`build.experiments`, {
backCompat: false,
cacheUnaffected: true,
lazyCompilation: isDevelopment
? {entries: false, imports: true}
: false,
Expand Down
2 changes: 1 addition & 1 deletion sources/@roots/bud-build/src/config/optimization.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export const optimization: Factory<`optimization`> = async ({
),
removeEmptyChunks: filter(
`build.optimization.removeEmptyChunks`,
isProduction,
false,
),
runtimeChunk: filter(`build.optimization.runtimeChunk`, `single`),
sideEffects: filter(`build.optimization.sideEffects`, isProduction),
Expand Down
6 changes: 5 additions & 1 deletion sources/@roots/bud-build/src/config/output/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,11 @@ export const output: Factory<`output`> = async ({
iife: filter(`build.output.iife`, undefined),
module: filter(`build.output.module`, false),
path: filter(`build.output.path`, path(`@dist`)),
pathinfo: filter(`build.output.pathinfo`, true),
/**
* Path info is not necessary unless the user
* really knows what's going on.
*/
pathinfo: filter(`build.output.pathinfo`, false),
publicPath: filter(`build.output.publicPath`, `auto`),
scriptType: filter(
`build.output.scriptType`,
Expand Down
118 changes: 62 additions & 56 deletions sources/@roots/bud-compiler/src/service.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ import {bind} from '@roots/bud-support/decorators/bind'
import {BudError, type BudErrorClass} from '@roots/bud-support/errors'
import {duration} from '@roots/bud-support/human-readable'
import {render} from '@roots/bud-support/ink'
import isNull from '@roots/bud-support/lodash/isNull'
import isString from '@roots/bud-support/lodash/isString'
import stripAnsi from '@roots/bud-support/strip-ansi'
import webpack from '@roots/bud-support/webpack'

Expand Down Expand Up @@ -210,63 +212,71 @@ export class Compiler extends Service implements BudCompiler {
if (!errors || !errors.length) return []

try {
const parseError = (
error: StatsError,
): ErrorWithSourceFile | StatsError => {
let file: SourceFile[`file`] | undefined

const moduleIdent = error.moduleId ?? error.moduleName

/**
* In a perfect world webpack plugins would use the
* `nameForCondition` property to identify the module.
*/
let module = this.compilationStats.children
.flatMap(child => child?.modules)
.find(
module =>
module?.id === moduleIdent || module?.name === moduleIdent,
)

/**
* If the module is not found, we try to parse the error message
*/
if (!moduleIdent) {
const stylelintExtracted = error.message.match(
/file:\/\/(.*)\x07(.*)\x1B]8;;/,
)

if (stylelintExtracted?.[1]) {
module = {
name: stylelintExtracted[2] ?? stylelintExtracted[1],
nameForCondition: stylelintExtracted[1],
}
return errors
?.map((error: StatsError): ErrorWithSourceFile | StatsError => {
let file: SourceFile[`file`] | undefined
let module: undefined | Webpack.StatsModule

const ident = error.moduleId ?? error.moduleName

/**
* In a perfect world webpack plugins would use the
* `nameForCondition` property to identify the module.
*/
if (ident) {
module = this.compilationStats.children
.flatMap(child => child?.modules)
.find(module => [module?.id, module?.name].includes(ident))
}
}

/**
* If the module is still not found, we return the error as-is
*/
if (!module) return error

/**
* We'll prefer the `nameForCondition` property if it exists,
* otherwise we'll use the `name` property.
*/
if (module.nameForCondition) {
file = module.nameForCondition
} else if (module.name) {
file = this.app.path(`@src`, module.name)
}
/**
* If the module is not found, we try to parse the error message
*/
if (!ident && error.message?.includes(`[stylelint]`)) {
// try to get the origin of the stylelint error,
// which is contained in the second line of the error message
const unparsedOrigin = error.message?.split(`\n`)?.[1]

// if the origin is not a string or too long, we return the error as-is
if (!isString(unparsedOrigin) || unparsedOrigin.length > 100)
return error

// extract absolute path and context relative name of module
const styleError = unparsedOrigin.match(
/file:\/\/(.*)\x07(.*)\x1B]8;;/,
)
if (isNull(styleError)) return error

// get parts of matched error
const [, file, name] = styleError
// return enriched error
return {...error, file, name, nameForCondition: file}
}

return !file
? {...error, name: module.name ?? error.name}
: {...error, file, name: module.name ?? error.name}
}
/**
* If the module is still not found, we return the error as-is
*/
if (!module) return error

/**
* We'll prefer the `nameForCondition` property if it exists,
* otherwise we'll use the `name` property.
*/
if (module.nameForCondition) {
file = module.nameForCondition
} else if (module.name) {
file = this.app.path(`@src`, module.name)
}

return errors?.map(parseError).filter(Boolean)
const name = module.name ?? error.name ?? `error`
return {...error, file, name}
})
.filter(Boolean)
} catch (error) {
this.logger.warn(`error parsing errors`, error)
this.logger.warn(
`Problem parsing errors. This probably won't break anything but please report it: https://github.com/roots/bud/issues/new`,
error,
)
return errors
}
}
Expand All @@ -281,16 +291,12 @@ const statsOptions = {
cachedAssets: true,
cachedModules: true,
entrypoints: true,
errorDetails: false,
errors: true,
errorsCount: true,
errorStack: false,
hash: true,
modules: true,
name: true,
outputPath: true,
reasons: false,
runtime: true,
timings: true,
warnings: true,
warningsCount: true,
Expand Down
26 changes: 14 additions & 12 deletions sources/@roots/bud-framework/src/notifier.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import isEmpty from '@roots/bud-support/lodash/isEmpty'
import isString from '@roots/bud-support/lodash/isString'
import logger from '@roots/bud-support/logger'
import {open, openEditor} from '@roots/bud-support/open'
import chalk from 'chalk'

const notifierPath = resolve(
dirname(fileURLToPath(import.meta.url)),
Expand Down Expand Up @@ -173,7 +174,6 @@ export class Notifier {
*/
public openEditor(input: Array<string> | string) {
if (!this.openEditorEnabled) return

if (!input || isEmpty(input)) return

logger.scope(`notifier`, `openEditor`).log(`input received`, input)
Expand All @@ -193,21 +193,23 @@ export class Notifier {
* True if editor opening is enabled
*/
public get openEditorEnabled(): boolean {
if (!this.editor) {
const enabled =
this.app.context.editor === true || // if true, fall back to default behavior
typeof this.app.context.editor === `string` // if string, opens in that editor

if (enabled && !this.editor) {
logger
.scope(`notifier`, `editor check`)
.warn(
`Editor not set.`,
`\n\nYou should set an editor using any of the following env vars:\n`,
`\n - BUD_EDITOR (bud specific; preferred)`,
`\n - VISUAL (unix standard)`,
`\n - EDITOR (unix standard)`,
`\n\nAlternatively, use the --editor flag.`,
chalk.magenta(`\n\nEditor not defined.`),
`\n\nYou should set an editor using any of the following ENV variables:\n`,
`\n - ${chalk.blue(`BUD_EDITOR`)} (bud specific; preferred)`,
`\n - ${chalk.blue(`VISUAL`)} (unix standard)`,
`\n - ${chalk.blue(`EDITOR`)} (unix standard)`,
`\n\nAlternatively, use the ${chalk.blue(`--editor`)} flag.`,
)
}
return (
this.app.context.editor === true || // if true, fall back to default behavior
typeof this.app.context.editor === `string` // if string, opens in that editor
)

return enabled
}
}
6 changes: 3 additions & 3 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -15302,9 +15302,9 @@ __metadata:
linkType: hard

"caniuse-lite@npm:^1.0.0, caniuse-lite@npm:^1.0.30001464, caniuse-lite@npm:^1.0.30001503":
version: 1.0.30001516
resolution: "caniuse-lite@npm:1.0.30001516"
checksum: 044adf3493b734a356a2922445a30095a0f6de6b9194695cdf74deafe7bef658e85858a31177762c2813f6e1ed2722d832d59eee0ecb2151e93a611ee18cb21f
version: 1.0.30001517
resolution: "caniuse-lite@npm:1.0.30001517"
checksum: e4e87436ae1c4408cf4438aac22902b31eb03f3f5bad7f33bc518d12ffb35f3fd9395ccf7efc608ee046f90ce324ec6f7f26f8a8172b8c43c26a06ecee612a29
languageName: node
linkType: hard

Expand Down

0 comments on commit 9173aa7

Please sign in to comment.