@atlaspack/diagnostic 2.14.2-typescript-e769947a5.0 → 2.14.2-typescript-08dcc1c9b.0

package/lib/diagnostic.js

@@ -36,22 +36,29 @@ function _jsonSourcemap() {
 }
 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)) {
@@ -122,9 +129,7 @@ class ThrowableDiagnostic extends Error {
 
     // 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;
   }
@@ -260,25 +265,21 @@ function md(strings, ...params) {
   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,6 +1,6 @@
 {
   "name": "@atlaspack/diagnostic",
-  "version": "2.14.2-typescript-e769947a5.0",
+  "version": "2.14.2-typescript-08dcc1c9b.0",
   "description": "Types and utilities for printing source-code located errors, warning and information messages.",
   "license": "(MIT OR Apache-2.0)",
   "publishConfig": {
@@ -11,19 +11,18 @@
     "url": "https://github.com/atlassian-labs/atlaspack.git"
   },
   "main": "lib/diagnostic.js",
-  "source": "src/diagnostic.js",
-  "types": "lib/diagnostic.d.ts",
+  "source": "src/diagnostic.ts",
+  "types": "src/diagnostic.ts",
   "engines": {
     "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",
-    "check-ts": "tsc --noEmit lib/diagnostic.d.ts"
+    "check-ts": "tsc --noEmit"
   },
   "dependencies": {
     "@mischnic/json-sourcemap": "^0.1.0",
     "nullthrows": "^1.1.1"
   },
   "type": "commonjs",
-  "gitHead": "e769947a5b0c22d9477211ac1ce6614e6bf9def3"
+  "gitHead": "08dcc1c9bcdc6ab931d55e05ccc0f45669de2f22"
 }

package/src/{diagnostic.js → diagnostic.ts}

@@ -1,14 +1,12 @@
-// @flow strict-local
-
 import invariant from 'assert';
 import nullthrows from 'nullthrows';
-import {parse, type Mapping} from '@mischnic/json-sourcemap';
+import {parse, 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 type DiagnosticHighlightLocation = {
+  readonly line: number;
+  readonly 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,43 @@ 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 = {
-  // $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> | null | undefined;
   /** 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 +80,19 @@ export interface PrintableError extends Error {
   filePath?: string;
   codeFrame?: string;
   highlightedCodeFrame?: string;
-  loc?: ?{
-    column: number,
-    line: number,
-    ...
-  };
+  loc?:
+    | {
+        column: number;
+        line: number;
+      }
+    | null
+    | undefined;
   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 +123,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 | null | undefined;
+    filePath?: string | null | undefined;
+  },
 ): Array<Diagnostic> {
-  let codeFrames: ?Array<DiagnosticCodeFrame> = undefined;
+  let codeFrames: Array<DiagnosticCodeFrame> | null | undefined = undefined;
 
   if (typeof error === 'string') {
     return [
@@ -188,7 +180,7 @@ export function errorToDiagnostic(
       name: error.name,
       stack:
         codeFrames == null
-          ? error.highlightedCodeFrame ?? error.codeFrame ?? error.stack
+          ? (error.highlightedCodeFrame ?? error.codeFrame ?? error.stack)
           : undefined,
       codeFrames,
     },
@@ -196,8 +188,7 @@ export function errorToDiagnostic(
 }
 
 type ThrowableDiagnosticOpts = {
-  diagnostic: Diagnostic | Array<Diagnostic>,
-  ...
+  diagnostic: Diagnostic | Array<Diagnostic>;
 };
 
 /**
@@ -214,9 +205,7 @@ export default class ThrowableDiagnostic extends Error {
 
     // 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;
@@ -234,11 +223,17 @@ 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: unknown;
+        pointers: {
+          [key: string]: Mapping;
+        };
+      },
+  ids: Array<{
+    key: string;
+    type?: 'key' | null | undefined | 'value';
+    message?: string;
+  }>,
 ): Array<DiagnosticCodeHighlight> {
   let map =
     typeof data == 'string'
@@ -259,11 +254,11 @@ export function generateJSONCodeHighlights(
  */
 export function getJSONHighlightLocation(
   pos: Mapping,
-  type?: ?'key' | 'value',
-): {|
-  start: DiagnosticHighlightLocation,
-  end: DiagnosticHighlightLocation,
-|} {
+  type?: 'key' | null | undefined | '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) {
@@ -289,34 +284,33 @@ 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,
-  |},
-|} {
+  type?: 'key' | null | undefined | 'value',
+): {
+  start: {
+    readonly line: number;
+    readonly column: number;
+  };
+  end: {
+    readonly line: number;
+    readonly 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,
-    |},
+    readonly start: {
+      readonly line: number;
+      readonly column: number;
+    };
     /** 1-based, exclusive */
-    +end: {|
-      +line: number,
-      +column: number,
-    |},
-    ...
+    readonly end: {
+      readonly line: number;
+      readonly column: number;
+    };
   },
 >({start, end}: Location, message?: string): DiagnosticCodeHighlight {
   return {message, start, end: {line: end.line, column: end.column - 1}};
@@ -338,14 +332,14 @@ export function escapeMarkdown(s: string): string {
   return result;
 }
 
-type TemplateInput = $FlowFixMe;
+type TemplateInput = any;
 
 const mdVerbatim = Symbol();
 export function md(
   strings: Array<string>,
   ...params: Array<TemplateInput>
 ): string {
-  let result = [];
+  let result: Array<any | string> = [];
   for (let i = 0; i < params.length; i++) {
     result.push(strings[i]);
 
@@ -365,21 +359,17 @@ export function md(
 }
 
 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/{JSONCodeHighlights.test.js → JSONCodeHighlights.test.ts}

@@ -1,4 +1,3 @@
-// @flow strict-local
 import assert from 'assert';
 
 import {generateJSONCodeHighlights} from '../src/diagnostic';

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

@@ -1,4 +1,3 @@
-// @flow
 import assert from 'assert';
 
 import {escapeMarkdown, md} from '../src/diagnostic';
@@ -67,7 +66,6 @@ describe('md tagged template literal', () => {
       toString() {
         return 'a';
       },
-      // $FlowFixMe[invalid-computed-prop]
       [Symbol.toPrimitive]() {
         return 'b';
       },

package/tsconfig.json

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

package/lib/diagnostic.d.ts

@@ -1,158 +0,0 @@
-import type { Mapping } from "@mischnic/json-sourcemap";
-/** These positions are 1-based (so <code>1</code> is the first line/column) */
-export type DiagnosticHighlightLocation = {
-    readonly line: number;
-    readonly 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
- */
-export 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 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 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, ...
- */
-export 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;
-    /** Diagnostic specific metadata (optional) */
-    meta?: JSONObject;
-};
-export interface PrintableError extends Error {
-    fileName?: string;
-    filePath?: string;
-    codeFrame?: string;
-    highlightedCodeFrame?: string;
-    loc?: {
-        column: number;
-        line: number;
-    } | null | undefined;
-    source?: string;
-}
-export type DiagnosticWithoutOrigin = Diagnostic & {
-    origin?: string;
-};
-/** Something that can be turned into a diagnostic. */
-export 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>;
-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 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.
- */
-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/mischnic/json-sourcemap">@mischnic/json-sourcemap</a>'s
- * <code>result.pointers</code> array.
- */
-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;
-type TemplateInput = any;
-export declare function md(strings: Array<string>, ...params: Array<TemplateInput>): string;
-export declare namespace md {
-    var bold: (s: TemplateInput) => TemplateInput;
-    var italic: (s: TemplateInput) => TemplateInput;
-    var underline: (s: TemplateInput) => TemplateInput;
-    var strikethrough: (s: TemplateInput) => TemplateInput;
-}
-export {};