@parcel/diagnostic 2.0.0-canary.1543 → 2.0.0-dev.1424

package/lib/diagnostic.d.ts

@@ -1,9 +1,9 @@
 import type { Mapping } from "@mischnic/json-sourcemap";
 /** These positions are 1-based (so <code>1</code> is the first line/column) */
-export type DiagnosticHighlightLocation = {
+export interface DiagnosticHighlightLocation {
     readonly line: number;
     readonly column: number;
-};
+}
 export type DiagnosticSeverity = "error" | "warn" | "info";
 /**
  * Note: A tab character is always counted as a single character
@@ -37,8 +37,6 @@ 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, ...
@@ -60,8 +58,6 @@ 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;
@@ -123,27 +119,16 @@ export declare function getJSONHighlightLocation(pos: Mapping, type?: ("key" | n
 };
 /** 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;
-    };
+    start: DiagnosticHighlightLocation;
+    end: DiagnosticHighlightLocation;
 };
-export declare function convertSourceLocationToHighlight<Location extends {
+interface Location {
     /** 1-based, inclusive */
-    readonly start: {
-        readonly line: number;
-        readonly column: number;
-    };
+    readonly start: DiagnosticHighlightLocation;
     /** 1-based, exclusive */
-    readonly end: {
-        readonly line: number;
-        readonly column: number;
-    };
-}>({ start, end }: Location, message?: string): DiagnosticCodeHighlight;
+    readonly end: DiagnosticHighlightLocation;
+}
+export declare function convertSourceLocationToHighlight({ 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

@@ -45,7 +45,6 @@ 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, ...
@@ -224,7 +223,10 @@ function convertSourceLocationToHighlight({
 }, message) {
   return {
     message,
-    start,
+    start: {
+      line: start.line,
+      column: start.column
+    },
     end: {
       line: end.line,
       column: end.column - 1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@parcel/diagnostic",
-  "version": "2.0.0-canary.1543+ec3f4a5fb",
+  "version": "2.0.0-dev.1424+7f6b4dbbc",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -27,5 +27,5 @@
     "@mischnic/json-sourcemap": "^0.1.0",
     "nullthrows": "^1.1.1"
   },
-  "gitHead": "ec3f4a5fbfad05bd3b645e02b90ff9c5abc738dc"
+  "gitHead": "7f6b4dbbc56a203e0fce8794856c03598c4f6708"
 }

package/src/diagnostic.js

@@ -5,10 +5,10 @@ import nullthrows from 'nullthrows';
 import {parse, type Mapping} from '@mischnic/json-sourcemap';
 
 /** These positions are 1-based (so <code>1</code> is the first line/column) */
-export type DiagnosticHighlightLocation = {|
-  +line: number,
-  +column: number,
-|};
+export interface DiagnosticHighlightLocation {
+  +line: number;
+  +column: number;
+}
 
 export type DiagnosticSeverity = 'error' | 'warn' | 'info';
 
@@ -46,12 +46,6 @@ 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, ...
@@ -78,9 +72,6 @@ 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...
@@ -291,35 +282,29 @@ export function getJSONSourceLocation(
   pos: Mapping,
   type?: ?'key' | 'value',
 ): {|
-  start: {|
-    +line: number,
-    +column: number,
-  |},
-  end: {|
-    +line: number,
-    +column: number,
-  |},
+  start: DiagnosticHighlightLocation,
+  end: DiagnosticHighlightLocation,
 |} {
   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}};
+interface Location {
+  /** 1-based, inclusive */
+  +start: DiagnosticHighlightLocation;
+  /** 1-based, exclusive */
+  +end: DiagnosticHighlightLocation;
+}
+
+export function convertSourceLocationToHighlight(
+  {start, end}: Location,
+  message?: string,
+): DiagnosticCodeHighlight {
+  return {
+    message,
+    start: {line: start.line, column: start.column},
+    end: {line: end.line, column: end.column - 1},
+  };
 }
 
 /** Sanitizes object keys before using them as <code>key</code> in generateJSONCodeHighlights */