@eslint-react/jsx 0.5.7 → 0.5.9

package/dist/index.d.mts

@@ -1,30 +1,53 @@
 import { TSESTree } from '@typescript-eslint/types';
 import { RuleContext } from '@eslint-react/types';
-import { TSESTree as TSESTree$1 } from '@typescript-eslint/utils';
 import { TSESTreeFunction } from '@eslint-react/ast';
-import { E, O } from '@eslint-react/tools';
+import { TSESTree as TSESTree$1 } from '@typescript-eslint/utils';
+import { O } from '@eslint-react/tools';
 
 /**
- * Check if a JSXElement or JSXFragment has children
+ * Check if a `JSXElement` or `JSXFragment` has children
  * @param node The AST node to check
+ * @param predicate A predicate to filter the children
  * @returns `true` if the node has children
  */
-declare function hasChildren(node: TSESTree.JSXElement | TSESTree.JSXFragment): boolean;
+declare function hasChildren(node: TSESTree.JSXElement | TSESTree.JSXFragment, predicate?: (node: TSESTree.JSXChild) => boolean): boolean;
+/**
+ * Check if a node is a child of a `JSXElement`
+ * @param node The AST node to check
+ * @returns `true` if the node is a child of a `JSXElement`
+ */
+declare function isChildOfJSXElement(node: TSESTree.Node): node is TSESTree.JSXElement & {
+    parent: TSESTree.JSXElement;
+};
 
 declare function isChildrenOfCreateElement(node: TSESTree.Node, context: RuleContext): boolean;
 
-declare function getFragmentFromContext<T extends RuleContext>(context: T): E.Either<Error, string>;
-declare const getPragmaFromContext: <T extends RuleContext>(context: T) => E.Either<Error, string>;
+/**
+ * Check if a node is a `JSXElement` of `User-Defined Component` type
+ * @param node The AST node to check
+ * @returns `true` if the node is a `JSXElement` of `User-Defined Component` type
+ */
+declare function isJSXElementOfUserDefinedComponent(node: TSESTree.Node): node is TSESTree.JSXElement;
+/**
+ * Check if a node is a `JSXFragment` of `Built-in Component` type
+ * @param node The AST node to check
+ * @returns `true` if the node is a `JSXFragment` of `Built-in Component` type
+ */
+declare function isJSXElementOfBuiltinComponent(node: TSESTree.Node): node is TSESTree.JSXFragment;
+
+declare function getFragmentFromContext<T extends RuleContext>(context: T): string;
+declare const getPragmaFromContext: <T extends RuleContext>(context: T) => string;
 
-type CallFromPragmaPredicate = (node: TSESTree$1.Node, context: RuleContext) => node is TSESTree$1.CallExpression;
+declare function isInitializedFromPragma(variableName: string, context: RuleContext, pragma?: string): boolean;
+type CallFromPragmaPredicate = (node: TSESTree.Node, context: RuleContext) => node is TSESTree.CallExpression;
 /**
  * Checks if the given node is a call expression to the given function or method of the pragma
  * @param name The name of the function or method to check
  * @returns A predicate that checks if the given node is a call expression to the given function or method
  */
-declare const isCallFromPragma: (name: string) => (node: TSESTree$1.Node, context: RuleContext) => node is TSESTree$1.CallExpression;
+declare function isCallFromPragma(name: string): (node: TSESTree.Node, context: RuleContext) => node is TSESTree.CallExpression;
 
-declare function isDestructuredFromPragma<T extends RuleContext>(variableName: string, context: T): boolean;
+declare function isPropertyOfPragma(name: string, context: RuleContext, pragma?: string): (node: TSESTree.Node) => boolean;
 
 /**
  * Checks if the given node is a call expression to `createElement`
@@ -71,6 +94,33 @@ declare const hdlTransition: readonly ["onTransitionEnd"];
 declare const hdlScroll: readonly ["onScroll"];
 declare const hdlWheel: readonly ["onWheel"];
 
+declare const isFragment: (node: TSESTree.Node, pragma: string, fragment: string) => node is TSESTree.JSXElement | TSESTree.JSXFragment;
+/**
+ * Check if a node is `<></>`
+ */
+declare const isFragmentSyntax: (node: TSESTree.Node | null | undefined) => node is TSESTree.JSXFragment;
+/**
+ * Check if a node is `<Fragment></Fragment>` or `<Pragma.Fragment></Pragma.Fragment>`
+ * @param node
+ * @param pragma
+ * @param fragment
+ */
+declare function isFragmentElement(node: TSESTree.JSXElement, pragma: string, fragment: string): boolean;
+/**
+ * Check if a JSXElement or JSXFragment has only one literal child and is not a child
+ * @param node The AST node to check
+ * @returns `true` if the node has only one literal child and is not a child
+ * @example Somehow fragment like this is useful: <Foo content={<>ee eeee eeee ...</>} />
+ */
+declare function isFragmentWithOnlyTextAndIsNotChild(node: TSESTree.JSXElement | TSESTree.JSXFragment): boolean;
+/**
+ * Check if a JSXElement or JSXFragment has less than two non-padding children and the first child is not a call expression
+ * @param node The AST node to check
+ * @returns boolean
+ */
+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
@@ -165,6 +215,12 @@ declare function findPropInProperties(properties: (TSESTree.Property | TSESTree.
  * @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<{
@@ -189,5 +245,11 @@ declare function isWhiteSpace(node: TSESTree.JSXText | TSESTree.Literal): boolea
  * @returns boolean
  */
 declare function isLineBreak(node: TSESTree.Node): boolean;
+/**
+ * Check if a Literal or JSXText node is padding spaces
+ * @param node The AST node to check
+ * @returns 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, isChildrenOfCreateElement, isCloneElementCall, isCreateElementCall, isDestructuredFromPragma, isFunctionReturningJSXValue, isInsideCreateElementProps, isInsidePropValue, isJSXValue, isLineBreak, isLiteral, isWhiteSpace, traverseUpProp };
+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 };

package/dist/index.d.ts

@@ -1,30 +1,53 @@
 import { TSESTree } from '@typescript-eslint/types';
 import { RuleContext } from '@eslint-react/types';
-import { TSESTree as TSESTree$1 } from '@typescript-eslint/utils';
 import { TSESTreeFunction } from '@eslint-react/ast';
-import { E, O } from '@eslint-react/tools';
+import { TSESTree as TSESTree$1 } from '@typescript-eslint/utils';
+import { O } from '@eslint-react/tools';
 
 /**
- * Check if a JSXElement or JSXFragment has children
+ * Check if a `JSXElement` or `JSXFragment` has children
  * @param node The AST node to check
+ * @param predicate A predicate to filter the children
  * @returns `true` if the node has children
  */
-declare function hasChildren(node: TSESTree.JSXElement | TSESTree.JSXFragment): boolean;
+declare function hasChildren(node: TSESTree.JSXElement | TSESTree.JSXFragment, predicate?: (node: TSESTree.JSXChild) => boolean): boolean;
+/**
+ * Check if a node is a child of a `JSXElement`
+ * @param node The AST node to check
+ * @returns `true` if the node is a child of a `JSXElement`
+ */
+declare function isChildOfJSXElement(node: TSESTree.Node): node is TSESTree.JSXElement & {
+    parent: TSESTree.JSXElement;
+};
 
 declare function isChildrenOfCreateElement(node: TSESTree.Node, context: RuleContext): boolean;
 
-declare function getFragmentFromContext<T extends RuleContext>(context: T): E.Either<Error, string>;
-declare const getPragmaFromContext: <T extends RuleContext>(context: T) => E.Either<Error, string>;
+/**
+ * Check if a node is a `JSXElement` of `User-Defined Component` type
+ * @param node The AST node to check
+ * @returns `true` if the node is a `JSXElement` of `User-Defined Component` type
+ */
+declare function isJSXElementOfUserDefinedComponent(node: TSESTree.Node): node is TSESTree.JSXElement;
+/**
+ * Check if a node is a `JSXFragment` of `Built-in Component` type
+ * @param node The AST node to check
+ * @returns `true` if the node is a `JSXFragment` of `Built-in Component` type
+ */
+declare function isJSXElementOfBuiltinComponent(node: TSESTree.Node): node is TSESTree.JSXFragment;
+
+declare function getFragmentFromContext<T extends RuleContext>(context: T): string;
+declare const getPragmaFromContext: <T extends RuleContext>(context: T) => string;
 
-type CallFromPragmaPredicate = (node: TSESTree$1.Node, context: RuleContext) => node is TSESTree$1.CallExpression;
+declare function isInitializedFromPragma(variableName: string, context: RuleContext, pragma?: string): boolean;
+type CallFromPragmaPredicate = (node: TSESTree.Node, context: RuleContext) => node is TSESTree.CallExpression;
 /**
  * Checks if the given node is a call expression to the given function or method of the pragma
  * @param name The name of the function or method to check
  * @returns A predicate that checks if the given node is a call expression to the given function or method
  */
-declare const isCallFromPragma: (name: string) => (node: TSESTree$1.Node, context: RuleContext) => node is TSESTree$1.CallExpression;
+declare function isCallFromPragma(name: string): (node: TSESTree.Node, context: RuleContext) => node is TSESTree.CallExpression;
 
-declare function isDestructuredFromPragma<T extends RuleContext>(variableName: string, context: T): boolean;
+declare function isPropertyOfPragma(name: string, context: RuleContext, pragma?: string): (node: TSESTree.Node) => boolean;
 
 /**
  * Checks if the given node is a call expression to `createElement`
@@ -71,6 +94,33 @@ declare const hdlTransition: readonly ["onTransitionEnd"];
 declare const hdlScroll: readonly ["onScroll"];
 declare const hdlWheel: readonly ["onWheel"];
 
+declare const isFragment: (node: TSESTree.Node, pragma: string, fragment: string) => node is TSESTree.JSXElement | TSESTree.JSXFragment;
+/**
+ * Check if a node is `<></>`
+ */
+declare const isFragmentSyntax: (node: TSESTree.Node | null | undefined) => node is TSESTree.JSXFragment;
+/**
+ * Check if a node is `<Fragment></Fragment>` or `<Pragma.Fragment></Pragma.Fragment>`
+ * @param node
+ * @param pragma
+ * @param fragment
+ */
+declare function isFragmentElement(node: TSESTree.JSXElement, pragma: string, fragment: string): boolean;
+/**
+ * Check if a JSXElement or JSXFragment has only one literal child and is not a child
+ * @param node The AST node to check
+ * @returns `true` if the node has only one literal child and is not a child
+ * @example Somehow fragment like this is useful: <Foo content={<>ee eeee eeee ...</>} />
+ */
+declare function isFragmentWithOnlyTextAndIsNotChild(node: TSESTree.JSXElement | TSESTree.JSXFragment): boolean;
+/**
+ * Check if a JSXElement or JSXFragment has less than two non-padding children and the first child is not a call expression
+ * @param node The AST node to check
+ * @returns boolean
+ */
+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
@@ -165,6 +215,12 @@ declare function findPropInProperties(properties: (TSESTree.Property | TSESTree.
  * @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<{
@@ -189,5 +245,11 @@ declare function isWhiteSpace(node: TSESTree.JSXText | TSESTree.Literal): boolea
  * @returns boolean
  */
 declare function isLineBreak(node: TSESTree.Node): boolean;
+/**
+ * Check if a Literal or JSXText node is padding spaces
+ * @param node The AST node to check
+ * @returns 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, isChildrenOfCreateElement, isCloneElementCall, isCreateElementCall, isDestructuredFromPragma, isFunctionReturningJSXValue, isInsideCreateElementProps, isInsidePropValue, isJSXValue, isLineBreak, isLiteral, isWhiteSpace, traverseUpProp };
+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 };