Skip to content
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.

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

Improve CLI output for compilation warnings #851

Merged
merged 1 commit into from
Sep 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/shiny-gifts-talk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'wmr': patch
---

Improve CLI output for compilation warnings
2 changes: 2 additions & 0 deletions packages/wmr/src/bundler.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import * as rollup from 'rollup';
import terser from './plugins/fast-minify.js';
import totalist from 'totalist';
import { getPlugins } from './lib/plugins.js';
import { onWarn } from './lib/output-utils.js';

/** @param {string} p */
const pathToPosix = p => p.split(sep).join(posix.sep);
Expand All @@ -23,6 +24,7 @@ export async function bundleProd(options) {

const bundle = await rollup.rollup({
input,
onwarn: onWarn,
perf: !!profile,
preserveEntrySignatures: 'allow-extension',
manualChunks: npmChunks ? extractNpmChunks : undefined,
Expand Down
2 changes: 2 additions & 0 deletions packages/wmr/src/lib/compile-single-module.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import * as rollup from 'rollup';
import wmrPlugin from '../plugins/wmr/plugin.js';
import htmPlugin from '../plugins/htm-plugin.js';
import sucrasePlugin from '../plugins/sucrase-plugin.js';
import { onWarn } from './output-utils.js';
// import localNpmPlugin from './plugins/local-npm-plugin.js';

// disabled for now
Expand Down Expand Up @@ -36,6 +37,7 @@ export const compileSingleModule = withCache(
// console.log('compiling ' + input);
const bundle = await rollup.rollup({
input,
onwarn: onWarn,
treeshake: false,
preserveModules: true,
// these should theroetically improve performance:
Expand Down
3 changes: 2 additions & 1 deletion packages/wmr/src/lib/npm-middleware.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import aliasPlugin from '../plugins/aliases-plugin.js';
import { getMimeType } from './mimetypes.js';
import nodeBuiltinsPlugin from '../plugins/node-builtins-plugin.js';
import * as kl from 'kolorist';
import { hasDebugFlag } from './output-utils.js';
import { hasDebugFlag, onWarn } from './output-utils.js';

/**
* Serve a "proxy module" that uses the WMR runtime to load CSS.
Expand Down Expand Up @@ -130,6 +130,7 @@ async function bundleNpmModule(mod, { source, alias, cwd }) {

const bundle = await rollup.rollup({
input: mod,
onwarn: onWarn,
// input: '\0entry',
cache: npmCache,
shimMissingExports: true,
Expand Down
40 changes: 40 additions & 0 deletions packages/wmr/src/lib/output-utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -232,3 +232,43 @@ export function formatBootMessage(message, addresses) {

return `${intro}${local}${network}\n`;
}

function formatWarnMessage(str) {
return str !== kl.stripColors(str) ? kl.yellow('(!) ') + str : kl.yellow('(!) ' + str);
}

/** @type {import('rollup').WarningHandlerWithDefault} */
export function onWarn(warning) {
if (typeof warning === 'string') {
// eslint-disable-next-line no-console
console.log(formatWarnMessage(warning));
return;
}

const { message, loc, frame } = warning;
let msg = formatWarnMessage(message) + '\n';

if (loc && loc.file) {
msg += `${kl.cyan(`${loc.file}:${loc.line}:${loc.column}`)}\n`;
}

// Reformat code frame to match our format
if (frame) {
const lines = frame.split('\n');
const max = Math.max(...lines.map(x => x.indexOf(':')).filter(x => x >= 0));

const reformatted = lines
.map(line => {
if (/\s+\^/.test(line)) {
return kl.red('> ') + ' '.repeat(max) + kl.dim(' |') + kl.red(line.slice(max + 1));
}

return line.replace(/^(\d+): /, (_, g) => ' ' + kl.dim(g) + kl.dim(' | '));
})
.join('\n');
msg += `${reformatted}\n`;
}

// eslint-disable-next-line no-console
console.log(msg);
}
2 changes: 2 additions & 0 deletions packages/wmr/src/plugins/worker-plugin.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import * as rollup from 'rollup';
import path from 'path';
import { getPlugins } from '../lib/plugins.js';
import * as kl from 'kolorist';
import { onWarn } from '../lib/output-utils.js';

/**
* @param {import("wmr").Options} options
Expand Down Expand Up @@ -51,6 +52,7 @@ export function workerPlugin(options) {
// See: https://bugzilla.mozilla.org/show_bug.cgi?id=1247687
const bundle = await rollup.rollup({
input: id,
onwarn: onWarn,
plugins: [
{
name: 'worker-meta',
Expand Down