@parcel/diagnostic 2.0.0-nightly.92 → 2.0.1

package/lib/diagnostic.d.ts

@@ -0,0 +1,131 @@
+import type { Mapping } from "json-source-map";
+/** These positions are 1-based (so <code>1</code> is the first line/column) */
+export declare type DiagnosticHighlightLocation = {
+    readonly line: number;
+    readonly column: number;
+};
+export declare type DiagnosticSeverity = "error" | "warn" | "info";
+/**
+ * Note: A tab character is always counted as a single character
+ * This is to prevent any mismatch of highlighting across machines
+ */
+export declare type DiagnosticCodeHighlight = {
+    /** Location of the first character that should get highlighted for this highlight. */
+    start: DiagnosticHighlightLocation;
+    /** Location of the last character that should get highlighted for this highlight. */
+    end: DiagnosticHighlightLocation;
+    /** A message that should be displayed at this location in the code (optional). */
+    message?: string;
+};
+/**
+ * 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.
+ */
+export declare type DiagnosticCodeFrame = {
+    /**
+     * The contents of the source file.
+     *
+     * If no code is passed, it will be read in from filePath, remember that
+     * the asset's current code could be different from the input contents.
+     *
+     */
+    code?: string;
+    /** Path to the file this code frame is about (optional, absolute or relative to the project root) */
+    filePath?: string;
+    /** Language of the file this code frame is about (optional) */
+    language?: string;
+    codeHighlights: Array<DiagnosticCodeHighlight>;
+};
+/**
+ * A style agnostic way of emitting errors, warnings and info.
+ * Reporters are responsible for rendering the message, codeframes, hints, ...
+ */
+export declare type Diagnostic = {
+    /** This is the message you want to log. */
+    message: string;
+    /** Name of plugin or file that threw this error */
+    origin?: string;
+    /** A stacktrace of the error (optional) */
+    stack?: string;
+    /** Name of the error (optional) */
+    name?: string;
+    /** A code frame points to a certain location(s) in the file this diagnostic is linked to (optional) */
+    codeFrames?: Array<DiagnosticCodeFrame> | null | undefined;
+    /** An optional list of strings that suggest ways to resolve this issue */
+    hints?: Array<string>;
+    /** @private */
+    skipFormatting?: boolean;
+    /** A URL to documentation to learn more about the diagnostic. */
+    documentationURL?: string;
+};
+export interface PrintableError extends Error {
+    fileName?: string;
+    filePath?: string;
+    codeFrame?: string;
+    highlightedCodeFrame?: string;
+    loc?: {
+        column: number;
+        line: number;
+    } | null | undefined;
+    source?: string;
+}
+export declare type DiagnosticWithoutOrigin = Diagnostic & {
+    origin?: string;
+};
+/** Something that can be turned into a diagnostic. */
+export declare type Diagnostifiable = Diagnostic | Array<Diagnostic> | ThrowableDiagnostic | PrintableError | Error | string;
+/** Normalize the given value into a diagnostic. */
+export declare function anyToDiagnostic(input: Diagnostifiable): Array<Diagnostic>;
+/** Normalize the given error into a diagnostic. */
+export declare function errorToDiagnostic(error: ThrowableDiagnostic | PrintableError | string, defaultValues?: {
+    origin?: string | null | undefined;
+    filePath?: string | null | undefined;
+}): Array<Diagnostic>;
+declare type ThrowableDiagnosticOpts = {
+    diagnostic: Diagnostic | Array<Diagnostic>;
+};
+/**
+ * An error wrapper around a diagnostic that can be <code>throw</code>n (e.g. to signal a
+ * build error).
+ */
+export default class ThrowableDiagnostic extends Error {
+    diagnostics: Array<Diagnostic>;
+    constructor(opts: ThrowableDiagnosticOpts);
+}
+/**
+ * Turns a list of positions in a JSON file with messages into a list of diagnostics.
+ * Uses <a href="https://github.com/epoberezkin/json-source-map">epoberezkin/json-source-map</a>.
+ *
+ * @param code the JSON code
+ * @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.
+ */
+export declare function generateJSONCodeHighlights(data: string | {
+    data: unknown;
+    pointers: Record<string, Mapping>;
+}, ids: Array<{
+    key: string;
+    type?: ("key" | null | undefined) | "value";
+    message?: string;
+}>): Array<DiagnosticCodeHighlight>;
+/**
+ * Converts entries in <a href="https://github.com/epoberezkin/json-source-map">epoberezkin/json-source-map</a>'s
+ * <code>result.pointers</code> array.
+ */
+export declare function getJSONSourceLocation(pos: Mapping, type?: ("key" | null | undefined) | "value"): {
+    start: DiagnosticHighlightLocation;
+    end: DiagnosticHighlightLocation;
+};
+/** 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;
+declare type TemplateInput = any;
+export declare function md(strings: Array<string>, ...params: Array<TemplateInput>): string;
+export declare namespace md {
+    var bold: (s: any) => any;
+    var italic: (s: any) => any;
+    var underline: (s: any) => any;
+    var strikethrough: (s: any) => any;
+}
+export {};

package/lib/diagnostic.js

@@ -7,56 +7,95 @@ exports.anyToDiagnostic = anyToDiagnostic;
 exports.errorToDiagnostic = errorToDiagnostic;
 exports.generateJSONCodeHighlights = generateJSONCodeHighlights;
 exports.getJSONSourceLocation = getJSONSourceLocation;
+exports.encodeJSONKeyComponent = encodeJSONKeyComponent;
+exports.escapeMarkdown = escapeMarkdown;
+exports.md = md;
 exports.default = void 0;
 
-var _jsonSourceMap = _interopRequireDefault(require("json-source-map"));
+function _assert() {
+  const data = _interopRequireDefault(require("assert"));
 
-var _nullthrows = _interopRequireDefault(require("nullthrows"));
+  _assert = function () {
+    return data;
+  };
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+  return data;
+}
 
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+function _nullthrows() {
+  const data = _interopRequireDefault(require("nullthrows"));
 
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+  _nullthrows = function () {
+    return data;
+  };
 
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+  return data;
+}
 
-function anyToDiagnostic(input) {
-  // $FlowFixMe
-  let diagnostic = input;
+function _jsonSourceMap() {
+  const data = _interopRequireDefault(require("json-source-map"));
+
+  _jsonSourceMap = function () {
+    return data;
+  };
 
-  if (input instanceof ThrowableDiagnostic) {
-    diagnostic = input.diagnostics;
+  return data;
+}
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/** Normalize the given value into a diagnostic. */
+function anyToDiagnostic(input) {
+  if (Array.isArray(input)) {
+    return input;
+  } else if (input instanceof ThrowableDiagnostic) {
+    return input.diagnostics;
   } else if (input instanceof Error) {
-    diagnostic = errorToDiagnostic(input);
+    return errorToDiagnostic(input);
+  } else if (typeof input === 'string') {
+    return [{
+      message: input
+    }];
+  } else if (typeof input === 'object') {
+    return [input];
+  } else {
+    return errorToDiagnostic(input);
   }
-
-  return diagnostic;
 }
+/** Normalize the given error into a diagnostic. */
+
+
+function errorToDiagnostic(error, defaultValues) {
+  var _defaultValues$origin2, _ref4, _error$highlightedCod;
 
-function errorToDiagnostic(error, realOrigin) {
-  let codeFrame = undefined;
+  let codeFrames = undefined;
 
   if (typeof error === 'string') {
-    return {
-      origin: realOrigin || 'Error',
-      message: error,
-      codeFrame
-    };
+    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 => {
-      return _objectSpread({}, d, {
-        origin: realOrigin || d.origin || 'unknown'
-      });
+      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'
+      };
     });
   }
 
-  if (error.loc && error.source) {
-    codeFrame = {
+  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,
-      codeHighlights: {
+      codeHighlights: [{
         start: {
           line: error.loc.line,
           column: error.loc.column
@@ -65,56 +104,72 @@ function errorToDiagnostic(error, realOrigin) {
           line: error.loc.line,
           column: error.loc.column
         }
-      }
-    };
+      }]
+    }];
   }
 
-  return {
-    origin: realOrigin || 'Error',
-    message: error.message,
+  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),
     name: error.name,
-    filePath: error.filePath || error.fileName,
-    stack: error.highlightedCodeFrame || error.codeFrame || error.stack,
-    codeFrame
-  };
+    stack: (_ref4 = (_error$highlightedCod = error.highlightedCodeFrame) !== null && _error$highlightedCod !== void 0 ? _error$highlightedCod : error.codeFrame) !== null && _ref4 !== void 0 ? _ref4 : error.stack,
+    codeFrames
+  }];
 }
 
+/**
+ * An error wrapper around a diagnostic that can be <code>throw</code>n (e.g. to signal a
+ * build error).
+ */
 class ThrowableDiagnostic extends Error {
   constructor(opts) {
-    let diagnostics = Array.isArray(opts.diagnostic) ? opts.diagnostic : [opts.diagnostic]; // construct error from diagnostics...
+    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);
+    super(diagnostics[0].message); // @ts-ignore
 
-    _defineProperty(this, "diagnostics", void 0);
+    this.stack = (_diagnostics$0$stack = diagnostics[0].stack) !== null && _diagnostics$0$stack !== void 0 ? _diagnostics$0$stack : super.stack; // @ts-ignore
 
-    this.stack = diagnostics[0].stack || super.stack;
-    this.name = diagnostics[0].name || super.name;
+    this.name = (_diagnostics$0$name = diagnostics[0].name) !== null && _diagnostics$0$name !== void 0 ? _diagnostics$0$name : super.name;
     this.diagnostics = diagnostics;
   }
 
-} // ids.key has to be "/some/parent/child"
+}
+/**
+ * Turns a list of positions in a JSON file with messages into a list of diagnostics.
+ * Uses <a href="https://github.com/epoberezkin/json-source-map">epoberezkin/json-source-map</a>.
+ *
+ * @param code the JSON code
+ * @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(code, ids) {
+function generateJSONCodeHighlights(data, ids) {
   // json-source-map doesn't support a tabWidth option (yet)
-  let map = _jsonSourceMap.default.parse(code.replace(/\t/g, ' '));
-
+  let map = typeof data == 'string' ? _jsonSourceMap().default.parse(data.replace(/\t/g, ' ')) : data;
   return ids.map(({
     key,
     type,
     message
   }) => {
-    let pos = (0, _nullthrows.default)(map.pointers[key]);
-    return _objectSpread({}, getJSONSourceLocation(pos, type), {
+    let pos = (0, _nullthrows().default)(map.pointers[key]);
+    return { ...getJSONSourceLocation(pos, type),
       message
-    });
+    };
   });
 }
+/**
+ * Converts entries in <a href="https://github.com/epoberezkin/json-source-map">epoberezkin/json-source-map</a>'s
+ * <code>result.pointers</code> array.
+ */
+
 
 function getJSONSourceLocation(pos, type) {
-  if (!type && pos.value) {
+  if (!type && pos.key && pos.value) {
     // key and value
     return {
       start: {
@@ -127,6 +182,7 @@ function getJSONSourceLocation(pos, type) {
       }
     };
   } else if (type == 'key' || !pos.value) {
+    (0, _assert().default)(pos.key && pos.keyEnd);
     return {
       start: {
         line: pos.key.line + 1,
@@ -149,4 +205,79 @@ function getJSONSourceLocation(pos, type) {
       }
     };
   }
-}
+}
+/** Sanitizes object keys before using them as <code>key</code> in generateJSONCodeHighlights */
+
+
+function encodeJSONKeyComponent(component) {
+  return component.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 {
+    [mdVerbatim]: '~~' + escapeMarkdown(`${s}`) + '~~'
+  };
+};

package/package.json

@@ -1,22 +1,31 @@
 {
   "name": "@parcel/diagnostic",
-  "version": "2.0.0-nightly.92+c0655c56",
+  "version": "2.0.1",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
   },
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/parcel"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/parcel-bundler/parcel.git"
   },
   "main": "lib/diagnostic.js",
   "source": "src/diagnostic.js",
+  "types": "lib/diagnostic.d.ts",
   "engines": {
-    "node": ">= 10.0.0"
+    "node": ">= 12.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",
+    "check-ts": "tsc --noEmit lib/diagnostic.d.ts"
   },
   "dependencies": {
     "json-source-map": "^0.6.1",
     "nullthrows": "^1.1.1"
   },
-  "gitHead": "c0655c56f7973492fdb28671029ddd923f17a244"
+  "gitHead": "28b47e6bdca7de2a06b7cc39a4a0b1df89f3fe15"
 }

package/src/diagnostic.js

@@ -1,143 +1,186 @@
-// @flow
-import type {FilePath} from '@parcel/types';
+// @flow strict-local
 
-import jsonMap from 'json-source-map';
+import invariant from 'assert';
 import nullthrows from 'nullthrows';
+import jsonMap, {type Mapping} from 'json-source-map';
 
+/** These positions are 1-based (so <code>1</code> is the first line/column) */
 export type DiagnosticHighlightLocation = {|
-  // These positions are 1-based
-  line: number,
-  column: number,
+  +line: number,
+  +column: number,
 |};
 
 export type DiagnosticSeverity = 'error' | 'warn' | 'info';
 
-// Note: A tab character is always counted as a single character
-// This is to prevent any mismatch of highlighting across machines
+/**
+ * Note: A tab character is always counted as a single character
+ * This is to prevent any mismatch of highlighting across machines
+ */
 export type DiagnosticCodeHighlight = {|
-  // start and end are included in the highlighted region
+  /** Location of the first character that should get highlighted for this highlight. */
   start: DiagnosticHighlightLocation,
+  /** Location of the last character that should get highlighted for this highlight. */
   end: DiagnosticHighlightLocation,
+  /** A message that should be displayed at this location in the code (optional). */
   message?: string,
 |};
 
+/**
+ * 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.
+ */
 export type DiagnosticCodeFrame = {|
-  code: string,
-  codeHighlights: DiagnosticCodeHighlight | Array<DiagnosticCodeHighlight>,
+  /**
+   * The contents of the source file.
+   *
+   * If no code is passed, it will be read in from filePath, remember that
+   * the asset's current code could be different from the input contents.
+   *
+   */
+  code?: string,
+  /** Path to the file this code frame is about (optional, absolute or relative to the project root) */
+  filePath?: string,
+  /** Language of the file this code frame is about (optional) */
+  language?: string,
+  codeHighlights: Array<DiagnosticCodeHighlight>,
 |};
 
-// A Diagnostic is a style agnostic way of emitting errors, warnings and info
-// The reporter's are responsible for rendering the message, codeframes, hints, ...
+/**
+ * A style agnostic way of emitting errors, warnings and info.
+ * Reporters are responsible for rendering the message, codeframes, hints, ...
+ */
 export type Diagnostic = {|
+  /** This is the message you want to log. */
   message: string,
-  origin?: string, // Name of plugin or file that threw this error
+  /** Name of plugin or file that threw this error */
+  origin?: string,
 
-  // basic error data
+  /** A stacktrace of the error (optional) */
   stack?: string,
+  /** Name of the error (optional) */
   name?: string,
 
-  // Asset metadata
-  filePath?: FilePath,
-  language?: string,
-
-  // Codeframe data
-  codeFrame?: DiagnosticCodeFrame,
+  /** A code frame points to a certain location(s) in the file this diagnostic is linked to (optional) */
+  codeFrames?: ?Array<DiagnosticCodeFrame>,
 
-  // Hints to resolve issues faster
+  /** An optional list of strings that suggest ways to resolve this issue */
   hints?: Array<string>,
 
+  /** @private */
   skipFormatting?: boolean,
+
+  /** A URL to documentation to learn more about the diagnostic. */
+  documentationURL?: string,
 |};
 
 // This type should represent all error formats Parcel can encounter...
-export type PrintableError = Error & {
-  fileName?: string,
-  filePath?: string,
-  codeFrame?: string,
-  highlightedCodeFrame?: string,
-  loc?: {
+export interface PrintableError extends Error {
+  fileName?: string;
+  filePath?: string;
+  codeFrame?: string;
+  highlightedCodeFrame?: string;
+  loc?: ?{
     column: number,
     line: number,
     ...
-  },
-  source?: string,
-  ...
-};
+  };
+  source?: string;
+}
 
 export type DiagnosticWithoutOrigin = {|
   ...Diagnostic,
   origin?: string,
 |};
 
-// Something that can be turned into a diagnostic...
+/** Something that can be turned into a diagnostic. */
 export type Diagnostifiable =
   | Diagnostic
   | Array<Diagnostic>
   | ThrowableDiagnostic
   | PrintableError
+  | Error
   | string;
 
-export function anyToDiagnostic(
-  input: Diagnostifiable,
-): Diagnostic | Array<Diagnostic> {
-  // $FlowFixMe
-  let diagnostic: Diagnostic | Array<Diagnostic> = input;
-  if (input instanceof ThrowableDiagnostic) {
-    diagnostic = input.diagnostics;
+/** Normalize the given value into a diagnostic. */
+export function anyToDiagnostic(input: Diagnostifiable): Array<Diagnostic> {
+  if (Array.isArray(input)) {
+    return input;
+  } else if (input instanceof ThrowableDiagnostic) {
+    return input.diagnostics;
   } else if (input instanceof Error) {
-    diagnostic = errorToDiagnostic(input);
+    return errorToDiagnostic(input);
+  } else if (typeof input === 'string') {
+    return [{message: input}];
+  } else if (typeof input === 'object') {
+    return [input];
+  } else {
+    return errorToDiagnostic(input);
   }
-
-  return diagnostic;
 }
 
+/** Normalize the given error into a diagnostic. */
 export function errorToDiagnostic(
   error: ThrowableDiagnostic | PrintableError | string,
-  realOrigin?: string,
-): Diagnostic | Array<Diagnostic> {
-  let codeFrame: DiagnosticCodeFrame | void = undefined;
+  defaultValues?: {|
+    origin?: ?string,
+    filePath?: ?string,
+  |},
+): Array<Diagnostic> {
+  let codeFrames: ?Array<DiagnosticCodeFrame> = undefined;
 
   if (typeof error === 'string') {
-    return {
-      origin: realOrigin || 'Error',
-      message: error,
-      codeFrame,
-    };
+    return [
+      {
+        origin: defaultValues?.origin ?? 'Error',
+        message: escapeMarkdown(error),
+      },
+    ];
   }
 
   if (error instanceof ThrowableDiagnostic) {
     return error.diagnostics.map(d => {
       return {
         ...d,
-        origin: realOrigin || d.origin || 'unknown',
+        origin: d.origin ?? defaultValues?.origin ?? 'unknown',
       };
     });
   }
 
-  if (error.loc && error.source) {
-    codeFrame = {
-      code: error.source,
-      codeHighlights: {
-        start: {
-          line: error.loc.line,
-          column: error.loc.column,
-        },
-        end: {
-          line: error.loc.line,
-          column: error.loc.column,
-        },
+  if (error.loc && error.source != null) {
+    codeFrames = [
+      {
+        filePath:
+          error.filePath ??
+          error.fileName ??
+          defaultValues?.filePath ??
+          undefined,
+        code: error.source,
+        codeHighlights: [
+          {
+            start: {
+              line: error.loc.line,
+              column: error.loc.column,
+            },
+            end: {
+              line: error.loc.line,
+              column: error.loc.column,
+            },
+          },
+        ],
       },
-    };
+    ];
   }
 
-  return {
-    origin: realOrigin || 'Error',
-    message: error.message,
-    name: error.name,
-    filePath: error.filePath || error.fileName,
-    stack: error.highlightedCodeFrame || error.codeFrame || error.stack,
-    codeFrame,
-  };
+  return [
+    {
+      origin: defaultValues?.origin ?? 'Error',
+      message: escapeMarkdown(error.message),
+      name: error.name,
+      stack: error.highlightedCodeFrame ?? error.codeFrame ?? error.stack,
+      codeFrames,
+    },
+  ];
 }
 
 type ThrowableDiagnosticOpts = {
@@ -145,6 +188,10 @@ type ThrowableDiagnosticOpts = {
   ...
 };
 
+/**
+ * An error wrapper around a diagnostic that can be <code>throw</code>n (e.g. to signal a
+ * build error).
+ */
 export default class ThrowableDiagnostic extends Error {
   diagnostics: Array<Diagnostic>;
 
@@ -153,22 +200,37 @@ export default class ThrowableDiagnostic extends Error {
       ? opts.diagnostic
       : [opts.diagnostic];
 
-    // construct error from diagnostics...
+    // Construct error from diagnostics
     super(diagnostics[0].message);
-    this.stack = diagnostics[0].stack || super.stack;
-    this.name = diagnostics[0].name || super.name;
+    // @ts-ignore
+    this.stack = diagnostics[0].stack ?? super.stack;
+    // @ts-ignore
+    this.name = diagnostics[0].name ?? super.name;
 
     this.diagnostics = diagnostics;
   }
 }
 
-// ids.key has to be "/some/parent/child"
+/**
+ * Turns a list of positions in a JSON file with messages into a list of diagnostics.
+ * Uses <a href="https://github.com/epoberezkin/json-source-map">epoberezkin/json-source-map</a>.
+ *
+ * @param code the JSON code
+ * @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.
+ */
 export function generateJSONCodeHighlights(
-  code: string,
+  data:
+    | string
+    | {|
+        data: mixed,
+        pointers: {|[key: string]: Mapping|},
+      |},
   ids: Array<{|key: string, type?: ?'key' | 'value', message?: string|}>,
 ): Array<DiagnosticCodeHighlight> {
   // json-source-map doesn't support a tabWidth option (yet)
-  let map = jsonMap.parse(code.replace(/\t/g, ' '));
+  let map =
+    typeof data == 'string' ? jsonMap.parse(data.replace(/\t/g, ' ')) : data;
   return ids.map(({key, type, message}) => {
     let pos = nullthrows(map.pointers[key]);
     return {
@@ -178,14 +240,25 @@ export function generateJSONCodeHighlights(
   });
 }
 
-export function getJSONSourceLocation(pos: any, type?: ?'key' | 'value') {
-  if (!type && pos.value) {
+/**
+ * Converts entries in <a href="https://github.com/epoberezkin/json-source-map">epoberezkin/json-source-map</a>'s
+ * <code>result.pointers</code> array.
+ */
+export function getJSONSourceLocation(
+  pos: Mapping,
+  type?: ?'key' | 'value',
+): {|
+  start: DiagnosticHighlightLocation,
+  end: DiagnosticHighlightLocation,
+|} {
+  if (!type && pos.key && pos.value) {
     // key and value
     return {
       start: {line: pos.key.line + 1, column: pos.key.column + 1},
       end: {line: pos.valueEnd.line + 1, column: pos.valueEnd.column},
     };
   } else if (type == 'key' || !pos.value) {
+    invariant(pos.key && pos.keyEnd);
     return {
       start: {line: pos.key.line + 1, column: pos.key.column + 1},
       end: {line: pos.keyEnd.line + 1, column: pos.keyEnd.column},
@@ -197,3 +270,65 @@ export function getJSONSourceLocation(pos: any, type?: ?'key' | 'value') {
     };
   }
 }
+
+/** Sanitizes object keys before using them as <code>key</code> in generateJSONCodeHighlights */
+export function encodeJSONKeyComponent(component: string): string {
+  return component.replace(/\//g, '~1');
+}
+
+const escapeCharacters = ['\\', '*', '_', '~'];
+
+export function escapeMarkdown(s: string): string {
+  let result = s;
+  for (const char of escapeCharacters) {
+    result = result.replace(new RegExp(`\\${char}`, 'g'), `\\${char}`);
+  }
+
+  return result;
+}
+
+type TemplateInput = $FlowFixMe;
+
+const mdVerbatim = Symbol();
+export function md(
+  strings: Array<string>,
+  ...params: Array<TemplateInput>
+): string {
+  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++) {
+        result.push(param[j]?.[mdVerbatim] ?? escapeMarkdown(`${param[j]}`));
+        if (j < param.length - 1) {
+          result.push(', ');
+        }
+      }
+    } else {
+      result.push(param?.[mdVerbatim] ?? escapeMarkdown(`${param}`));
+    }
+  }
+  return result.join('') + strings[strings.length - 1];
+}
+
+md.bold = function (s: TemplateInput): TemplateInput {
+  // $FlowFixMe[invalid-computed-prop]
+  return {[mdVerbatim]: '**' + escapeMarkdown(`${s}`) + '**'};
+};
+
+md.italic = function (s: TemplateInput): TemplateInput {
+  // $FlowFixMe[invalid-computed-prop]
+  return {[mdVerbatim]: '_' + escapeMarkdown(`${s}`) + '_'};
+};
+
+md.underline = function (s: TemplateInput): TemplateInput {
+  // $FlowFixMe[invalid-computed-prop]
+  return {[mdVerbatim]: '__' + escapeMarkdown(`${s}`) + '__'};
+};
+
+md.strikethrough = function (s: TemplateInput): TemplateInput {
+  // $FlowFixMe[invalid-computed-prop]
+  return {[mdVerbatim]: '~~' + escapeMarkdown(`${s}`) + '~~'};
+};

package/test/markdown.test.js

@@ -0,0 +1,81 @@
+// @flow
+import assert from 'assert';
+
+import {escapeMarkdown, md} from '../src/diagnostic';
+
+describe('escapeMarkdown', () => {
+  it('returns an escaped string 01', () => {
+    assert.strictEqual('\\*test\\*', escapeMarkdown('*test*'));
+  });
+
+  it('returns an escaped string 02', () => {
+    assert.strictEqual('\\_test\\_', escapeMarkdown('_test_'));
+  });
+
+  it('returns an escaped string 03', () => {
+    assert.strictEqual('\\~test\\~', escapeMarkdown('~test~'));
+  });
+
+  it('returns an escaped string 04', () => {
+    assert.strictEqual('\\*\\_\\~test\\~\\_\\*', escapeMarkdown('*_~test~_*'));
+  });
+
+  it('returns an escaped string with backslash 01', () => {
+    assert.strictEqual('\\\\test\\\\', escapeMarkdown('\\test\\'));
+  });
+
+  it('returns an escaped string with backslash 02', () => {
+    assert.strictEqual('\\\\\\*test\\*\\\\', escapeMarkdown('\\*test*\\'));
+  });
+});
+
+describe('md tagged template literal', () => {
+  it('bold placeholder', () => {
+    assert.strictEqual(
+      '*Test*: **\\_abc\\_**',
+      md`*Test*: ${md.bold('_abc_')}`,
+    );
+  });
+
+  it('italic placeholder', () => {
+    assert.strictEqual(
+      '*Test*: _\\_abc\\__',
+      md`*Test*: ${md.italic('_abc_')}`,
+    );
+  });
+
+  it('underline placeholder', () => {
+    assert.strictEqual(
+      '*Test*: __\\_abc\\___',
+      md`*Test*: ${md.underline('_abc_')}`,
+    );
+  });
+
+  it('strikethrough placeholder', () => {
+    assert.strictEqual(
+      '*Test*: ~~\\_abc\\_~~',
+      md`*Test*: ${md.strikethrough('_abc_')}`,
+    );
+  });
+
+  it('escapes only placeholders', () => {
+    assert.strictEqual('*Test*: \\_abc\\_', md`*Test*: ${'_abc_'}`);
+  });
+
+  it('behaves like native template literal', () => {
+    let v = {
+      toString() {
+        return 'a';
+      },
+      // $FlowFixMe[invalid-computed-prop]
+      [Symbol.toPrimitive]() {
+        return 'b';
+      },
+    };
+    assert.strictEqual('Test: b', md`Test: ${v}`);
+  });
+
+  it('supports null and undefined', () => {
+    assert.strictEqual('Test: undefined null', md`Test: ${undefined} ${null}`);
+  });
+});