refactor: move notes on types out of typedef blocks

Author: brettz9

dist/espree.cjs

@@ -0,0 +1,41 @@
+/**
+ * Tokenizes the given code.
+ * @param {string} code The code to tokenize.
+ * @param {ParserOptions} options Options defining how to tokenize.
+ * @returns {import('acorn').Token[] | null} An array of tokens.
+ * @throws {import('./lib/espree').EnhancedSyntaxError} If the input code is invalid.
+ * @private
+ */
+export function tokenize(code: string, options: ParserOptions): import('acorn').Token[] | null;
+/**
+ * Parses the given code.
+ * @param {string} code The code to tokenize.
+ * @param {ParserOptions} options Options defining how to tokenize.
+ * @returns {import('acorn').Node} The "Program" AST node.
+ * @throws {import('./lib/espree').EnhancedSyntaxError} If the input code is invalid.
+ */
+export function parse(code: string, options: ParserOptions): import('acorn').Node;
+export const version: "main";
+export const VisitorKeys: visitorKeys.VisitorKeys;
+export const Syntax: {
+    [x: string]: string;
+};
+export const latestEcmaVersion: number;
+export const supportedEcmaVersions: number[];
+export type ParserOptions = {
+    allowReserved?: boolean;
+    ecmaVersion?: import('acorn').ecmaVersion;
+    sourceType?: "script" | "module" | "commonjs";
+    ecmaFeatures?: {
+        jsx?: boolean;
+        globalReturn?: boolean;
+        impliedStrict?: boolean;
+    };
+    range?: boolean;
+    loc?: boolean;
+    tokens?: boolean | null;
+    comment?: boolean;
+};
+import * as visitorKeys from "eslint-visitor-keys";
+import jsx from "acorn-jsx";
+//# sourceMappingURL=espree.d.ts.map

dist/espree.cjs.map

@@ -0,0 +1,75 @@
+declare function _default(): (Parser: typeof import('acorn-jsx').AcornJsxParser) => typeof EspreeParser;
+export default _default;
+export class EspreeParser extends acorn.Parser {
+    /**
+     * Adapted parser for Espree.
+     * @param {import('../espree').ParserOptions | null} opts Espree options
+     * @param {string | object} code The source code
+     */
+    constructor(opts: import('../espree').ParserOptions | null, code: string | object);
+    /**
+     * Returns Espree tokens.
+     * @returns {{comments?: {type: string; value: string; range?: [number, number]; start?: number; end?: number; loc?: {start: import('acorn').Position | undefined; end: import('acorn').Position | undefined}}[]} & import('acorn').Token[] | null} Espree tokens
+     */
+    tokenize(): {
+        comments?: {
+            type: string;
+            value: string;
+            range?: [number, number];
+            start?: number;
+            end?: number;
+            loc?: {
+                start: import('acorn').Position | undefined;
+                end: import('acorn').Position | undefined;
+            };
+        }[];
+    } & import('acorn').Token[] | null;
+    /**
+     * Parses.
+     * @returns {{sourceType?: "script" | "module" | "commonjs"; comments?: {type: string; value: string; range?: [number, number]; start?: number; end?: number; loc?: {start: import('acorn').Position | undefined; end: import('acorn').Position | undefined}}[]; tokens?: import('acorn').Token[]; body: import('acorn').Node[]} & import('acorn').Node} The program Node
+     */
+    parse(): {
+        sourceType?: "script" | "module" | "commonjs";
+        comments?: {
+            type: string;
+            value: string;
+            range?: [number, number];
+            start?: number;
+            end?: number;
+            loc?: {
+                start: import('acorn').Position | undefined;
+                end: import('acorn').Position | undefined;
+            };
+        }[];
+        tokens?: import('acorn').Token[];
+        body: import('acorn').Node[];
+    } & import('acorn').Node;
+    /**
+     * Overwrites the default raise method to throw Esprima-style errors.
+     * @param {number} pos The position of the error.
+     * @param {string} message The error message.
+     * @throws {EnhancedSyntaxError} A syntax error.
+     * @returns {void}
+     */
+    raiseRecoverable(pos: number, message: string): void;
+    /**
+     * Esprima-FB represents JSX strings as tokens called "JSXText", but Acorn-JSX
+     * uses regular tt.string without any distinction between this and regular JS
+     * strings. As such, we intercept an attempt to read a JSX string and set a flag
+     * on extra so that when tokens are converted, the next token will be switched
+     * to JSXText via onToken.
+     * @param {number} quote A character code
+     * @returns {void}
+     */
+    jsx_readString(quote: number): void;
+}
+export type EnhancedSyntaxError = {
+    index?: number;
+    lineNumber?: number;
+    column?: number;
+} & SyntaxError;
+export type EnhancedTokTypes = {
+    jsxAttrValueToken?: import('acorn').TokenType;
+} & typeof import('acorn-jsx').tokTypes;
+import * as acorn from "acorn";
+//# sourceMappingURL=espree.d.ts.map

dist/espree.d.ts

@@ -72,6 +72,8 @@
  * `ecmaFeatures`, `range`, `loc`, `tokens` are not in `acorn.Options`
  *
  * `comment` is not in `acorn.Options` and doesn't err without it, but is used
+ */
+/**
  * @typedef {{
  *   allowReserved?: boolean,
  *   ecmaVersion?: acorn.ecmaVersion,

dist/espree.d.ts.map

@@ -15,8 +15,9 @@ const ESPRIMA_FINISH_NODE = Symbol("espree's esprimaFinishNode");
  *   column?: number;
  * } & SyntaxError} EnhancedSyntaxError
  */
+
+// We add `jsxAttrValueToken` ourselves.
 /**
- * We add `jsxAttrValueToken` ourselves.
  * @typedef {{
  *   jsxAttrValueToken?: acorn.TokenType;
  * } & tokTypesType} EnhancedTokTypes
@@ -50,9 +51,12 @@ const ESPRIMA_FINISH_NODE = Symbol("espree's esprimaFinishNode");
  * @local
  * @typedef {number} int
  */
+
+/**
+ *  First three properties as in `acorn.Comment`; next two as in `acorn.Comment`
+ *  but optional. Last is different as has to allow `undefined`
+ */
 /**
- * First three properties as in `acorn.Comment`; next two as in `acorn.Comment`
- * but optional. Last is different as has to allow `undefined`
  * @local
  *
  * @typedef {{

dist/lib/espree.d.ts

@@ -29,6 +29,8 @@
  * `loc` and `range` are from `acorn.Token`
  *
  * Adds `regex`.
+ */
+/**
  * @local
  *
  * @typedef {{