jsx-ast-utils
Advanced tools
Package description
The jsx-ast-utils package provides utilities for working with the Abstract Syntax Tree (AST) of JSX elements. It is commonly used in the development of linting rules and tools that analyze or transform JSX code.
Element and attribute extraction
This feature allows you to extract properties and their literal values from a JSX element. It is useful when analyzing components for specific attribute values.
const { getProp, getLiteralPropValue } = require('jsx-ast-utils');
const JSXElement = ...; // some JSX element AST node
const prop = getProp(JSXElement, 'href');
const value = getLiteralPropValue(prop);Event handler detection
This feature helps in detecting event handlers on JSX elements. It can be used to ensure that interactive elements have appropriate event handlers for accessibility.
const { getProp, elementType } = require('jsx-ast-utils');
const JSXElement = ...; // some JSX element AST node
const type = elementType(JSXElement);
const onClickProp = getProp(JSXElement, 'onClick');
const isButtonWithOnClick = type === 'button' && onClickProp !== undefined;Checking for children
These utilities allow you to check if a JSX element has any children or if every child meets a specific condition. This can be used to enforce content structure within components.
const { hasAnyChildren, hasEveryChild } = require('jsx-ast-utils');
const JSXElement = ...; // some JSX element AST node
const hasChildren = hasAnyChildren(JSXElement);
const hasSpecificChildren = hasEveryChild(JSXElement, child => child.type === 'JSXText');This package is a Babel plugin that allows for transformation of JSX syntax. It provides similar AST manipulation capabilities but is more focused on compiling JSX to JavaScript rather than analyzing or linting.
This package includes a collection of ESLint rules for React and JSX. It uses AST analysis to enforce best practices and coding standards. While it does not provide low-level AST utilities like jsx-ast-utils, it serves a similar purpose in the context of linting and code quality.
react-docgen is a CLI and toolkit for extracting information from React component files for documentation generation. It analyzes the AST to gather prop types, default values, and component descriptions. It is similar in that it analyzes JSX, but it is more specialized for documentation purposes.
Changelog
v3.3.4 - 2023-06-28
array.prototype.flat object.values over .reduce bad51d0auto-changelog af1de69import.meta 1d39f58@babel/core, @babel/eslint-parser, @babel/parser, aud, eslint, eslint-plugin-import 3baaf76TSNonNullExpression: Handle function calls 26cc3c4eslint, @babel/core, @babel/parser, object.entries, object.fromentries 0e4f80c@babel/core, @babel/eslint-parser, @babel/parser, aud b5427a6a0f4f38array-includes c479841object.assign 9685dceobject.assign@babel/core, @babel/eslint-parser, @babel/parser, eslintas casts in TSNonNullExpressionArrayExpression: handle sparse array (#117)array-includesnpmignore to autogenerate an npmignore file@babel/core, @babel/eslint-parser, @babel/parser, eslintJSXFragment, JSXText; fix JSXElement to handle children@babel/core, @babel/parser, eslint, eslint-plugin-importTSNonNullExpression: handle computed MemberExpressions (#109)array-includesaud in posttestnode/install instead of node/run; use codecov actioncaniuse-lite, since breaking change is fixedcaniuse-lite, due to breaking change in patch version@babel/core, @babel/parser, aud, eslint, eslint-plugin-import, object.entries, object.fromentries<>) (#108)TSNonNullExpression: handle ThisExpressions (#108)array-includes, object.assign@babel/core, @babel/parser, eslint, eslint-config-airbnb-base, object.entries, object.fromentriesTSNonNullExpression (#105)AssignmentExpression (#106)eslintChainExpression; CallExpression now includes arguments (#102)SequenceExpression (#101)object.assigneslint, eslint-plugin-import@babel/core, @babel/parser, eslint, eslint-plugin-importactual, expected ordering for non-confusing failure messagesexpressions/TemplateLiteral: use .range[0] instead of .start@babel/core, @babel/parser, eslint, eslint-config-airbnb-base, eslint-plugin-import, flow-parsernpm publish worksarray-includessafe-publish-latest@babel/parser, babel-eslint, coveralls, eslint, eslint-config-airbnb-base, eslint-plugin-import, in-publish, object.entries, object.fromentries, rimrafnode v14; test all branchesobjectRestSpread within props #60propName so it always returns a value.getPropValue for ArrowFunctionExpression<Component.Render.Me />). Fixes #9ArrayExpression.UpdateExpression.JSXElement to expression types to handle recursively extracting prop value.TaggedTemplateExpression.lib instead of src for root exports.require('jsx-ast-utils/{function}').TemplateLiteral extraction.propName to API to get correct name for prop.Readme
[![dependency status][deps-svg]][deps-url]
[![dev dependency status][dev-deps-svg]][dev-deps-url]
[![npm badge][npm-badge-png]][package-url]
AST utility module for statically analyzing JSX.
$ npm i jsx-ast-utils --save
This is a utility module to evaluate AST objects for JSX syntax. This can be super useful when writing linting rules for JSX code. It was originally in the code for eslint-plugin-jsx-a11y, however I thought it could be useful to be extracted and maintained separately so you could write new interesting rules to statically analyze JSX.
import { hasProp } from 'jsx-ast-utils';
// OR: var hasProp = require('jsx-ast-utils').hasProp;
// OR: const hasProp = require('jsx-ast-utils/hasProp');
// OR: import hasProp from 'jsx-ast-utils/hasProp';
module.exports = context => ({
JSXOpeningElement: node => {
const onChange = hasProp(node.attributes, 'onChange');
if (onChange) {
context.report({
node,
message: `No onChange!`
});
}
}
});
hasProp(props, prop, options);
Returns boolean indicating whether an prop exists as an attribute on a JSX element node.
Object - The attributes on the visited node. (Usually node.attributes).
String - A string representation of the prop you want to check for existence.
Object - An object representing options for existence checking
ignoreCase - automatically set to true.spreadStrict - automatically set to true. This means if spread operator exists in
props, it will assume the prop you are looking for is not in the spread.
Example: <div {...props} /> looking for specific prop here will return false if spreadStrict is true.hasAnyProp(props, prop, options);
Returns a boolean indicating if any of props in prop argument exist on the node.
Object - The attributes on the visited node. (Usually node.attributes).
Array - An array of strings representing the props you want to check for existence.
Object - An object representing options for existence checking
ignoreCase - automatically set to true.spreadStrict - automatically set to true. This means if spread operator exists in
props, it will assume the prop you are looking for is not in the spread.
Example: <div {...props} /> looking for specific prop here will return false if spreadStrict is true.hasEveryProp(props, prop, options);
Returns a boolean indicating if all of props in prop argument exist on the node.
Object - The attributes on the visited node. (Usually node.attributes).
Array - An array of strings representing the props you want to check for existence.
Object - An object representing options for existence checking
ignoreCase - automatically set to true.spreadStrict - automatically set to true. This means if spread operator exists in
props, it will assume the prop you are looking for is not in the spread.
Example: <div {...props} /> looking for specific prop here will return false if spreadStrict is true.getProp(props, prop, options);
Returns the JSXAttribute itself or undefined, indicating the prop is not present on the JSXOpeningElement.
Object - The attributes on the visited node. (Usually node.attributes).
String - A string representation of the prop you want to check for existence.
Object - An object representing options for existence checking
ignoreCase - automatically set to true.elementType(node)
Returns the tagName associated with a JSXElement.
Object - The visited JSXElement node object.
getPropValue(prop);
Returns the value of a given attribute. Different types of attributes have their associated values in different properties on the object.
This function should return the most closely associated value with the intention of the JSX.
Object - The JSXAttribute collected by AST parser.
getLiteralPropValue(prop);
Returns the value of a given attribute. Different types of attributes have their associated values in different properties on the object.
This function should return a value only if we can extract a literal value from its attribute (i.e. values that have generic types in JavaScript - strings, numbers, booleans, etc.)
Object - The JSXAttribute collected by AST parser.
propName(prop);
Returns the name associated with a JSXAttribute. For example, given <div foo="bar" /> and the JSXAttribute for foo, this will return the string "foo".
Object - The JSXAttribute collected by AST parser.
console.log(eventHandlers);
/*
[
'onCopy',
'onCut',
'onPaste',
'onCompositionEnd',
'onCompositionStart',
'onCompositionUpdate',
'onKeyDown',
'onKeyPress',
'onKeyUp',
'onFocus',
'onBlur',
'onChange',
'onInput',
'onSubmit',
'onClick',
'onContextMenu',
'onDblClick',
'onDoubleClick',
'onDrag',
'onDragEnd',
'onDragEnter',
'onDragExit',
'onDragLeave',
'onDragOver',
'onDragStart',
'onDrop',
'onMouseDown',
'onMouseEnter',
'onMouseLeave',
'onMouseMove',
'onMouseOut',
'onMouseOver',
'onMouseUp',
'onSelect',
'onTouchCancel',
'onTouchEnd',
'onTouchMove',
'onTouchStart',
'onScroll',
'onWheel',
'onAbort',
'onCanPlay',
'onCanPlayThrough',
'onDurationChange',
'onEmptied',
'onEncrypted',
'onEnded',
'onError',
'onLoadedData',
'onLoadedMetadata',
'onLoadStart',
'onPause',
'onPlay',
'onPlaying',
'onProgress',
'onRateChange',
'onSeeked',
'onSeeking',
'onStalled',
'onSuspend',
'onTimeUpdate',
'onVolumeChange',
'onWaiting',
'onLoad',
'onError',
'onAnimationStart',
'onAnimationEnd',
'onAnimationIteration',
'onTransitionEnd',
]
*/
Contains a flat list of common event handler props used in JSX to attach behaviors to DOM events.
The same list as eventHandlers, grouped into types.
console.log(eventHandlersByType);
/*
{
clipboard: [ 'onCopy', 'onCut', 'onPaste' ],
composition: [ 'onCompositionEnd', 'onCompositionStart', 'onCompositionUpdate' ],
keyboard: [ 'onKeyDown', 'onKeyPress', 'onKeyUp' ],
focus: [ 'onFocus', 'onBlur' ],
form: [ 'onChange', 'onInput', 'onSubmit' ],
mouse: [ 'onClick', 'onContextMenu', 'onDblClick', 'onDoubleClick', 'onDrag', 'onDragEnd', 'onDragEnter', 'onDragExit', 'onDragLeave', 'onDragOver', 'onDragStart', 'onDrop', 'onMouseDown', 'onMouseEnter', 'onMouseLeave', 'onMouseMove', 'onMouseOut', 'onMouseOver', 'onMouseUp' ],
selection: [ 'onSelect' ],
touch: [ 'onTouchCancel', 'onTouchEnd', 'onTouchMove', 'onTouchStart' ],
ui: [ 'onScroll' ],
wheel: [ 'onWheel' ],
media: [ 'onAbort', 'onCanPlay', 'onCanPlayThrough', 'onDurationChange', 'onEmptied', 'onEncrypted', 'onEnded', 'onError', 'onLoadedData', 'onLoadedMetadata', 'onLoadStart', 'onPause', 'onPlay', 'onPlaying', 'onProgress', 'onRateChange', 'onSeeked', 'onSeeking', 'onStalled', 'onSuspend', 'onTimeUpdate', 'onVolumeChange', 'onWaiting' ],
image: [ 'onLoad', 'onError' ],
animation: [ 'onAnimationStart', 'onAnimationEnd', 'onAnimationIteration' ],
transition: [ 'onTransitionEnd' ],
}
*/
FAQs
AST utility module for statically analyzing JSX
The npm package jsx-ast-utils receives a total of 16,896,040 weekly downloads. As such, jsx-ast-utils popularity was classified as popular.
We found that jsx-ast-utils demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.