@eslint-react/jsx 0.5.5

package/dist/index.d.mts

@@ -0,0 +1,188 @@
+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';
+
+/**
+ * Check if a JSXElement or JSXFragment has children
+ * @param node The AST node to check
+ * @returns `true` if the node has children
+ */
+declare function hasChildren(node: TSESTree.JSXElement | TSESTree.JSXFragment): boolean;
+
+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>;
+
+type CallFromPragmaPredicate = (node: TSESTree$1.Node, context: RuleContext) => node is TSESTree$1.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 isDestructuredFromPragma<T extends RuleContext>(variableName: string, context: T): boolean;
+
+/**
+ * Checks if the given node is a call expression to `React.createElement`
+ * @param node The AST node to check
+ * @param context The rule context
+ * @returns `true` if the node is a call expression to `createElement`
+ */
+declare const isCreateElementCall: CallFromPragmaPredicate;
+/**
+ * Checks if the given node is a call expression to `React.cloneElement`
+ * @param node The AST node to check
+ * @param context The rule context
+ * @returns `true` if the node is a call expression to `cloneElement`
+ */
+declare const isCloneElementCall: CallFromPragmaPredicate;
+
+/**
+ * Determines whether inside createElement's props.
+ * @param node The AST node to check
+ * @param context The rule context
+ * @returns `true` if the node is inside createElement's props
+ */
+declare function isInsideCreateElementProps(node: TSESTree.Node, context: RuleContext): boolean;
+
+/**
+ * Returns the tag name associated with a JSXOpeningElement.
+ * @param node The visited JSXOpeningElement node object.
+ * @returns The element's tag name.
+ */
+declare function elementType(node: TSESTree.JSXOpeningElement | TSESTree.JSXOpeningFragment): string;
+
+declare const hdlAnimation: readonly ["onAnimationStart", "onAnimationEnd", "onAnimationIteration"];
+declare const hdlClipboard: readonly ["onCopy", "onCut", "onPaste"];
+declare const hdlComposition: readonly ["onCompositionEnd", "onCompositionStart", "onCompositionUpdate"];
+declare const hdlFocus: readonly ["onFocus", "onBlur"];
+declare const hdlForm: readonly ["onChange", "onInput", "onSubmit"];
+declare const hdlImage: readonly ["onLoad", "onError"];
+declare const hdlKeyboard: readonly ["onKeyDown", "onKeyPress", "onKeyUp"];
+declare const hdlMedia: readonly ["onAbort", "onCanPlay", "onCanPlayThrough", "onDurationChange", "onEmptied", "onEncrypted", "onEnded", "onError", "onLoadedData", "onLoadedMetadata", "onLoadStart", "onPause", "onPlay", "onPlaying", "onProgress", "onRateChange", "onSeeked", "onSeeking", "onStalled", "onSuspend", "onTimeUpdate", "onVolumeChange", "onWaiting"];
+declare const hdlMouse: readonly ["onClick", "onContextMenu", "onDblClick", "onDoubleClick", "onDrag", "onDragEnd", "onDragEnter", "onDragExit", "onDragLeave", "onDragOver", "onDragStart", "onDrop", "onMouseDown", "onMouseEnter", "onMouseLeave", "onMouseMove", "onMouseOut", "onMouseOver", "onMouseUp"];
+declare const hdlSelection: readonly ["onSelect"];
+declare const hdlTouch: readonly ["onTouchCancel", "onTouchEnd", "onTouchMove", "onTouchStart"];
+declare const hdlTransition: readonly ["onTransitionEnd"];
+declare const hdlScroll: readonly ["onScroll"];
+declare const hdlWheel: readonly ["onWheel"];
+
+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
+ * @param context The rule context
+ * @param options The `JSXValueCheckOptions` to use
+ * @returns boolean
+ */
+declare function isJSXValue(node: TSESTree$1.Node | null | undefined, context: RuleContext, options?: JSXValueCheckOptions): boolean;
+
+/**
+ * Check if function is returning JSX
+ * @param node The return statement node to check
+ * @param context The rule context
+ * @param options The JSX value check options
+ * @returns boolean
+ */
+declare function isFunctionReturningJSXValue(node: TSESTreeFunction, context: RuleContext, options?: JSXValueCheckOptions): boolean;
+
+/**
+ * Check if the given prop name is present in the given attributes
+ * @param attributes The attributes to search in
+ * @param propName The prop name to search for
+ * @param context The rule context
+ * @returns `true` if the given prop name is present in the given properties
+ */
+declare function hasProp(attributes: (TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute)[], propName: string, context: RuleContext): boolean;
+/**
+ * Check if any of the given prop names are present in the given attributes
+ * @param attributes The attributes to search in
+ * @param propNames The prop names to search for
+ * @param context The rule context
+ * @returns `true` if any of the given prop names are present in the given attributes
+ */
+declare function hasAnyProp(attributes: (TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute)[], propNames: string[], context: RuleContext): boolean;
+/**
+ * Check if all of the given prop names are present in the given attributes
+ * @param attributes The attributes to search in
+ * @param propNames The prop names to search for
+ * @param context The rule context
+ * @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
+ */
+declare function getPropNameWithNamespace(node: TSESTree.JSXAttribute): string;
+/**
+ * Traverses up prop node
+ * @param node The AST node to start traversing from
+ * @param predicate The predicate to check each node
+ * @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>>;
+
+/**
+ * Check if a node is a Literal or JSXText
+ * @param node The AST node to check
+ * @returns boolean `true` if the node is a Literal or JSXText
+ */
+declare const isLiteral: (node: TSESTree.Node | null | undefined) => node is TSESTree.JSXText | TSESTree.BigIntLiteral | TSESTree.BooleanLiteral | TSESTree.NullLiteral | TSESTree.NumberLiteral | TSESTree.RegExpLiteral | TSESTree.StringLiteral;
+/**
+ * Check if a Literal or JSXText node is whitespace
+ * @param node The AST node to check
+ * @returns boolean `true` if the node is whitespace
+ */
+declare function isWhiteSpace(node: TSESTree.JSXText | TSESTree.Literal): boolean;
+/**
+ * Check if a Literal or JSXText node is a line break
+ * @param node The AST node to check
+ * @returns boolean
+ */
+declare function isLineBreak(node: TSESTree.Node): boolean;
+
+export { type CallFromPragmaPredicate, type JSXValueCheckOptions, defaultJSXValueCheckOptions, elementType, findPropInAttributes, findPropInProperties, getFragmentFromContext, getPragmaFromContext, getPropName, getPropNameWithNamespace, 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 };

package/dist/index.d.ts

@@ -0,0 +1,188 @@
+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';
+
+/**
+ * Check if a JSXElement or JSXFragment has children
+ * @param node The AST node to check
+ * @returns `true` if the node has children
+ */
+declare function hasChildren(node: TSESTree.JSXElement | TSESTree.JSXFragment): boolean;
+
+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>;
+
+type CallFromPragmaPredicate = (node: TSESTree$1.Node, context: RuleContext) => node is TSESTree$1.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 isDestructuredFromPragma<T extends RuleContext>(variableName: string, context: T): boolean;
+
+/**
+ * Checks if the given node is a call expression to `React.createElement`
+ * @param node The AST node to check
+ * @param context The rule context
+ * @returns `true` if the node is a call expression to `createElement`
+ */
+declare const isCreateElementCall: CallFromPragmaPredicate;
+/**
+ * Checks if the given node is a call expression to `React.cloneElement`
+ * @param node The AST node to check
+ * @param context The rule context
+ * @returns `true` if the node is a call expression to `cloneElement`
+ */
+declare const isCloneElementCall: CallFromPragmaPredicate;
+
+/**
+ * Determines whether inside createElement's props.
+ * @param node The AST node to check
+ * @param context The rule context
+ * @returns `true` if the node is inside createElement's props
+ */
+declare function isInsideCreateElementProps(node: TSESTree.Node, context: RuleContext): boolean;
+
+/**
+ * Returns the tag name associated with a JSXOpeningElement.
+ * @param node The visited JSXOpeningElement node object.
+ * @returns The element's tag name.
+ */
+declare function elementType(node: TSESTree.JSXOpeningElement | TSESTree.JSXOpeningFragment): string;
+
+declare const hdlAnimation: readonly ["onAnimationStart", "onAnimationEnd", "onAnimationIteration"];
+declare const hdlClipboard: readonly ["onCopy", "onCut", "onPaste"];
+declare const hdlComposition: readonly ["onCompositionEnd", "onCompositionStart", "onCompositionUpdate"];
+declare const hdlFocus: readonly ["onFocus", "onBlur"];
+declare const hdlForm: readonly ["onChange", "onInput", "onSubmit"];
+declare const hdlImage: readonly ["onLoad", "onError"];
+declare const hdlKeyboard: readonly ["onKeyDown", "onKeyPress", "onKeyUp"];
+declare const hdlMedia: readonly ["onAbort", "onCanPlay", "onCanPlayThrough", "onDurationChange", "onEmptied", "onEncrypted", "onEnded", "onError", "onLoadedData", "onLoadedMetadata", "onLoadStart", "onPause", "onPlay", "onPlaying", "onProgress", "onRateChange", "onSeeked", "onSeeking", "onStalled", "onSuspend", "onTimeUpdate", "onVolumeChange", "onWaiting"];
+declare const hdlMouse: readonly ["onClick", "onContextMenu", "onDblClick", "onDoubleClick", "onDrag", "onDragEnd", "onDragEnter", "onDragExit", "onDragLeave", "onDragOver", "onDragStart", "onDrop", "onMouseDown", "onMouseEnter", "onMouseLeave", "onMouseMove", "onMouseOut", "onMouseOver", "onMouseUp"];
+declare const hdlSelection: readonly ["onSelect"];
+declare const hdlTouch: readonly ["onTouchCancel", "onTouchEnd", "onTouchMove", "onTouchStart"];
+declare const hdlTransition: readonly ["onTransitionEnd"];
+declare const hdlScroll: readonly ["onScroll"];
+declare const hdlWheel: readonly ["onWheel"];
+
+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
+ * @param context The rule context
+ * @param options The `JSXValueCheckOptions` to use
+ * @returns boolean
+ */
+declare function isJSXValue(node: TSESTree$1.Node | null | undefined, context: RuleContext, options?: JSXValueCheckOptions): boolean;
+
+/**
+ * Check if function is returning JSX
+ * @param node The return statement node to check
+ * @param context The rule context
+ * @param options The JSX value check options
+ * @returns boolean
+ */
+declare function isFunctionReturningJSXValue(node: TSESTreeFunction, context: RuleContext, options?: JSXValueCheckOptions): boolean;
+
+/**
+ * Check if the given prop name is present in the given attributes
+ * @param attributes The attributes to search in
+ * @param propName The prop name to search for
+ * @param context The rule context
+ * @returns `true` if the given prop name is present in the given properties
+ */
+declare function hasProp(attributes: (TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute)[], propName: string, context: RuleContext): boolean;
+/**
+ * Check if any of the given prop names are present in the given attributes
+ * @param attributes The attributes to search in
+ * @param propNames The prop names to search for
+ * @param context The rule context
+ * @returns `true` if any of the given prop names are present in the given attributes
+ */
+declare function hasAnyProp(attributes: (TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute)[], propNames: string[], context: RuleContext): boolean;
+/**
+ * Check if all of the given prop names are present in the given attributes
+ * @param attributes The attributes to search in
+ * @param propNames The prop names to search for
+ * @param context The rule context
+ * @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
+ */
+declare function getPropNameWithNamespace(node: TSESTree.JSXAttribute): string;
+/**
+ * Traverses up prop node
+ * @param node The AST node to start traversing from
+ * @param predicate The predicate to check each node
+ * @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>>;
+
+/**
+ * Check if a node is a Literal or JSXText
+ * @param node The AST node to check
+ * @returns boolean `true` if the node is a Literal or JSXText
+ */
+declare const isLiteral: (node: TSESTree.Node | null | undefined) => node is TSESTree.JSXText | TSESTree.BigIntLiteral | TSESTree.BooleanLiteral | TSESTree.NullLiteral | TSESTree.NumberLiteral | TSESTree.RegExpLiteral | TSESTree.StringLiteral;
+/**
+ * Check if a Literal or JSXText node is whitespace
+ * @param node The AST node to check
+ * @returns boolean `true` if the node is whitespace
+ */
+declare function isWhiteSpace(node: TSESTree.JSXText | TSESTree.Literal): boolean;
+/**
+ * Check if a Literal or JSXText node is a line break
+ * @param node The AST node to check
+ * @returns boolean
+ */
+declare function isLineBreak(node: TSESTree.Node): boolean;
+
+export { type CallFromPragmaPredicate, type JSXValueCheckOptions, defaultJSXValueCheckOptions, elementType, findPropInAttributes, findPropInProperties, getFragmentFromContext, getPragmaFromContext, getPropName, getPropNameWithNamespace, 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 };