@atlaspack/diagnostic 2.14.2-typescript-8a6ec6c8b.0 → 2.14.2-typescript-d6e6d169c.0

package/src/{diagnostic.js → index.mts}

@@ -1,14 +1,12 @@
-// @flow strict-local
-
-import invariant from 'assert';
+import assert from 'node:assert';
 import nullthrows from 'nullthrows';
-import {parse, type Mapping} from '@mischnic/json-sourcemap';
+import * as jsonSourcemap 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 type DiagnosticHighlightLocation = {
+  line: number;
+  column: number;
+};
 
 export type DiagnosticSeverity = 'error' | 'warn' | 'info';
 
@@ -16,21 +14,21 @@ 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
  */
-export type DiagnosticCodeHighlight = {|
+export type DiagnosticCodeHighlight = {
   /** Location of the first character that should get highlighted for this highlight. */
-  start: DiagnosticHighlightLocation,
+  start: DiagnosticHighlightLocation;
   /** Location of the last character that should get highlighted for this highlight. */
-  end: DiagnosticHighlightLocation,
+  end: DiagnosticHighlightLocation;
   /** A message that should be displayed at this location in the code (optional). */
-  message?: string,
-|};
+  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 = {|
+export type DiagnosticCodeFrame = {
   /**
    * The contents of the source file.
    *
@@ -38,50 +36,50 @@ export type DiagnosticCodeFrame = {|
    * the asset's current code could be different from the input contents.
    *
    */
-  code?: string,
+  code?: string;
   /** Path to the file this code frame is about (optional, absolute or relative to the project root) */
-  filePath?: string,
+  filePath?: string;
   /** Language of the file this code frame is about (optional) */
-  language?: string,
-  codeHighlights: Array<DiagnosticCodeHighlight>,
-|};
+  language?: string;
+  codeHighlights: Array<DiagnosticCodeHighlight>;
+};
 
 /** A JSON object (as in "map") */
-type JSONObject = {
+export type JSONObject = {
   // $FlowFixMe
-  [key: string]: any,
+  [key: string]: any;
 };
 
 /**
  * A style agnostic way of emitting errors, warnings and info.
  * Reporters are responsible for rendering the message, codeframes, hints, ...
  */
-export type Diagnostic = {|
+export type Diagnostic = {
   /** This is the message you want to log. */
-  message: string,
+  message: string;
   /** Name of plugin or file that threw this error */
-  origin?: string,
+  origin?: string;
 
   /** A stacktrace of the error (optional) */
-  stack?: string,
+  stack?: string;
   /** Name of the error (optional) */
-  name?: string,
+  name?: string;
 
   /** A code frame points to a certain location(s) in the file this diagnostic is linked to (optional) */
-  codeFrames?: ?Array<DiagnosticCodeFrame>,
+  codeFrames?: Array<DiagnosticCodeFrame>;
 
   /** An optional list of strings that suggest ways to resolve this issue */
-  hints?: Array<string>,
+  hints?: Array<string>;
 
   /** @private */
-  skipFormatting?: boolean,
+  skipFormatting?: boolean;
 
   /** A URL to documentation to learn more about the diagnostic. */
-  documentationURL?: string,
+  documentationURL?: string;
 
   /** Diagnostic specific metadata (optional) */
-  meta?: JSONObject,
-|};
+  meta?: JSONObject;
+};
 
 // This type should represent all error formats Atlaspack can encounter...
 export interface PrintableError extends Error {
@@ -89,18 +87,16 @@ export interface PrintableError extends Error {
   filePath?: string;
   codeFrame?: string;
   highlightedCodeFrame?: string;
-  loc?: ?{
-    column: number,
-    line: number,
-    ...
+  loc?: {
+    column: number;
+    line: number;
   };
   source?: string;
 }
 
-export type DiagnosticWithoutOrigin = {|
-  ...Diagnostic,
-  origin?: string,
-|};
+export type DiagnosticWithoutOrigin = Diagnostic & {
+  origin?: string;
+};
 
 /** Something that can be turned into a diagnostic. */
 export type Diagnostifiable =
@@ -131,12 +127,12 @@ export function anyToDiagnostic(input: Diagnostifiable): Array<Diagnostic> {
 /** Normalize the given error into a diagnostic. */
 export function errorToDiagnostic(
   error: ThrowableDiagnostic | PrintableError | string,
-  defaultValues?: {|
-    origin?: ?string,
-    filePath?: ?string,
-  |},
+  defaultValues?: {
+    origin?: string;
+    filePath?: string;
+  },
 ): Array<Diagnostic> {
-  let codeFrames: ?Array<DiagnosticCodeFrame> = undefined;
+  let codeFrames: Array<DiagnosticCodeFrame> | undefined = undefined;
 
   if (typeof error === 'string') {
     return [
@@ -195,9 +191,8 @@ export function errorToDiagnostic(
   ];
 }
 
-type ThrowableDiagnosticOpts = {
-  diagnostic: Diagnostic | Array<Diagnostic>,
-  ...
+export type ThrowableDiagnosticOpts = {
+  diagnostic: Diagnostic | Array<Diagnostic>;
 };
 
 /**
@@ -234,18 +229,18 @@ export default class ThrowableDiagnostic extends Error {
 export function generateJSONCodeHighlights(
   data:
     | string
-    | {|
-        data: mixed,
-        pointers: {|[key: string]: Mapping|},
-      |},
-  ids: Array<{|key: string, type?: ?'key' | 'value', message?: string|}>,
+    | {
+        data: any;
+        pointers: {[key: string]: jsonSourcemap.Mapping};
+      },
+  ids: Array<{key: string; type?: 'key' | 'value'; message?: string}>,
 ): Array<DiagnosticCodeHighlight> {
   let map =
     typeof data == 'string'
-      ? parse(data, undefined, {dialect: 'JSON5', tabWidth: 1})
+      ? jsonSourcemap.default.parse(data, undefined, {dialect: 'JSON5', tabWidth: 1})
       : data;
   return ids.map(({key, type, message}) => {
-    let pos = nullthrows(map.pointers[key]);
+    let pos = nullthrows.default(map.pointers[key]);
     return {
       ...getJSONHighlightLocation(pos, type),
       message,
@@ -258,12 +253,12 @@ export function generateJSONCodeHighlights(
  * <code>result.pointers</code> array.
  */
 export function getJSONHighlightLocation(
-  pos: Mapping,
-  type?: ?'key' | 'value',
-): {|
-  start: DiagnosticHighlightLocation,
-  end: DiagnosticHighlightLocation,
-|} {
+  pos: jsonSourcemap.Mapping,
+  type?: 'key' | 'value',
+): {
+  start: DiagnosticHighlightLocation;
+  end: DiagnosticHighlightLocation;
+} {
   let key = 'key' in pos ? pos.key : undefined;
   let keyEnd = 'keyEnd' in pos ? pos.keyEnd : undefined;
   if (!type && key && pos.value) {
@@ -273,7 +268,7 @@ export function getJSONHighlightLocation(
       end: {line: pos.valueEnd.line + 1, column: pos.valueEnd.column},
     };
   } else if (type == 'key' || !pos.value) {
-    invariant(key && keyEnd);
+    assert(key && keyEnd);
     return {
       start: {line: key.line + 1, column: key.column + 1},
       end: {line: keyEnd.line + 1, column: keyEnd.column},
@@ -288,35 +283,34 @@ export function getJSONHighlightLocation(
 
 /** 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,
-  |},
-|} {
+  pos: jsonSourcemap.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: {
+  Location extends {
     /** 1-based, inclusive */
-    +start: {|
-      +line: number,
-      +column: number,
-    |},
+    start: {
+      line: number;
+      column: number;
+    };
     /** 1-based, exclusive */
-    +end: {|
-      +line: number,
-      +column: number,
-    |},
-    ...
+    end: {
+      line: number;
+      column: number;
+    };
   },
 >({start, end}: Location, message?: string): DiagnosticCodeHighlight {
   return {message, start, end: {line: end.line, column: end.column - 1}};
@@ -338,11 +332,20 @@ export function escapeMarkdown(s: string): string {
   return result;
 }
 
-type TemplateInput = $FlowFixMe;
+export type TemplateInput = any;
 
 const mdVerbatim = Symbol();
-export function md(
-  strings: Array<string>,
+
+export interface MdFunction {
+  (strings: TemplateStringsArray, ...params: Array<TemplateInput>): string;
+  bold: (s: TemplateInput) => TemplateInput
+  italic: (s: TemplateInput) => TemplateInput
+  underline: (s: TemplateInput) => TemplateInput
+  strikethrough: (s: TemplateInput) => TemplateInput
+}
+
+export const md: MdFunction = function (
+  strings: TemplateStringsArray,
   ...params: Array<TemplateInput>
 ): string {
   let result = [];
@@ -362,7 +365,7 @@ export function md(
     }
   }
   return result.join('') + strings[strings.length - 1];
-}
+};
 
 md.bold = function (s: TemplateInput): TemplateInput {
   // $FlowFixMe[invalid-computed-prop]

package/test/{JSONCodeHighlights.test.js → JSONCodeHighlights.test.mts}

@@ -1,7 +1,6 @@
-// @flow strict-local
 import assert from 'assert';
 
-import {generateJSONCodeHighlights} from '../src/diagnostic';
+import {generateJSONCodeHighlights} from '../src/index.mts';
 
 describe('generateJSONCodeHighlights', () => {
   it('returns an escaped string 01', () => {

package/test/{markdown.test.js → markdown.test.mts}

@@ -1,7 +1,6 @@
-// @flow
 import assert from 'assert';
 
-import {escapeMarkdown, md} from '../src/diagnostic';
+import {escapeMarkdown, md} from '../src/index.mts';
 
 describe('escapeMarkdown', () => {
   it('returns an escaped string 01', () => {

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../../tsconfig.json",
+  "include": ["src"]
+}

package/lib/diagnostic.js

@@ -1,285 +0,0 @@
-"use strict";
-
-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 JSON object (as in "map") */
-/**
- * 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 Atlaspack can encounter...
-/** Something that can be turned into a diagnostic. */
-/** Normalize the given value into a diagnostic. */
-function anyToDiagnostic(input) {
-  if (Array.isArray(input)) {
-    return input.flatMap(e => anyToDiagnostic(e));
-  } else if (input instanceof ThrowableDiagnostic) {
-    return input.diagnostics;
-  } else if (input instanceof Error) {
-    return errorToDiagnostic(input);
-  } else if (typeof input === 'string') {
-    return [{
-      message: input
-    }];
-  } else if (typeof input === 'object') {
-    return [input];
-  } else {
-    return errorToDiagnostic(input);
-  }
-}
-
-/** Normalize the given error into a diagnostic. */
-function errorToDiagnostic(error, defaultValues) {
-  let codeFrames = undefined;
-  if (typeof error === 'string') {
-    return [{
-      origin: (defaultValues === null || defaultValues === void 0 ? void 0 : defaultValues.origin) ?? 'Error',
-      message: escapeMarkdown(error)
-    }];
-  }
-  if (error instanceof ThrowableDiagnostic) {
-    return error.diagnostics.map(d => {
-      return {
-        ...d,
-        origin: d.origin ?? (defaultValues === null || defaultValues === void 0 ? void 0 : defaultValues.origin) ?? 'unknown'
-      };
-    });
-  }
-  if (error.loc && error.source != null) {
-    codeFrames = [{
-      filePath: error.filePath ?? error.fileName ?? (defaultValues === null || defaultValues === void 0 ? void 0 : 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: (defaultValues === null || defaultValues === void 0 ? void 0 : defaultValues.origin) ?? 'Error',
-    message: escapeMarkdown(error.message),
-    name: error.name,
-    stack: codeFrames == null ? error.highlightedCodeFrame ?? error.codeFrame ?? error.stack : undefined,
-    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
-    super(diagnostics[0].message);
-    // @ts-ignore
-    this.stack = diagnostics[0].stack ?? super.stack;
-    // @ts-ignore
-    this.name = 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>.
- *
- * @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(data, ids) {
-  let map = typeof data == 'string' ? (0, _jsonSourcemap().parse)(data, undefined, {
-    dialect: 'JSON5',
-    tabWidth: 1
-  }) : data;
-  return ids.map(({
-    key,
-    type,
-    message
-  }) => {
-    let pos = (0, _nullthrows().default)(map.pointers[key]);
-    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 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 {
-      start: {
-        line: key.line + 1,
-        column: key.column + 1
-      },
-      end: {
-        line: pos.valueEnd.line + 1,
-        column: pos.valueEnd.column
-      }
-    };
-  } else if (type == 'key' || !pos.value) {
-    (0, _assert().default)(key && keyEnd);
-    return {
-      start: {
-        line: key.line + 1,
-        column: key.column + 1
-      },
-      end: {
-        line: keyEnd.line + 1,
-        column: keyEnd.column
-      }
-    };
-  } else {
-    return {
-      start: {
-        line: pos.value.line + 1,
-        column: pos.value.column + 1
-      },
-      end: {
-        line: pos.valueEnd.line + 1,
-        column: pos.valueEnd.column
-      }
-    };
-  }
-}
-
-/** 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;
-        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 {
-      result.push((param === null || param === void 0 ? 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}`) + '~~'
-  };
-};