Skip to content

Commit

Permalink
fix: warning and error serialization
Browse files Browse the repository at this point in the history
  • Loading branch information
alexander-akait authored May 26, 2023
1 parent a98d7d0 commit 65748ec
Show file tree
Hide file tree
Showing 6 changed files with 120 additions and 117 deletions.
39 changes: 0 additions & 39 deletions src/Error.js

This file was deleted.

32 changes: 0 additions & 32 deletions src/Warning.js

This file was deleted.

22 changes: 15 additions & 7 deletions src/index.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
import path from "path";

import { satisfies } from "semver";
import postcssPackage from "postcss/package.json";

import Warning from "./Warning";
import schema from "./options.json";
import {
loadConfig,
Expand All @@ -14,6 +12,7 @@ import {
findPackageJSONDir,
getPostcssImplementation,
reportError,
warningFactory,
} from "./utils";

let hasExplicitDependencyOnPostCSS = false;
Expand All @@ -40,9 +39,17 @@ export default async function loader(content, sourceMap, meta) {
? true
: options.postcssOptions.config;

const postcssFactory = getPostcssImplementation(this, options.implementation);
let implementation;

if (!postcssFactory) {
try {
implementation = getPostcssImplementation(this, options.implementation);
} catch (error) {
callback(error);

return;
}

if (!implementation) {
callback(
new Error(
`The Postcss implementation "${options.implementation}" not found`
Expand Down Expand Up @@ -98,7 +105,8 @@ export default async function loader(content, sourceMap, meta) {
meta &&
meta.ast &&
meta.ast.type === "postcss" &&
satisfies(meta.ast.version, `^${postcssPackage.version}`)
// eslint-disable-next-line global-require
require("semver").satisfies(meta.ast.version, `^${postcssPackage.version}`)
) {
({ root } = meta.ast);
}
Expand All @@ -112,7 +120,7 @@ export default async function loader(content, sourceMap, meta) {
let processor;

try {
processor = postcssFactory(plugins);
processor = implementation(plugins);
result = await processor.process(root || content, processOptions);
} catch (error) {
// Check postcss versions to avoid using PostCSS 7.
Expand Down Expand Up @@ -175,7 +183,7 @@ export default async function loader(content, sourceMap, meta) {
}

for (const warning of result.warnings()) {
this.emitWarning(new Warning(warning));
this.emitWarning(warningFactory(warning));
}

for (const message of result.messages) {
Expand Down
67 changes: 55 additions & 12 deletions src/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ import Module from "module";
import { klona } from "klona/full";
import { cosmiconfig, defaultLoaders } from "cosmiconfig";

import SyntaxError from "./Error";

const parentModule = module;

const stat = (inputFileSystem, filePath) =>
Expand Down Expand Up @@ -541,15 +539,8 @@ function getPostcssImplementation(loaderContext, implementation) {
if (!implementation || typeof implementation === "string") {
const postcssImplPkg = implementation || "postcss";

try {
// eslint-disable-next-line import/no-dynamic-require, global-require
resolvedImplementation = require(postcssImplPkg);
} catch (error) {
loaderContext.emitError(error);

// eslint-disable-next-line consistent-return
return;
}
// eslint-disable-next-line import/no-dynamic-require, global-require
resolvedImplementation = require(postcssImplPkg);
}

// eslint-disable-next-line consistent-return
Expand All @@ -562,12 +553,63 @@ function reportError(loaderContext, callback, error) {
}

if (error.name === "CssSyntaxError") {
callback(new SyntaxError(error));
callback(syntaxErrorFactory(error));
} else {
callback(error);
}
}

function warningFactory(obj) {
let message = "";

if (typeof obj.line !== "undefined") {
message += `(${obj.line}:${obj.column}) `;
}

if (typeof obj.plugin !== "undefined") {
message += `from "${obj.plugin}" plugin: `;
}

message += obj.text;

if (obj.node) {
message += `\n\nCode:\n ${obj.node.toString()}\n`;
}

const warning = new Error(message);

warning.stack = null;

return warning;
}

function syntaxErrorFactory(obj) {
let message = "\nSyntaxError\n\n";

if (typeof obj.line !== "undefined") {
message += `(${obj.line}:${obj.column}) `;
}

if (typeof obj.plugin !== "undefined") {
message += `from "${obj.plugin}" plugin: `;
}

message += obj.file ? `${obj.file} ` : "<css input> ";
message += `${obj.reason}`;

const code = obj.showSourceCode();

if (code) {
message += `\n\n${code}\n`;
}

const error = new Error(message);

error.stack = null;

return error;
}

export {
loadConfig,
getPostcssOptions,
Expand All @@ -577,4 +619,5 @@ export {
findPackageJSONDir,
getPostcssImplementation,
reportError,
warningFactory,
};
4 changes: 1 addition & 3 deletions test/__snapshots__/implementation.test.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@
exports[`"implementation" option should throw error when unresolved package: errors 1`] = `
[
"ModuleBuildError: Module build failed (from \`replaced original path\`):
Error: The Postcss implementation "unresolved" not found",
"ModuleError: Module Error (from \`replaced original path\`):
(Emitted value instead of an instance of Error) Error: Cannot find module 'unresolved' from 'src/utils.js'",
NonErrorEmittedError: (Emitted value instead of an instance of Error) Error: Cannot find module 'unresolved' from 'src/utils.js'",
]
`;

Expand Down
73 changes: 49 additions & 24 deletions test/__snapshots__/loader.test.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -106,53 +106,77 @@ exports[`loader should emit warning using the "messages" API: errors 1`] = `[]`;
exports[`loader should emit warning using the "messages" API: warnings 1`] = `
[
"ModuleWarning: Module Warning (from \`replaced original path\`):
Warning
(10:3) from "postcss-plugin" plugin: <Message>
(10:3) postcss-plugin: <Message>",
Code:
color: green
",
"ModuleWarning: Module Warning (from \`replaced original path\`):
Warning
(14:3) from "postcss-plugin" plugin: <Message>
(14:3) postcss-plugin: <Message>",
Code:
color: blue
",
"ModuleWarning: Module Warning (from \`replaced original path\`):
Warning
(18:3) from "postcss-plugin" plugin: <Message>
(18:3) postcss-plugin: <Message>",
Code:
-x-border-color: blue blue *
",
"ModuleWarning: Module Warning (from \`replaced original path\`):
Warning
(19:3) from "postcss-plugin" plugin: <Message>
(19:3) postcss-plugin: <Message>",
Code:
-x-color: * #fafafa
",
"ModuleWarning: Module Warning (from \`replaced original path\`):
Warning
(23:3) from "postcss-plugin" plugin: <Message>
(23:3) postcss-plugin: <Message>",
Code:
-z-border-color: blue blue *
",
"ModuleWarning: Module Warning (from \`replaced original path\`):
Warning
(24:3) from "postcss-plugin" plugin: <Message>
(24:3) postcss-plugin: <Message>",
Code:
-z-color: * #fafafa
",
"ModuleWarning: Module Warning (from \`replaced original path\`):
Warning
(29:5) from "postcss-plugin" plugin: <Message>
(29:5) postcss-plugin: <Message>",
Code:
width: 500px
",
"ModuleWarning: Module Warning (from \`replaced original path\`):
Warning
(2:3) from "postcss-plugin" plugin: <Message>
(2:3) postcss-plugin: <Message>",
Code:
color: black
",
"ModuleWarning: Module Warning (from \`replaced original path\`):
Warning
(32:7) from "postcss-plugin" plugin: <Message>
(32:7) postcss-plugin: <Message>",
Code:
width: auto
",
"ModuleWarning: Module Warning (from \`replaced original path\`):
Warning
(36:7) from "postcss-plugin" plugin: <Message>
(36:7) postcss-plugin: <Message>",
Code:
color: white
",
"ModuleWarning: Module Warning (from \`replaced original path\`):
Warning
(41:5) from "postcss-plugin" plugin: <Message>
(41:5) postcss-plugin: <Message>",
Code:
display: block
",
"ModuleWarning: Module Warning (from \`replaced original path\`):
Warning
(6:3) from "postcss-plugin" plugin: <Message>
(6:3) postcss-plugin: <Message>",
Code:
color: red
",
]
`;
Expand Down Expand Up @@ -214,6 +238,7 @@ exports[`loader should reuse PostCSS AST: warnings 1`] = `[]`;
exports[`loader should throw an error on invalid syntax: errors 1`] = `
[
"ModuleBuildError: Module build failed (from \`replaced original path\`):
SyntaxError
(1:3) /test/fixtures/css/style.css Unnecessary curly bracket
Expand Down

0 comments on commit 65748ec

Please sign in to comment.