@parcel/diagnostic 2.8.3 → 2.9.0

package/lib/diagnostic.d.ts

@@ -113,10 +113,33 @@ export declare function generateJSONCodeHighlights(data: string | {
  * Converts entries in <a href="https://github.com/mischnic/json-sourcemap">@mischnic/json-sourcemap</a>'s
  * <code>result.pointers</code> array.
  */
-export declare function getJSONSourceLocation(pos: Mapping, type?: ("key" | null | undefined) | "value"): {
+export declare function getJSONHighlightLocation(pos: Mapping, type?: ("key" | null | undefined) | "value"): {
     start: DiagnosticHighlightLocation;
     end: DiagnosticHighlightLocation;
 };
+/** Result is 1-based, but end is exclusive */
+export declare function getJSONSourceLocation(pos: Mapping, type?: ("key" | null | undefined) | "value"): {
+    start: {
+        readonly line: number;
+        readonly column: number;
+    };
+    end: {
+        readonly line: number;
+        readonly column: number;
+    };
+};
+export declare function convertSourceLocationToHighlight<Location extends {
+    /** 1-based, inclusive */
+    readonly start: {
+        readonly line: number;
+        readonly column: number;
+    };
+    /** 1-based, exclusive */
+    readonly end: {
+        readonly line: number;
+        readonly column: number;
+    };
+}>({ start, end }: Location, message?: string): DiagnosticCodeHighlight;
 /** Sanitizes object keys before using them as <code>key</code> in generateJSONCodeHighlights */
 export declare function encodeJSONKeyComponent(component: string): string;
 export declare function escapeMarkdown(s: string): string;

package/lib/diagnostic.js

@@ -4,46 +4,53 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.anyToDiagnostic = anyToDiagnostic;
+exports.convertSourceLocationToHighlight = convertSourceLocationToHighlight;
 exports.default = void 0;
 exports.encodeJSONKeyComponent = encodeJSONKeyComponent;
 exports.errorToDiagnostic = errorToDiagnostic;
 exports.escapeMarkdown = escapeMarkdown;
 exports.generateJSONCodeHighlights = generateJSONCodeHighlights;
+exports.getJSONHighlightLocation = getJSONHighlightLocation;
 exports.getJSONSourceLocation = getJSONSourceLocation;
 exports.md = md;
-
 function _assert() {
   const data = _interopRequireDefault(require("assert"));
-
   _assert = function () {
     return data;
   };
-
   return data;
 }
-
 function _nullthrows() {
   const data = _interopRequireDefault(require("nullthrows"));
-
   _nullthrows = function () {
     return data;
   };
-
   return data;
 }
-
 function _jsonSourcemap() {
   const data = require("@mischnic/json-sourcemap");
-
   _jsonSourcemap = function () {
     return data;
   };
-
   return data;
 }
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
+/** These positions are 1-based (so <code>1</code> is the first line/column) */
+/**
+ * Note: A tab character is always counted as a single character
+ * This is to prevent any mismatch of highlighting across machines
+ */
+/**
+ * Describes how to format a code frame.
+ * 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 style agnostic way of emitting errors, warnings and info.
+ * Reporters are responsible for rendering the message, codeframes, hints, ...
+ */
+// This type should represent all error formats Parcel can encounter...
+/** Something that can be turned into a diagnostic. */
 /** Normalize the given value into a diagnostic. */
 function anyToDiagnostic(input) {
   if (Array.isArray(input)) {
@@ -62,36 +69,29 @@ function anyToDiagnostic(input) {
     return errorToDiagnostic(input);
   }
 }
-/** Normalize the given error into a diagnostic. */
-
 
+/** 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',
       message: escapeMarkdown(error)
     }];
   }
-
   if (error instanceof ThrowableDiagnostic) {
     return error.diagnostics.map(d => {
       var _ref, _d$origin;
-
-      return { ...d,
+      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'
       };
     });
   }
-
   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,
       code: error.source,
@@ -107,7 +107,6 @@ 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',
     message: escapeMarkdown(error.message),
@@ -116,7 +115,6 @@ function errorToDiagnostic(error, defaultValues) {
     codeFrames
   }];
 }
-
 /**
  * An error wrapper around a diagnostic that can be <code>throw</code>n (e.g. to signal a
  * build error).
@@ -124,18 +122,18 @@ 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];
 
-    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; // @ts-ignore
-
+    // 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;
+    // @ts-ignore
     this.name = (_diagnostics$0$name = diagnostics[0].name) !== null && _diagnostics$0$name !== void 0 ? _diagnostics$0$name : super.name;
     this.diagnostics = diagnostics;
   }
-
 }
+
 /**
  * Turns a list of positions in a JSON5 file with messages into a list of diagnostics.
  * Uses <a href="https://github.com/mischnic/json-sourcemap">@mischnic/json-sourcemap</a>.
@@ -144,10 +142,7 @@ class ThrowableDiagnostic extends Error {
  * @param ids A list of JSON keypaths (<code>key: "/some/parent/child"</code>) with corresponding messages, \
  * <code>type</code> signifies whether the key of the value in a JSON object should be highlighted.
  */
-
-
 exports.default = ThrowableDiagnostic;
-
 function generateJSONCodeHighlights(data, ids) {
   let map = typeof data == 'string' ? (0, _jsonSourcemap().parse)(data, undefined, {
     dialect: 'JSON5',
@@ -159,21 +154,20 @@ function generateJSONCodeHighlights(data, ids) {
     message
   }) => {
     let pos = (0, _nullthrows().default)(map.pointers[key]);
-    return { ...getJSONSourceLocation(pos, type),
+    return {
+      ...getJSONHighlightLocation(pos, type),
       message
     };
   });
 }
+
 /**
  * Converts entries in <a href="https://github.com/mischnic/json-sourcemap">@mischnic/json-sourcemap</a>'s
  * <code>result.pointers</code> array.
  */
-
-
-function getJSONSourceLocation(pos, type) {
+function getJSONHighlightLocation(pos, type) {
   let key = 'key' in pos ? pos.key : undefined;
   let keyEnd = 'keyEnd' in pos ? pos.keyEnd : undefined;
-
   if (!type && key && pos.value) {
     // key and value
     return {
@@ -211,75 +205,83 @@ function getJSONSourceLocation(pos, type) {
     };
   }
 }
-/** Sanitizes object keys before using them as <code>key</code> in generateJSONCodeHighlights */
 
+/** Result is 1-based, but end is exclusive */
+function getJSONSourceLocation(pos, type) {
+  let v = getJSONHighlightLocation(pos, type);
+  return {
+    start: v.start,
+    end: {
+      line: v.end.line,
+      column: v.end.column + 1
+    }
+  };
+}
+function convertSourceLocationToHighlight({
+  start,
+  end
+}, message) {
+  return {
+    message,
+    start,
+    end: {
+      line: end.line,
+      column: end.column - 1
+    }
+  };
+}
 
+/** Sanitizes object keys before using them as <code>key</code> in generateJSONCodeHighlights */
 function encodeJSONKeyComponent(component) {
   return component.replace(/~/g, '~0').replace(/\//g, '~1');
 }
-
 const escapeCharacters = ['\\', '*', '_', '~'];
-
 function escapeMarkdown(s) {
   let result = s;
-
   for (const char of escapeCharacters) {
     result = result.replace(new RegExp(`\\${char}`, 'g'), `\\${char}`);
   }
-
   return result;
 }
-
 const mdVerbatim = Symbol();
-
 function md(strings, ...params) {
   let result = [];
-
   for (let i = 0; i < params.length; i++) {
     result.push(strings[i]);
     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]}`));
-
         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}`));
     }
   }
-
   return result.join('') + strings[strings.length - 1];
 }
-
 md.bold = function (s) {
   // $FlowFixMe[invalid-computed-prop]
   return {
     [mdVerbatim]: '**' + escapeMarkdown(`${s}`) + '**'
   };
 };
-
 md.italic = function (s) {
   // $FlowFixMe[invalid-computed-prop]
   return {
     [mdVerbatim]: '_' + escapeMarkdown(`${s}`) + '_'
   };
 };
-
 md.underline = function (s) {
   // $FlowFixMe[invalid-computed-prop]
   return {
     [mdVerbatim]: '__' + escapeMarkdown(`${s}`) + '__'
   };
 };
-
 md.strikethrough = function (s) {
   // $FlowFixMe[invalid-computed-prop]
   return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@parcel/diagnostic",
-  "version": "2.8.3",
+  "version": "2.9.0",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -27,5 +27,5 @@
     "@mischnic/json-sourcemap": "^0.1.0",
     "nullthrows": "^1.1.1"
   },
-  "gitHead": "349a6caf40ec8abb6a49fcae0765f8f8deb2073d"
+  "gitHead": "dd9435be8afed35c5ffc161cf4b586fd6c78fc1f"
 }

package/src/diagnostic.js

@@ -238,7 +238,7 @@ export function generateJSONCodeHighlights(
   return ids.map(({key, type, message}) => {
     let pos = nullthrows(map.pointers[key]);
     return {
-      ...getJSONSourceLocation(pos, type),
+      ...getJSONHighlightLocation(pos, type),
       message,
     };
   });
@@ -248,7 +248,7 @@ export function generateJSONCodeHighlights(
  * Converts entries in <a href="https://github.com/mischnic/json-sourcemap">@mischnic/json-sourcemap</a>'s
  * <code>result.pointers</code> array.
  */
-export function getJSONSourceLocation(
+export function getJSONHighlightLocation(
   pos: Mapping,
   type?: ?'key' | 'value',
 ): {|
@@ -277,6 +277,42 @@ export function getJSONSourceLocation(
   }
 }
 
+/** Result is 1-based, but end is exclusive */
+export function getJSONSourceLocation(
+  pos: Mapping,
+  type?: ?'key' | 'value',
+): {|
+  start: {|
+    +line: number,
+    +column: number,
+  |},
+  end: {|
+    +line: number,
+    +column: number,
+  |},
+|} {
+  let v = getJSONHighlightLocation(pos, type);
+  return {start: v.start, end: {line: v.end.line, column: v.end.column + 1}};
+}
+
+export function convertSourceLocationToHighlight<
+  Location: {
+    /** 1-based, inclusive */
+    +start: {|
+      +line: number,
+      +column: number,
+    |},
+    /** 1-based, exclusive */
+    +end: {|
+      +line: number,
+      +column: number,
+    |},
+    ...
+  },
+>({start, end}: Location, message?: string): DiagnosticCodeHighlight {
+  return {message, start, end: {line: end.line, column: end.column - 1}};
+}
+
 /** Sanitizes object keys before using them as <code>key</code> in generateJSONCodeHighlights */
 export function encodeJSONKeyComponent(component: string): string {
   return component.replace(/~/g, '~0').replace(/\//g, '~1');

package/test/JSONCodeHighlights.test.js

@@ -0,0 +1,36 @@
+// @flow strict-local
+import assert from 'assert';
+
+import {generateJSONCodeHighlights} from '../src/diagnostic';
+
+describe('generateJSONCodeHighlights', () => {
+  it('returns an escaped string 01', () => {
+    let result = generateJSONCodeHighlights(
+      `{
+  "a": 1
+}`,
+      [
+        {key: '/a', type: 'key', message: 'foo1'},
+        {key: '/a', type: 'value', message: 'foo2'},
+        {key: '/a', message: 'foo3'},
+      ],
+    );
+    assert.deepEqual(result, [
+      {
+        start: {line: 2, column: 3},
+        end: {line: 2, column: 5},
+        message: 'foo1',
+      },
+      {
+        start: {line: 2, column: 8},
+        end: {line: 2, column: 8},
+        message: 'foo2',
+      },
+      {
+        start: {line: 2, column: 3},
+        end: {line: 2, column: 8},
+        message: 'foo3',
+      },
+    ]);
+  });
+});