@parcel/diagnostic 2.0.0-dev.1528 → 2.0.0-dev.1557

package/lib/diagnostic.d.ts

@@ -37,6 +37,8 @@ export type DiagnosticCodeFrame = {
     language?: string;
     codeHighlights: Array<DiagnosticCodeHighlight>;
 };
+/** A JSON object (as in "map") */
+type JSONObject = Record<string, any>;
 /**
  * A style agnostic way of emitting errors, warnings and info.
  * Reporters are responsible for rendering the message, codeframes, hints, ...
@@ -58,6 +60,8 @@ export type Diagnostic = {
     skipFormatting?: boolean;
     /** A URL to documentation to learn more about the diagnostic. */
     documentationURL?: string;
+    /** Diagnostic specific metadata (optional) */
+    meta?: JSONObject;
 };
 export interface PrintableError extends Error {
     fileName?: string;

package/lib/diagnostic.js

@@ -45,6 +45,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * A code frame is a visualization of a piece of code with a certain amount of
  * code highlights that point to certain chunk(s) inside the code.
  */
+/** A JSON object (as in "map") */
 /**
  * A style agnostic way of emitting errors, warnings and info.
  * Reporters are responsible for rendering the message, codeframes, hints, ...
@@ -72,28 +73,24 @@ function anyToDiagnostic(input) {
 
 /** Normalize the given error into a diagnostic. */
 function errorToDiagnostic(error, defaultValues) {
-  var _defaultValues$origin2, _ref4, _error$highlightedCod;
   let codeFrames = undefined;
   if (typeof error === 'string') {
-    var _defaultValues$origin;
     return [{
-      origin: (_defaultValues$origin = defaultValues === null || defaultValues === void 0 ? void 0 : defaultValues.origin) !== null && _defaultValues$origin !== void 0 ? _defaultValues$origin : 'Error',
+      origin: (defaultValues === null || defaultValues === void 0 ? void 0 : defaultValues.origin) ?? 'Error',
       message: escapeMarkdown(error)
     }];
   }
   if (error instanceof ThrowableDiagnostic) {
     return error.diagnostics.map(d => {
-      var _ref, _d$origin;
       return {
         ...d,
-        origin: (_ref = (_d$origin = d.origin) !== null && _d$origin !== void 0 ? _d$origin : defaultValues === null || defaultValues === void 0 ? void 0 : defaultValues.origin) !== null && _ref !== void 0 ? _ref : 'unknown'
+        origin: d.origin ?? (defaultValues === null || defaultValues === void 0 ? void 0 : defaultValues.origin) ?? 'unknown'
       };
     });
   }
   if (error.loc && error.source != null) {
-    var _ref2, _ref3, _error$filePath;
     codeFrames = [{
-      filePath: (_ref2 = (_ref3 = (_error$filePath = error.filePath) !== null && _error$filePath !== void 0 ? _error$filePath : error.fileName) !== null && _ref3 !== void 0 ? _ref3 : defaultValues === null || defaultValues === void 0 ? void 0 : defaultValues.filePath) !== null && _ref2 !== void 0 ? _ref2 : undefined,
+      filePath: error.filePath ?? error.fileName ?? (defaultValues === null || defaultValues === void 0 ? void 0 : defaultValues.filePath) ?? undefined,
       code: error.source,
       codeHighlights: [{
         start: {
@@ -108,10 +105,10 @@ function errorToDiagnostic(error, defaultValues) {
     }];
   }
   return [{
-    origin: (_defaultValues$origin2 = defaultValues === null || defaultValues === void 0 ? void 0 : defaultValues.origin) !== null && _defaultValues$origin2 !== void 0 ? _defaultValues$origin2 : 'Error',
+    origin: (defaultValues === null || defaultValues === void 0 ? void 0 : defaultValues.origin) ?? 'Error',
     message: escapeMarkdown(error.message),
     name: error.name,
-    stack: codeFrames == null ? (_ref4 = (_error$highlightedCod = error.highlightedCodeFrame) !== null && _error$highlightedCod !== void 0 ? _error$highlightedCod : error.codeFrame) !== null && _ref4 !== void 0 ? _ref4 : error.stack : undefined,
+    stack: codeFrames == null ? error.highlightedCodeFrame ?? error.codeFrame ?? error.stack : undefined,
     codeFrames
   }];
 }
@@ -121,15 +118,14 @@ function errorToDiagnostic(error, defaultValues) {
  */
 class ThrowableDiagnostic extends Error {
   constructor(opts) {
-    var _diagnostics$0$stack, _diagnostics$0$name;
     let diagnostics = Array.isArray(opts.diagnostic) ? opts.diagnostic : [opts.diagnostic];
 
     // Construct error from diagnostics
     super(diagnostics[0].message);
     // @ts-ignore
-    this.stack = (_diagnostics$0$stack = diagnostics[0].stack) !== null && _diagnostics$0$stack !== void 0 ? _diagnostics$0$stack : super.stack;
+    this.stack = diagnostics[0].stack ?? super.stack;
     // @ts-ignore
-    this.name = (_diagnostics$0$name = diagnostics[0].name) !== null && _diagnostics$0$name !== void 0 ? _diagnostics$0$name : super.name;
+    this.name = diagnostics[0].name ?? super.name;
     this.diagnostics = diagnostics;
   }
 }
@@ -251,15 +247,14 @@ function md(strings, ...params) {
     let param = params[i];
     if (Array.isArray(param)) {
       for (let j = 0; j < param.length; j++) {
-        var _param$j$mdVerbatim, _param$j;
-        result.push((_param$j$mdVerbatim = (_param$j = param[j]) === null || _param$j === void 0 ? void 0 : _param$j[mdVerbatim]) !== null && _param$j$mdVerbatim !== void 0 ? _param$j$mdVerbatim : escapeMarkdown(`${param[j]}`));
+        var _param$j;
+        result.push(((_param$j = param[j]) === null || _param$j === void 0 ? void 0 : _param$j[mdVerbatim]) ?? escapeMarkdown(`${param[j]}`));
         if (j < param.length - 1) {
           result.push(', ');
         }
       }
     } else {
-      var _param$mdVerbatim;
-      result.push((_param$mdVerbatim = param === null || param === void 0 ? void 0 : param[mdVerbatim]) !== null && _param$mdVerbatim !== void 0 ? _param$mdVerbatim : escapeMarkdown(`${param}`));
+      result.push((param === null || param === void 0 ? void 0 : param[mdVerbatim]) ?? escapeMarkdown(`${param}`));
     }
   }
   return result.join('') + strings[strings.length - 1];

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@parcel/diagnostic",
-  "version": "2.0.0-dev.1528+70889ca07",
+  "version": "2.0.0-dev.1557+e87c13686",
+  "description": "Types and utilities for printing source-code located errors, warning and information messages.",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -17,7 +18,7 @@
   "source": "src/diagnostic.js",
   "types": "lib/diagnostic.d.ts",
   "engines": {
-    "node": ">= 12.0.0"
+    "node": ">= 16.0.0"
   },
   "scripts": {
     "build-ts": "flow-to-ts src/*.js --write && tsc --emitDeclarationOnly --declaration --esModuleInterop src/*.ts && mkdir -p lib && mv src/*.d.ts lib/. && rm src/*.ts",
@@ -27,5 +28,5 @@
     "@mischnic/json-sourcemap": "^0.1.0",
     "nullthrows": "^1.1.1"
   },
-  "gitHead": "70889ca07dccb95e21e4c6a2844d632e3723faf4"
+  "gitHead": "e87c13686e8fa4ad96cc61c19d9e4fcf9c372f2e"
 }

package/src/diagnostic.js

@@ -46,6 +46,12 @@ export type DiagnosticCodeFrame = {|
   codeHighlights: Array<DiagnosticCodeHighlight>,
 |};
 
+/** A JSON object (as in "map") */
+type JSONObject = {
+  // $FlowFixMe
+  [key: string]: any,
+};
+
 /**
  * A style agnostic way of emitting errors, warnings and info.
  * Reporters are responsible for rendering the message, codeframes, hints, ...
@@ -72,6 +78,9 @@ export type Diagnostic = {|
 
   /** A URL to documentation to learn more about the diagnostic. */
   documentationURL?: string,
+
+  /** Diagnostic specific metadata (optional) */
+  meta?: JSONObject,
 |};
 
 // This type should represent all error formats Parcel can encounter...