npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@michael1997/eslint-plugin-react-usememo

v0.1.2

Published

Enforce that functions or complex objects that can generate unecessary renders or side-effects are wrapped in `useMemo` or `useCallback`, allow for devs to enforce that functional components be wrapped in `memo` programatically, and that all props and dep

Downloads

1,222

Readme

eslint-plugin-react-usememo

Enforce that functions or complex objects that can generate unecessary renders or side-effects are wrapped in useMemo or useCallback, allow for devs to enforce that functional components be wrapped in memo programatically, and that all props and deps are wrapped in useMemo/useCallback; The intended outcome is that component's tree and/or expensive lifecycles (e.g. React Native's FlatLists, useEffect, useMemo, etc) only re-calculate or render again when really necessary, controlling expensive expressions and bringing out the best scalability and performance that your application can get.

Rationale

React Native's own docs state how it's important to use static or memoized as props for complex children (FlatList on that case), that applies even more broadly when we are talking about custom components (the Components you've created), it might not seem necessary at first but you'll be making a bet that the component in question will never grow to use memo or those props in hooks (i.e. useEffect, useMemo, useCallback), you'll only notice once your solution starts freezing and dropping frames, that's why using the require-usememo rule is recommended.

Installation

yarn add @michael1997/eslint-plugin-react-usememo --dev

or

npm install @michael1997/eslint-plugin-react-usememo --save-dev

Usage

To enable the plugin add the following to the plugin property your eslintrc file:

"plugins": ["@michael1997/react-usememo"],

Then enable any rules as you like, example:

"rules": {
    "@michael1997/react-usememo/require-usememo": ["warn"],
},

Rules

require-usememo Recommended

Requires complex values (objects, arrays, functions, and JSX) that get passed props or referenced as a hook dependency to be wrapped in React.useMemo() or React.useCallback().

Options:

  • {strict: true}: Fails even in cases where it is difficult to determine if the value in question is a primitive (string or number) or a complex value (object, array, etc.).

Incorrect

function Component() {

  const [data, setData] = useState([]);
  
  
  // This will be redeclared each render
  function renderItem({ item }) {
    return (<Text>item.name</Text>);
  }

  // Data isn't redeclared each ender but `[]` is
  return (<FlatList renderItem={renderItem} data={data ?? []} />);
}

Incorrect (class component)

class Component() {

  constructor(props) {
    super(props);
    this.state = {
      data: undefined,
      propDrivenData: props.,
    };
  }
  
  
  // This will NOT be redeclared each render
  getItemName(item) {
    return item.name;
  }

  render() {
    // This function will be redeclared each render
    function renderItem({ item }) {
      return (<Text>{this.getItemName(item)}</Text>);
    }

    // Data isn't redeclared each ender but [] is
    // Extradata has a exponential complexity (will iterate the entire array for each render, could render once or several times in a second)
    // Outcome will be that any new render on this component will cause the entire FlatList to render again, including children components, even if the data hasn't changed.
    return (<FlatList
      renderItem={renderItem}
      data={data ?? []} 
      extraData={dataArray.filter(id => !!id)}
    />);
  }
}

In the previous example there are two issues, a function and a object that will be dynamically redeclared each time the component renders, which will cause FlatList to keep re-rendering even when the input data hasn't changed.

Correct

// Has no dynamic dependencies therefore should be static, will be declared only once.
function renderItem({ item }) {
  return <Text>item.name</Text>;
}

const EMPTY_ARRAY = [];

function Component() {

  const [data, setData] = useState(EMPTY_ARRAY);
  
  // Will only render again if data changes
  return (<FlatList renderItem={renderItem} data={data ?? EMPTY_ARRAY} />);
}

Correct (class component)


// Static therefore is only declared once
const EMPTY_ARRAY = [];

class Component() {
  constructor(props) {
    super(props);
    this.state = {
      data: undefined,
      propDrivenData: props.dataArray.filter(id => !!id),
    };
  }
  
  // Properly regenerate state driven data only when props change instead of during each render
  static getDerivedStateFromProps(props) {
    if (props.propDrivenData !== this.props.propDrivenData) {
      return {
        propDrivenData: props.dataArray.filter(id => !!id),
      };
    }
    return null;
  }

  // Will be declared only once.
  getItemName({item}) {
    const { data } = this.state;
    const dataLength = data ? data.length : 0;
    return (<Text>{item.name} {dataLength}</Text>);
  }

  render() {
    const { data } = this.state;
    // Will only cause a new render if data changes
    return (<FlatList renderItem={this.renderItem} data={data ?? EMPTY_ARRAY} />);
  }
}

Correct

const EMPTY_ARRAY = [];

function Component() {
  const [data, setData] = useState(EMPTY_ARRAY);
  const [isEditing, setIsEditing] = useState(false);

  // Has dynamic dependencies but will only be re-declared when isEditing or the input data changes
  const renderItem = useCallback(({ item }) => {
    return (<Text>{isEditing ? 'item.name' : 'Editing'}</Text>);
  }, [isEditing]);

  return (<FlatList renderItem={renderItem} data={data ?? EMPTY_ARRAY} />);
}

require-memo

Requires all function components to be wrapped in React.memo().
May be useful when used with overrides in your eslint config, I do not recommend enabling this globally, while there's great advantaje in memoing a complex tree of components some smaller/basic components with no children might not need to be memoized.

Incorrect

export default function Component() {
  return (<Text>This is a component</Text>);
}

Correct

export default memo(function Component() {
  return (<Text>This is a component</Text>);
});

require-usememo-children Advanced

Requires complex values (objects, arrays, functions, and JSX) that get passed as children to be wrapped in React.useMemo() or React.useCallback().

Options:

  • {strict: true}: Fails even in cases where it is difficult to determine if the value in question is a primitive (string or number) or a complex value (object, array, etc.).

Incorrect

function Component() {

  return (<View>
    <>
    <OtherComponent />
    </>
  </View>);
}

Correct

function Component() {
  const children = useMemo(() => (<OtherComponent />), []);
  
  return (<View>
    {children}
  </View>);
}