@eslint-react/jsx 0.5.6 → 0.5.8

package/dist/index.d.mts

@@ -1,8 +1,8 @@
 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
@@ -13,18 +13,19 @@ declare function hasChildren(node: TSESTree.JSXElement | TSESTree.JSXFragment):
 
 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>;
+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`
@@ -165,6 +166,17 @@ 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<{
+    value: unknown;
+} | null>;
 
 /**
  * Check if a node is a Literal or JSXText
@@ -185,4 +197,4 @@ declare function isWhiteSpace(node: TSESTree.JSXText | TSESTree.Literal): boolea
  */
 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 };
+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, isFunctionReturningJSXValue, isInitializedFromPragma, isInsideCreateElementProps, isInsidePropValue, isJSXValue, isLineBreak, isLiteral, 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 { 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
@@ -13,18 +13,19 @@ declare function hasChildren(node: TSESTree.JSXElement | TSESTree.JSXFragment):
 
 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>;
+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`
@@ -165,6 +166,17 @@ 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<{
+    value: unknown;
+} | null>;
 
 /**
  * Check if a node is a Literal or JSXText
@@ -185,4 +197,4 @@ declare function isWhiteSpace(node: TSESTree.JSXText | TSESTree.Literal): boolea
  */
 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 };
+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, isFunctionReturningJSXValue, isInitializedFromPragma, isInsideCreateElementProps, isInsidePropValue, isJSXValue, isLineBreak, isLiteral, isPropertyOfPragma, isWhiteSpace, traverseUpProp };