@eslint-react/jsx 0.6.0 → 0.6.1

package/dist/index.d.mts

@@ -1,8 +1,8 @@
 import { TSESTree } from '@typescript-eslint/types';
 import { RuleContext } from '@eslint-react/types';
 import { TSESTreeFunction } from '@eslint-react/ast';
-import { TSESTree as TSESTree$1 } from '@typescript-eslint/utils';
 import { O } from '@eslint-react/tools';
+import { TSESTree as TSESTree$1 } from '@typescript-eslint/utils';
 
 /**
  * Check if a `JSXElement` or `JSXFragment` has children
@@ -121,37 +121,49 @@ declare function isFragmentWithOnlyTextAndIsNotChild(node: TSESTree.JSXElement |
 declare function isFragmentHasLessThanTwoChildren(node: TSESTree.JSXElement | TSESTree.JSXFragment): boolean;
 declare function isFragmentWithSingleExpression(node: TSESTree.JSXElement | TSESTree.JSXFragment): boolean;
 
-type JSXValueCheckOptions = {
-    /**
-     * Whether to check all branches of the conditional expression
-     */
-    strict?: boolean;
-    /**
-     * Whether to ignore null values
-     */
-    ignoreNull?: boolean;
-};
-declare const defaultJSXValueCheckOptions: {
-    readonly ignoreNull: false;
-    readonly strict: false;
-};
 /**
- * Check if a node is a JSX value
- * @param node The AST node to check
+ * Check if function is returning JSX
+ * @param node The return statement node to check
  * @param context The rule context
- * @param options The `JSXValueCheckOptions` to use
+ * @param hint The `JSXValueCheckHint` to use
  * @returns boolean
  */
-declare function isJSXValue(node: TSESTree$1.Node | null | undefined, context: RuleContext, options?: JSXValueCheckOptions): boolean;
+declare function isFunctionReturningJSXValue(node: TSESTreeFunction, context: RuleContext, hint?: 0n): boolean;
 
 /**
- * Check if function is returning JSX
- * @param node The return statement node to check
+ * @param attributes The attributes to search in
  * @param context The rule context
- * @param options The JSX value check options
- * @returns boolean
+ * @returns A function that searches for a property in the given attributes
+ */
+declare function findPropInAttributes(attributes: (TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute)[], context: RuleContext): (propName: string) => O.Option<NonNullable<TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute | undefined>>;
+
+/**
+ * @param properties The properties to search in
+ * @param context The rule context
+ * @param seenProps The properties that have already been seen
+ * @returns A function that searches for a property in the given properties
+ */
+declare function findPropInProperties(properties: (TSESTree.Property | TSESTree.RestElement | TSESTree.SpreadElement)[] | TSESTree.ObjectLiteralElement[], context: RuleContext, seenProps?: string[]): (propName: string) => O.Option<(typeof properties)[number]>;
+
+declare function getProp(props: TSESTree.JSXAttribute[], propName: string, context: RuleContext): O.Option<TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute>;
+/**
+ * Gets and resolves the static value of a JSX attribute
+ * @param attribute The JSX attribute to get the value of
+ * @param context The rule context
+ * @returns  The static value of the given JSX attribute
  */
-declare function isFunctionReturningJSXValue(node: TSESTreeFunction, context: RuleContext, options?: JSXValueCheckOptions): boolean;
+declare function getPropValue(attribute: TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute, context: RuleContext): O.None<{
+    value: unknown;
+} | null> | O.Some<{
+    value: unknown;
+} | null>;
+
+/**
+ * Get the name of a JSX attribute with namespace
+ * @param node The JSX attribute node
+ * @returns string
+ */
+declare function getPropName(node: TSESTree.JSXAttribute): string;
 
 /**
  * Check if the given prop name is present in the given attributes
@@ -177,18 +189,14 @@ declare function hasAnyProp(attributes: (TSESTree.JSXAttribute | TSESTree.JSXSpr
  * @returns `true` if all of the given prop names are present in the given attributes
  */
 declare function hasEveryProp(attributes: (TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute)[], propNames: string[], context: RuleContext): boolean;
+
 /**
- * Get the name of a JSX attribute
- * @param node The JSX attribute node
- * @returns string
- */
-declare function getPropName(node: TSESTree.JSXAttribute): string;
-/**
- * Get the name of a JSX attribute with namespace
- * @param node The JSX attribute node
- * @returns string
+ * Checks if the node is inside a prop's value
+ * @param node The AST node to check
+ * @returns `true` if the node is inside a prop's value
  */
-declare function getPropNameWithNamespace(node: TSESTree.JSXAttribute): string;
+declare function isInsidePropValue(node: TSESTree.Node): boolean;
+
 /**
  * Traverses up prop node
  * @param node The AST node to start traversing from
@@ -196,36 +204,6 @@ declare function getPropNameWithNamespace(node: TSESTree.JSXAttribute): string;
  * @returns prop node if found
  */
 declare function traverseUpProp(node: TSESTree.Node, predicate?: (node: TSESTree.JSXAttribute) => boolean): O.Option<TSESTree.JSXAttribute>;
-/**
- * Checks if the node is inside a prop's value
- * @param node The AST node to check
- * @returns `true` if the node is inside a prop's value
- */
-declare function isInsidePropValue(node: TSESTree.Node): boolean;
-/**
- * @param properties The properties to search in
- * @param context The rule context
- * @param seenProps The properties that have already been seen
- * @returns A function that searches for a property in the given properties
- */
-declare function findPropInProperties(properties: (TSESTree.Property | TSESTree.RestElement)[] | TSESTree.ObjectLiteralElement[], context: RuleContext, seenProps?: string[]): (propName: string) => O.Option<(typeof properties)[number]>;
-/**
- * @param attributes The attributes to search in
- * @param context The rule context
- * @returns A function that searches for a property in the given attributes
- */
-declare function findPropInAttributes(attributes: (TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute)[], context: RuleContext): (propName: string) => O.Option<NonNullable<TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute | undefined>>;
-/**
- * Gets and resolves the static value of a JSX attribute
- * @param attribute The JSX attribute to get the value of
- * @param context The rule context
- * @returns  The static value of the given JSX attribute
- */
-declare function getPropValue(attribute: TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute, context: RuleContext): O.None<{
-    value: unknown;
-} | null> | O.Some<{
-    value: unknown;
-} | null>;
 
 /**
  * Check if a node is a Literal or JSXText
@@ -252,4 +230,20 @@ declare function isLineBreak(node: TSESTree.Node): boolean;
  */
 declare function isPaddingSpaces(node: TSESTree.Node): boolean;
 
-export { type CallFromPragmaPredicate, type JSXValueCheckOptions, defaultJSXValueCheckOptions, elementType, findPropInAttributes, findPropInProperties, getFragmentFromContext, getPragmaFromContext, getPropName, getPropNameWithNamespace, getPropValue, hasAnyProp, hasChildren, hasEveryProp, hasProp, hdlAnimation, hdlClipboard, hdlComposition, hdlFocus, hdlForm, hdlImage, hdlKeyboard, hdlMedia, hdlMouse, hdlScroll, hdlSelection, hdlTouch, hdlTransition, hdlWheel, isCallFromPragma, isChildOfJSXElement, isChildrenOfCreateElement, isCloneElementCall, isCreateElementCall, isFragment, isFragmentElement, isFragmentHasLessThanTwoChildren, isFragmentSyntax, isFragmentWithOnlyTextAndIsNotChild, isFragmentWithSingleExpression, isFunctionReturningJSXValue, isInitializedFromPragma, isInsideCreateElementProps, isInsidePropValue, isJSXElementOfBuiltinComponent, isJSXElementOfUserDefinedComponent, isJSXValue, isLineBreak, isLiteral, isPaddingSpaces, isPropertyOfPragma, isWhiteSpace, traverseUpProp };
+declare const JSXValueCheckHint: {
+    readonly None: 0n;
+    readonly IgnoreNull: bigint;
+    readonly IgnoreCreateElement: bigint;
+    readonly StrictLogical: bigint;
+    readonly StrictConditional: bigint;
+};
+/**
+ * Check if a node is a JSX value
+ * @param node The AST node to check
+ * @param context The rule context
+ * @param hint The `JSXValueCheckHint` to use
+ * @returns boolean
+ */
+declare function isJSXValue(node: TSESTree$1.Node | null | undefined, context: RuleContext, hint?: bigint): boolean;
+
+export { type CallFromPragmaPredicate, JSXValueCheckHint, elementType, findPropInAttributes, findPropInProperties, getFragmentFromContext, getPragmaFromContext, getProp, getPropName, getPropValue, hasAnyProp, hasChildren, hasEveryProp, hasProp, hdlAnimation, hdlClipboard, hdlComposition, hdlFocus, hdlForm, hdlImage, hdlKeyboard, hdlMedia, hdlMouse, hdlScroll, hdlSelection, hdlTouch, hdlTransition, hdlWheel, isCallFromPragma, isChildOfJSXElement, isChildrenOfCreateElement, isCloneElementCall, isCreateElementCall, isFragment, isFragmentElement, isFragmentHasLessThanTwoChildren, isFragmentSyntax, isFragmentWithOnlyTextAndIsNotChild, isFragmentWithSingleExpression, isFunctionReturningJSXValue, isInitializedFromPragma, isInsideCreateElementProps, isInsidePropValue, isJSXElementOfBuiltinComponent, isJSXElementOfUserDefinedComponent, isJSXValue, isLineBreak, isLiteral, isPaddingSpaces, isPropertyOfPragma, isWhiteSpace, traverseUpProp };

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import { TSESTree } from '@typescript-eslint/types';
 import { RuleContext } from '@eslint-react/types';
 import { TSESTreeFunction } from '@eslint-react/ast';
-import { TSESTree as TSESTree$1 } from '@typescript-eslint/utils';
 import { O } from '@eslint-react/tools';
+import { TSESTree as TSESTree$1 } from '@typescript-eslint/utils';
 
 /**
  * Check if a `JSXElement` or `JSXFragment` has children
@@ -121,37 +121,49 @@ declare function isFragmentWithOnlyTextAndIsNotChild(node: TSESTree.JSXElement |
 declare function isFragmentHasLessThanTwoChildren(node: TSESTree.JSXElement | TSESTree.JSXFragment): boolean;
 declare function isFragmentWithSingleExpression(node: TSESTree.JSXElement | TSESTree.JSXFragment): boolean;
 
-type JSXValueCheckOptions = {
-    /**
-     * Whether to check all branches of the conditional expression
-     */
-    strict?: boolean;
-    /**
-     * Whether to ignore null values
-     */
-    ignoreNull?: boolean;
-};
-declare const defaultJSXValueCheckOptions: {
-    readonly ignoreNull: false;
-    readonly strict: false;
-};
 /**
- * Check if a node is a JSX value
- * @param node The AST node to check
+ * Check if function is returning JSX
+ * @param node The return statement node to check
  * @param context The rule context
- * @param options The `JSXValueCheckOptions` to use
+ * @param hint The `JSXValueCheckHint` to use
  * @returns boolean
  */
-declare function isJSXValue(node: TSESTree$1.Node | null | undefined, context: RuleContext, options?: JSXValueCheckOptions): boolean;
+declare function isFunctionReturningJSXValue(node: TSESTreeFunction, context: RuleContext, hint?: 0n): boolean;
 
 /**
- * Check if function is returning JSX
- * @param node The return statement node to check
+ * @param attributes The attributes to search in
  * @param context The rule context
- * @param options The JSX value check options
- * @returns boolean
+ * @returns A function that searches for a property in the given attributes
+ */
+declare function findPropInAttributes(attributes: (TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute)[], context: RuleContext): (propName: string) => O.Option<NonNullable<TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute | undefined>>;
+
+/**
+ * @param properties The properties to search in
+ * @param context The rule context
+ * @param seenProps The properties that have already been seen
+ * @returns A function that searches for a property in the given properties
+ */
+declare function findPropInProperties(properties: (TSESTree.Property | TSESTree.RestElement | TSESTree.SpreadElement)[] | TSESTree.ObjectLiteralElement[], context: RuleContext, seenProps?: string[]): (propName: string) => O.Option<(typeof properties)[number]>;
+
+declare function getProp(props: TSESTree.JSXAttribute[], propName: string, context: RuleContext): O.Option<TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute>;
+/**
+ * Gets and resolves the static value of a JSX attribute
+ * @param attribute The JSX attribute to get the value of
+ * @param context The rule context
+ * @returns  The static value of the given JSX attribute
  */
-declare function isFunctionReturningJSXValue(node: TSESTreeFunction, context: RuleContext, options?: JSXValueCheckOptions): boolean;
+declare function getPropValue(attribute: TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute, context: RuleContext): O.None<{
+    value: unknown;
+} | null> | O.Some<{
+    value: unknown;
+} | null>;
+
+/**
+ * Get the name of a JSX attribute with namespace
+ * @param node The JSX attribute node
+ * @returns string
+ */
+declare function getPropName(node: TSESTree.JSXAttribute): string;
 
 /**
  * Check if the given prop name is present in the given attributes
@@ -177,18 +189,14 @@ declare function hasAnyProp(attributes: (TSESTree.JSXAttribute | TSESTree.JSXSpr
  * @returns `true` if all of the given prop names are present in the given attributes
  */
 declare function hasEveryProp(attributes: (TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute)[], propNames: string[], context: RuleContext): boolean;
+
 /**
- * Get the name of a JSX attribute
- * @param node The JSX attribute node
- * @returns string
- */
-declare function getPropName(node: TSESTree.JSXAttribute): string;
-/**
- * Get the name of a JSX attribute with namespace
- * @param node The JSX attribute node
- * @returns string
+ * Checks if the node is inside a prop's value
+ * @param node The AST node to check
+ * @returns `true` if the node is inside a prop's value
  */
-declare function getPropNameWithNamespace(node: TSESTree.JSXAttribute): string;
+declare function isInsidePropValue(node: TSESTree.Node): boolean;
+
 /**
  * Traverses up prop node
  * @param node The AST node to start traversing from
@@ -196,36 +204,6 @@ declare function getPropNameWithNamespace(node: TSESTree.JSXAttribute): string;
  * @returns prop node if found
  */
 declare function traverseUpProp(node: TSESTree.Node, predicate?: (node: TSESTree.JSXAttribute) => boolean): O.Option<TSESTree.JSXAttribute>;
-/**
- * Checks if the node is inside a prop's value
- * @param node The AST node to check
- * @returns `true` if the node is inside a prop's value
- */
-declare function isInsidePropValue(node: TSESTree.Node): boolean;
-/**
- * @param properties The properties to search in
- * @param context The rule context
- * @param seenProps The properties that have already been seen
- * @returns A function that searches for a property in the given properties
- */
-declare function findPropInProperties(properties: (TSESTree.Property | TSESTree.RestElement)[] | TSESTree.ObjectLiteralElement[], context: RuleContext, seenProps?: string[]): (propName: string) => O.Option<(typeof properties)[number]>;
-/**
- * @param attributes The attributes to search in
- * @param context The rule context
- * @returns A function that searches for a property in the given attributes
- */
-declare function findPropInAttributes(attributes: (TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute)[], context: RuleContext): (propName: string) => O.Option<NonNullable<TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute | undefined>>;
-/**
- * Gets and resolves the static value of a JSX attribute
- * @param attribute The JSX attribute to get the value of
- * @param context The rule context
- * @returns  The static value of the given JSX attribute
- */
-declare function getPropValue(attribute: TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute, context: RuleContext): O.None<{
-    value: unknown;
-} | null> | O.Some<{
-    value: unknown;
-} | null>;
 
 /**
  * Check if a node is a Literal or JSXText
@@ -252,4 +230,20 @@ declare function isLineBreak(node: TSESTree.Node): boolean;
  */
 declare function isPaddingSpaces(node: TSESTree.Node): boolean;
 
-export { type CallFromPragmaPredicate, type JSXValueCheckOptions, defaultJSXValueCheckOptions, elementType, findPropInAttributes, findPropInProperties, getFragmentFromContext, getPragmaFromContext, getPropName, getPropNameWithNamespace, getPropValue, hasAnyProp, hasChildren, hasEveryProp, hasProp, hdlAnimation, hdlClipboard, hdlComposition, hdlFocus, hdlForm, hdlImage, hdlKeyboard, hdlMedia, hdlMouse, hdlScroll, hdlSelection, hdlTouch, hdlTransition, hdlWheel, isCallFromPragma, isChildOfJSXElement, isChildrenOfCreateElement, isCloneElementCall, isCreateElementCall, isFragment, isFragmentElement, isFragmentHasLessThanTwoChildren, isFragmentSyntax, isFragmentWithOnlyTextAndIsNotChild, isFragmentWithSingleExpression, isFunctionReturningJSXValue, isInitializedFromPragma, isInsideCreateElementProps, isInsidePropValue, isJSXElementOfBuiltinComponent, isJSXElementOfUserDefinedComponent, isJSXValue, isLineBreak, isLiteral, isPaddingSpaces, isPropertyOfPragma, isWhiteSpace, traverseUpProp };
+declare const JSXValueCheckHint: {
+    readonly None: 0n;
+    readonly IgnoreNull: bigint;
+    readonly IgnoreCreateElement: bigint;
+    readonly StrictLogical: bigint;
+    readonly StrictConditional: bigint;
+};
+/**
+ * Check if a node is a JSX value
+ * @param node The AST node to check
+ * @param context The rule context
+ * @param hint The `JSXValueCheckHint` to use
+ * @returns boolean
+ */
+declare function isJSXValue(node: TSESTree$1.Node | null | undefined, context: RuleContext, hint?: bigint): boolean;
+
+export { type CallFromPragmaPredicate, JSXValueCheckHint, elementType, findPropInAttributes, findPropInProperties, getFragmentFromContext, getPragmaFromContext, getProp, getPropName, getPropValue, hasAnyProp, hasChildren, hasEveryProp, hasProp, hdlAnimation, hdlClipboard, hdlComposition, hdlFocus, hdlForm, hdlImage, hdlKeyboard, hdlMedia, hdlMouse, hdlScroll, hdlSelection, hdlTouch, hdlTransition, hdlWheel, isCallFromPragma, isChildOfJSXElement, isChildrenOfCreateElement, isCloneElementCall, isCreateElementCall, isFragment, isFragmentElement, isFragmentHasLessThanTwoChildren, isFragmentSyntax, isFragmentWithOnlyTextAndIsNotChild, isFragmentWithSingleExpression, isFunctionReturningJSXValue, isInitializedFromPragma, isInsideCreateElementProps, isInsidePropValue, isJSXElementOfBuiltinComponent, isJSXElementOfUserDefinedComponent, isJSXValue, isLineBreak, isLiteral, isPaddingSpaces, isPropertyOfPragma, isWhiteSpace, traverseUpProp };