@eslint/json 0.11.0 → 0.13.0

package/dist/esm/index.d.ts

@@ -1,59 +1,66 @@
-export type DocumentNode = import("@humanwhocodes/momoa").DocumentNode;
-export type JSONNode = import("@humanwhocodes/momoa").Node;
-export type JSONToken = import("@humanwhocodes/momoa").Token;
-export type SourceRange = import("@eslint/core").SourceRange;
-export type SourceLocation = import("@eslint/core").SourceLocation;
-export type File = import("@eslint/core").File;
-export type TraversalStep = import("@eslint/core").TraversalStep;
-export type VisitTraversalStep = import("@eslint/core").VisitTraversalStep;
-export type FileProblem = import("@eslint/core").FileProblem;
-export type DirectiveType = import("@eslint/core").DirectiveType;
-export type RulesConfig = import("@eslint/core").RulesConfig;
-export type IJSONSourceCode = import("./types.ts").IJSONSourceCode;
-export type JSONSyntaxElement = import("./types.ts").JSONSyntaxElement;
-export type Language = import("@eslint/core").Language;
-export type OkParseResult = import("@eslint/core").OkParseResult<DocumentNode>;
-export type ParseResult = import("@eslint/core").ParseResult<DocumentNode>;
-export type IJSONLanguage = import("./types.ts").IJSONLanguage;
-export type JSONLanguageOptions = import("./types.ts").JSONLanguageOptions;
+export type JSONOkParseResult = OkParseResult<DocumentNode>;
+export type JSONParseResult = ParseResult<DocumentNode>;
+export type JSONLanguageOptions = {
+    /**
+     * Whether to allow trailing commas in JSONC mode.
+     */
+    allowTrailingCommas?: boolean;
+};
 export type NoDuplicateKeysMessageIds = "duplicateKey";
-export type NoDuplicateKeysRuleDefinition = import("./types.ts").JSONRuleDefinition<[], NoDuplicateKeysMessageIds>;
-export type MemberNode = import("@humanwhocodes/momoa").MemberNode;
+export type NoDuplicateKeysRuleDefinition = JSONRuleDefinition<{
+    MessageIds: NoDuplicateKeysMessageIds;
+}>;
 export type NoEmptyKeysMessageIds = "emptyKey";
-export type NoEmptyKeysRuleDefinition = import("./types.ts").JSONRuleDefinition<[], NoEmptyKeysMessageIds>;
-export type NoUnsafeValuesMessageIds = "unsafeNumber" | "unsafeInteger" | "unsafeZero" | "subnormal" | "loneSurrogate";
-export type NoUnsafeValuesRuleDefinition = import("./types.ts").JSONRuleDefinition<[], NoUnsafeValuesMessageIds>;
+export type NoEmptyKeysRuleDefinition = JSONRuleDefinition<{
+    MessageIds: NoEmptyKeysMessageIds;
+}>;
 export type NoUnnormalizedKeysMessageIds = "unnormalizedKey";
-export type NoUnnormalizedKeysRuleDefinition = import("./types.ts").JSONRuleDefinition<[{
+export type NoUnnormalizedKeysOptions = {
     form: string;
-}], NoUnnormalizedKeysMessageIds>;
-export type SortKeysMessageIds = "sortKeys";
+};
+export type NoUnnormalizedKeysRuleDefinition = JSONRuleDefinition<{
+    RuleOptions: [NoUnnormalizedKeysOptions];
+    MessageIds: NoUnnormalizedKeysMessageIds;
+}>;
+export type NoUnsafeValuesMessageIds = "unsafeNumber" | "unsafeInteger" | "unsafeZero" | "subnormal" | "loneSurrogate";
+export type NoUnsafeValuesRuleDefinition = JSONRuleDefinition<{
+    MessageIds: NoUnsafeValuesMessageIds;
+}>;
 export type SortOptions = {
     caseSensitive: boolean;
     natural: boolean;
     minKeys: number;
     allowLineSeparatedGroups: boolean;
 };
+export type SortKeysMessageIds = "sortKeys";
 export type SortDirection = "asc" | "desc";
 export type SortKeysRuleOptions = [SortDirection, SortOptions];
-export type SortKeysRuleDefinition = import("./types.ts").JSONRuleDefinition<SortKeysRuleOptions, SortKeysMessageIds>;
+export type SortKeysRuleDefinition = JSONRuleDefinition<{
+    RuleOptions: SortKeysRuleOptions;
+    MessageIds: SortKeysMessageIds;
+}>;
 export type Comparator = (a: string, b: string) => boolean;
 export type TopLevelInteropMessageIds = "topLevel";
-export type TopLevelInteropRuleDefinition = import("./types.ts").JSONRuleDefinition<[], TopLevelInteropMessageIds>;
+export type TopLevelInteropRuleDefinition = JSONRuleDefinition<{
+    MessageIds: TopLevelInteropMessageIds;
+}>;
 /**
- * @filedescription Functions to fix up rules to provide missing methods on the `context` object.
+ * @fileoverview The JSONLanguage class.
  * @author Nicholas C. Zakas
  */
-/** @typedef {import("@eslint/core").Language} Language */
-/** @typedef {import("@eslint/core").OkParseResult<DocumentNode>} OkParseResult */
-/** @typedef {import("@eslint/core").ParseResult<DocumentNode>} ParseResult */
-/** @typedef {import("./types.ts").IJSONLanguage} IJSONLanguage */
-/** @typedef {import("./types.ts").JSONLanguageOptions} JSONLanguageOptions */
+/**
+ *
+ * @typedef {OkParseResult<DocumentNode>} JSONOkParseResult
+ * @typedef {ParseResult<DocumentNode>} JSONParseResult
+ *
+ * @typedef {Object} JSONLanguageOptions
+ * @property {boolean} [allowTrailingCommas] Whether to allow trailing commas in JSONC mode.
+ */
 /**
  * JSON Language Object
- * @implements {IJSONLanguage}
+ * @implements {Language<{ LangOptions: JSONLanguageOptions; Code: JSONSourceCode; RootNode: DocumentNode; Node: AnyNode }>}
  */
-export class JSONLanguage implements IJSONLanguage {
+export class JSONLanguage implements Language {
     /**
      * Creates a new instance.
      * @param {Object} options The options to use for this instance.
@@ -98,25 +105,30 @@ export class JSONLanguage implements IJSONLanguage {
      * Parses the given file into an AST.
      * @param {File} file The virtual file to parse.
      * @param {{languageOptions: JSONLanguageOptions}} context The options to use for parsing.
-     * @returns {ParseResult} The result of parsing.
+     * @returns {JSONParseResult} The result of parsing.
      */
     parse(file: File, context: {
         languageOptions: JSONLanguageOptions;
-    }): ParseResult;
+    }): JSONParseResult;
     /**
      * Creates a new `JSONSourceCode` object from the given information.
      * @param {File} file The virtual file to create a `JSONSourceCode` object from.
-     * @param {OkParseResult} parseResult The result returned from `parse()`.
+     * @param {JSONOkParseResult} parseResult The result returned from `parse()`.
      * @returns {JSONSourceCode} The new `JSONSourceCode` object.
      */
-    createSourceCode(file: File, parseResult: OkParseResult): JSONSourceCode;
+    createSourceCode(file: File, parseResult: JSONOkParseResult): JSONSourceCode;
     #private;
 }
 /**
  * JSON Source Code Object
- * @implements {IJSONSourceCode}
+ * @extends {TextSourceCodeBase<{LangOptions: JSONLanguageOptions, RootNode: DocumentNode, SyntaxElementWithLoc: JSONSyntaxElement, ConfigNode: Token}>}
  */
-export class JSONSourceCode extends TextSourceCodeBase implements IJSONSourceCode {
+export class JSONSourceCode extends TextSourceCodeBase<{
+    LangOptions: JSONLanguageOptions;
+    RootNode: DocumentNode;
+    SyntaxElementWithLoc: JSONSyntaxElement;
+    ConfigNode: Token;
+}> {
     /**
      * Creates a new instance.
      * @param {Object} options The options for the instance.
@@ -128,21 +140,16 @@ export class JSONSourceCode extends TextSourceCodeBase implements IJSONSourceCod
         ast: DocumentNode;
     });
     /**
-     * The AST of the source code.
-     * @type {DocumentNode}
+     * The comment tokens in the source code.
+     * @type {Array<Token>|undefined}
      */
-    ast: DocumentNode;
-    /**
-     * The comment node in the source code.
-     * @type {Array<JSONToken>|undefined}
-     */
-    comments: Array<JSONToken> | undefined;
+    comments: Array<Token> | undefined;
     /**
      * Returns an array of all inline configuration nodes found in the
      * source code.
-     * @returns {Array<JSONToken>} An array of all inline configuration nodes.
+     * @returns {Array<Token>} An array of all inline configuration nodes.
      */
-    getInlineConfigNodes(): Array<JSONToken>;
+    getInlineConfigNodes(): Array<Token>;
     /**
      * Returns directives that enable or disable rules along with any problems
      * encountered while parsing the directives.
@@ -170,50 +177,69 @@ export class JSONSourceCode extends TextSourceCodeBase implements IJSONSourceCod
     };
     /**
      * Returns the parent of the given node.
-     * @param {JSONNode} node The node to get the parent of.
-     * @returns {JSONNode|undefined} The parent of the node.
+     * @param {AnyNode} node The node to get the parent of.
+     * @returns {AnyNode|undefined} The parent of the node.
      */
-    getParent(node: JSONNode): JSONNode | undefined;
+    getParent(node: AnyNode): AnyNode | undefined;
     /**
      * Traverse the source code and return the steps that were taken.
      * @returns {Iterable<JSONTraversalStep>} The steps that were taken while traversing the source code.
      */
     traverse(): Iterable<JSONTraversalStep>;
+    /**
+     * Gets the token before the given node or token, optionally including comments.
+     * @param {AnyNode|Token} nodeOrToken The node or token to get the previous token for.
+     * @param {Object} [options] Options object.
+     * @param {boolean} [options.includeComments] If true, return comments when they are present.
+     * @returns {Token|null} The previous token or comment, or null if there is none.
+     */
+    getTokenBefore(nodeOrToken: AnyNode | Token, { includeComments }?: {
+        includeComments?: boolean;
+    }): Token | null;
+    /**
+     * Gets the token after the given node or token, skipping any comments unless includeComments is true.
+     * @param {AnyNode|Token} nodeOrToken The node or token to get the next token for.
+     * @param {Object} [options] Options object.
+     * @param {boolean} [options.includeComments=false] If true, return comments when they are present.
+     * @returns {Token|null} The next token or comment, or null if there is none.
+     */
+    getTokenAfter(nodeOrToken: AnyNode | Token, { includeComments }?: {
+        includeComments?: boolean;
+    }): Token | null;
     #private;
 }
 declare namespace plugin {
-    namespace meta {
+    export namespace meta {
         let name: string;
         let version: string;
     }
-    namespace languages {
+    export namespace languages {
         let json: JSONLanguage;
         let jsonc: JSONLanguage;
         let json5: JSONLanguage;
     }
-    let rules: {
-        "no-duplicate-keys": NoDuplicateKeysRuleDefinition;
-        "no-empty-keys": NoEmptyKeysRuleDefinition;
-        "no-unsafe-values": NoUnsafeValuesRuleDefinition;
-        "no-unnormalized-keys": NoUnnormalizedKeysRuleDefinition;
-        "sort-keys": SortKeysRuleDefinition;
-        "top-level-interop": TopLevelInteropRuleDefinition;
-    };
-    namespace configs {
+    export { rules };
+    export namespace configs {
         namespace recommended {
             export let plugins: {};
-            let rules_1: {
-                readonly "json/no-duplicate-keys": "error";
-                readonly "json/no-empty-keys": "error";
-                readonly "json/no-unsafe-values": "error";
-                readonly "json/no-unnormalized-keys": "error";
-            };
-            export { rules_1 as rules };
+            export { rules$1 as rules };
         }
     }
 }
+import type { DocumentNode } from "@humanwhocodes/momoa";
+import type { OkParseResult } from "@eslint/core";
+import type { ParseResult } from "@eslint/core";
+import type { JSONRuleDefinition } from "./types.ts";
+import type { Language } from "@eslint/core";
+import type { File } from "@eslint/core";
+import type { JSONSyntaxElement } from "./types.ts";
+import type { Token } from "@humanwhocodes/momoa";
 import { TextSourceCodeBase } from '@eslint/plugin-kit';
+import type { FileProblem } from "@eslint/core";
 import { Directive } from '@eslint/plugin-kit';
+import type { RulesConfig } from "@eslint/core";
+import type { SourceLocation } from "@eslint/core";
+import type { AnyNode } from "@humanwhocodes/momoa";
 /**
  * A class to represent a step in the traversal process.
  */
@@ -221,20 +247,34 @@ declare class JSONTraversalStep extends VisitNodeStep {
     /**
      * Creates a new instance.
      * @param {Object} options The options for the step.
-     * @param {JSONNode} options.target The target of the step.
+     * @param {AnyNode} options.target The target of the step.
      * @param {1|2} options.phase The phase of the step.
      * @param {Array<any>} options.args The arguments of the step.
      */
     constructor({ target, phase, args }: {
-        target: JSONNode;
+        target: AnyNode;
         phase: 1 | 2;
         args: Array<any>;
     });
     /**
      * The target of the step.
-     * @type {JSONNode}
+     * @type {AnyNode}
      */
-    target: JSONNode;
+    target: AnyNode;
 }
+declare var rules: {
+    "no-duplicate-keys": NoDuplicateKeysRuleDefinition;
+    "no-empty-keys": NoEmptyKeysRuleDefinition;
+    "no-unnormalized-keys": NoUnnormalizedKeysRuleDefinition;
+    "no-unsafe-values": NoUnsafeValuesRuleDefinition;
+    "sort-keys": SortKeysRuleDefinition;
+    "top-level-interop": TopLevelInteropRuleDefinition;
+};
+declare const rules$1: {
+    readonly "json/no-duplicate-keys": "error";
+    readonly "json/no-empty-keys": "error";
+    readonly "json/no-unnormalized-keys": "error";
+    readonly "json/no-unsafe-values": "error";
+};
 import { VisitNodeStep } from '@eslint/plugin-kit';
 export { plugin as default };