@eslint/json 0.12.0 → 0.13.1

package/dist/cjs/index.d.cts

@@ -14,10 +14,6 @@ export type NoEmptyKeysMessageIds = "emptyKey";
 export type NoEmptyKeysRuleDefinition = JSONRuleDefinition<{
     MessageIds: NoEmptyKeysMessageIds;
 }>;
-export type NoUnsafeValuesMessageIds = "unsafeNumber" | "unsafeInteger" | "unsafeZero" | "subnormal" | "loneSurrogate";
-export type NoUnsafeValuesRuleDefinition = JSONRuleDefinition<{
-    MessageIds: NoUnsafeValuesMessageIds;
-}>;
 export type NoUnnormalizedKeysMessageIds = "unnormalizedKey";
 export type NoUnnormalizedKeysOptions = {
     form: string;
@@ -26,6 +22,10 @@ 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;
@@ -45,7 +45,7 @@ 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
  */
 /**
@@ -121,9 +121,14 @@ export class JSONLanguage implements Language {
 }
 /**
  * JSON Source Code Object
- * @implements {TextSourceCode<{LangOptions: JSONLanguageOptions, RootNode: DocumentNode, SyntaxElementWithLoc: JSONSyntaxElement, ConfigNode: Token}>}
+ * @extends {TextSourceCodeBase<{LangOptions: JSONLanguageOptions, RootNode: DocumentNode, SyntaxElementWithLoc: JSONSyntaxElement, ConfigNode: Token}>}
  */
-export class JSONSourceCode extends TextSourceCodeBase implements TextSourceCode {
+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.
@@ -135,12 +140,7 @@ export class JSONSourceCode extends TextSourceCodeBase implements TextSourceCode
         ast: DocumentNode;
     });
     /**
-     * The AST of the source code.
-     * @type {DocumentNode}
-     */
-    ast: DocumentNode;
-    /**
-     * The comment node in the source code.
+     * The comment tokens in the source code.
      * @type {Array<Token>|undefined}
      */
     comments: Array<Token> | undefined;
@@ -177,45 +177,52 @@ export class JSONSourceCode extends TextSourceCodeBase implements TextSourceCode
     };
     /**
      * Returns the parent of the given node.
-     * @param {Node} node The node to get the parent of.
-     * @returns {Node|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: Node): Node | 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 };
         }
     }
 }
@@ -225,14 +232,14 @@ import type { ParseResult } from "@eslint/core";
 import type { JSONRuleDefinition } from "./types.cts";
 import type { Language } from "@eslint/core";
 import type { File } from "@eslint/core";
-import type { TextSourceCode } from "@eslint/core";
-import { TextSourceCodeBase } from '@eslint/plugin-kit';
+import type { JSONSyntaxElement } from "./types.cts";
 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 { Node } from "@humanwhocodes/momoa";
+import type { AnyNode } from "@humanwhocodes/momoa";
 /**
  * A class to represent a step in the traversal process.
  */
@@ -240,20 +247,34 @@ declare class JSONTraversalStep extends VisitNodeStep {
     /**
      * Creates a new instance.
      * @param {Object} options The options for the step.
-     * @param {Node} 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: Node;
+        target: AnyNode;
         phase: 1 | 2;
         args: Array<any>;
     });
     /**
      * The target of the step.
-     * @type {Node}
+     * @type {AnyNode}
      */
-    target: Node;
+    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 };

package/dist/cjs/types.cts

@@ -7,7 +7,11 @@
 // Imports
 //------------------------------------------------------------------------------
 
-import type { RuleVisitor, RuleDefinition } from "@eslint/core";
+import type {
+	CustomRuleDefinitionType,
+	CustomRuleTypeDefinitions,
+	RuleVisitor,
+} from "@eslint/core";
 import type {
 	DocumentNode,
 	MemberNode,
@@ -68,25 +72,16 @@ export interface JSONRuleVisitor extends RuleVisitor {
 	"Identifier:exit"?(node: IdentifierNode, parent?: ValueNodeParent): void;
 }
 
-export type JSONRuleDefinitionTypeOptions = {
-	RuleOptions: unknown[];
-	MessageIds: string;
-	ExtRuleDocs: Record<string, unknown>;
-};
+export type JSONRuleDefinitionTypeOptions = CustomRuleTypeDefinitions;
 
 export type JSONRuleDefinition<
 	Options extends Partial<JSONRuleDefinitionTypeOptions> = {},
-> = RuleDefinition<
-	// Language specific type options (non-configurable)
+> = CustomRuleDefinitionType<
 	{
 		LangOptions: JSONLanguageOptions;
 		Code: JSONSourceCode;
 		Visitor: JSONRuleVisitor;
 		Node: AnyNode;
-	} & Required<
-		// Rule specific type options (custom)
-		Options &
-			// Rule specific type options (defaults)
-			Omit<JSONRuleDefinitionTypeOptions, keyof Options>
-	>
+	},
+	Options
 >;

package/dist/esm/index.d.ts

@@ -14,10 +14,6 @@ export type NoEmptyKeysMessageIds = "emptyKey";
 export type NoEmptyKeysRuleDefinition = JSONRuleDefinition<{
     MessageIds: NoEmptyKeysMessageIds;
 }>;
-export type NoUnsafeValuesMessageIds = "unsafeNumber" | "unsafeInteger" | "unsafeZero" | "subnormal" | "loneSurrogate";
-export type NoUnsafeValuesRuleDefinition = JSONRuleDefinition<{
-    MessageIds: NoUnsafeValuesMessageIds;
-}>;
 export type NoUnnormalizedKeysMessageIds = "unnormalizedKey";
 export type NoUnnormalizedKeysOptions = {
     form: string;
@@ -26,6 +22,10 @@ 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;
@@ -45,7 +45,7 @@ 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
  */
 /**
@@ -121,9 +121,14 @@ export class JSONLanguage implements Language {
 }
 /**
  * JSON Source Code Object
- * @implements {TextSourceCode<{LangOptions: JSONLanguageOptions, RootNode: DocumentNode, SyntaxElementWithLoc: JSONSyntaxElement, ConfigNode: Token}>}
+ * @extends {TextSourceCodeBase<{LangOptions: JSONLanguageOptions, RootNode: DocumentNode, SyntaxElementWithLoc: JSONSyntaxElement, ConfigNode: Token}>}
  */
-export class JSONSourceCode extends TextSourceCodeBase implements TextSourceCode {
+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.
@@ -135,12 +140,7 @@ export class JSONSourceCode extends TextSourceCodeBase implements TextSourceCode
         ast: DocumentNode;
     });
     /**
-     * The AST of the source code.
-     * @type {DocumentNode}
-     */
-    ast: DocumentNode;
-    /**
-     * The comment node in the source code.
+     * The comment tokens in the source code.
      * @type {Array<Token>|undefined}
      */
     comments: Array<Token> | undefined;
@@ -177,45 +177,52 @@ export class JSONSourceCode extends TextSourceCodeBase implements TextSourceCode
     };
     /**
      * Returns the parent of the given node.
-     * @param {Node} node The node to get the parent of.
-     * @returns {Node|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: Node): Node | 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 };
         }
     }
 }
@@ -225,14 +232,14 @@ 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 { TextSourceCode } from "@eslint/core";
-import { TextSourceCodeBase } from '@eslint/plugin-kit';
+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 { Node } from "@humanwhocodes/momoa";
+import type { AnyNode } from "@humanwhocodes/momoa";
 /**
  * A class to represent a step in the traversal process.
  */
@@ -240,20 +247,34 @@ declare class JSONTraversalStep extends VisitNodeStep {
     /**
      * Creates a new instance.
      * @param {Object} options The options for the step.
-     * @param {Node} 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: Node;
+        target: AnyNode;
         phase: 1 | 2;
         args: Array<any>;
     });
     /**
      * The target of the step.
-     * @type {Node}
+     * @type {AnyNode}
      */
-    target: Node;
+    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 };