Как настроить ESLint и Prettier в React приложении

год назад·1 мин. на чтение

Как быстро настроить ESLint и Prettier

Настройка ESLint и Prettier утомительный процесс. Я много раз сталкивался с этой проблемой. В интернете вы найдете много статей о настройке линтинга. Некоторые из них будут рабочими, некоторые нет, т.к. библиотеки линтинга меняются.

Что такое ESLint?

ESLint статически анализирует наш код и находит проблемы. Он присутствует в большинстве редакторов. Исправления ESLint учитывают синтаксис, поэтому вы не столкнетесь с ошибками, вызванными традиционными алгоритмами поиска и замены. Вы можете настроить ESLint так, чтобы он работал именно так, как вам нужно для вашего проекта.

Что такое Prettier?

Prettier — это модуль форматирования кода, совместимый с большинством языков. Это экономит много времени. Он быстро делает отступ в нашем коде при сохранении (зависит от настроек VSCode/редактора). Чтобы включить форматирование кода при сохранении в VSCode, нужно перейти в File -> Preferences -> Settings. Далее в строке поиска настроек вставим Format On Save. В найденном поле ставим галочку.

Как заставить их работать вместе?

В ESLint также есть правила форматирования, которые могут конфликтовать с Prettier. Поэтому мы должны аккуратно их настроить (звучит сложно, но на деле это очень просто). Давайте начнём

Шаг 1

npm install eslint --save-dev

# или

yarn add eslint --dev

Шаг 2:

Создайте .eslintrc.json выполнив команду
npx eslint --init

# или

yarn run eslint --init

Шаг 3

В React 17.0.0 импорт react в файл необязателен. Чтобы исправить это, мы добавим правило в наш файл .eslintrc. Итак, откройте файл .eslintrc и добавьте эту строку "react/react-in-jsx-scope": "off" внутри rules.
  "rules": {
    "react/react-in-jsx-scope": "off"
  }

Шаг 4

Если вы используете jest, вы обнаружите, что eslint выдает нам ошибку, что test или expect не определены. Чтобы это исправить, нам нужно добавить "jest": true внутрь env.
  "env": {
    "browser": true,
    "es2021": true,
    "jest": true
  }

Шаг 5

Теперь добавьте плагины eslint, чтобы он работал с react, и сделайте правильную конфигурацию для eslint и prettier, чтобы они не конфликтовали друг с другом. Установите:
npm install eslint-config-prettier eslint-plugin-prettier prettier --save-dev

# или 

yarn add eslint-config-prettier eslint-plugin-prettier prettier --dev
eslint-config-prettier — отключает все правила, которые не нужны или могут конфликтовать с Prettier. eslint-plugin-prettier - Запускает Prettier как правило ESLint. После установки выше внесите изменения в файл .eslintrc.
 "extends": [
  "eslint:recommended",
  "plugin:react/recommended",
  "plugin:prettier/recommended"
]
Мы можем запустить Prettier отдельно, но мы хотим, чтобы eslint запустил его для нас, чтобы он не конфликтовал с правилами eslint.

Шаг 6

Создайте .prettierrc и вставьте приведенный ниже код
{
  "semi": true,
  "tabWidth": 2,
  "printWidth": 100,
  "singleQuote": true,
  "trailingComma": "none",
  "jsxBracketSameLine": true
}
Теперь, eslint and prettier установлены и мы можем добавить скрипт в package.json.
"lint": "eslint .",
"lint:fix": "eslint --fix",
"format": "prettier --write './**/*.{js,jsx,ts,tsx,css,md,json}' --config ./.prettierrc"
Это должно сработать, но прежде чем тестировать, лучше перезапустить VSCode.

Обновление массивов в состоянии React

10 месяцев назад·11 мин. на чтение

Массивы в JavaScript мутабельны, но вы должны обращаться с ними как с иммутабельными, когда сохраняете их в состоянии в компоненте React. Как и в случае с объектами, когда вы хотите обновить массив, хранящийся в состоянии, вам нужно создать новый (или сделать копию существующего), а затем установить состояние для использования нового массива.

Содержание туториала по React Массивы в JavaScript мутабельны, но вы должны обращаться с ними как с иммутабельными, когда сохраняете их в состоянии. Как и в случае с объектами, когда вы хотите обновить массив, хранящийся в состоянии, вам нужно создать новый (или сделать копию существующего), а затем установить состояние для использования нового массива.

Обновление массивов без мутации

В JavaScript массивы — это еще один вид объектов. Как и в случае с объектами, вы должны рассматривать массивы в состоянии React как доступные только для чтения. Это означает, что вы не должны переназначать элементы внутри массива, такие как arr[0] = 'bird', и вы также не должны использовать методы, изменяющие массив, такие как push() и pop(). Вместо этого каждый раз, когда вы хотите обновить массив, нужно передать новый массив вашей функции установки состояния. Для этого вы можете создать новый массив из исходного массива в своем состоянии, вызвав его неизменяющие методы, такие как filter() и map(). Затем вы можете установить свое состояние в полученный новый массив. Вот справочная таблица общих операций с массивами. При работе с массивами внутри состояния React вам нужно избегать методов в левом столбце и вместо этого предпочитать методы в правом столбце:
Syntaxследует избегать (мутирует массив)предпочтительно (возвращает новый массив)
добавлениеpush, unshiftconcat, [...arr] синтаксис распыления (spread)
удалениеpop, shift, splicefilter, slice
заменаsplice, arr[i] = ... присваиваниеmap
сортировкаreverse, sortсначала скопировать массив
В качестве альтернативы вы можете использовать Immer, который позволяет использовать методы из обоих столбцов.

slice и splice

К сожалению, slice и splice называются одинаково, но они очень разные:
  • slice позволяет копировать массив или его часть.
  • splice изменяет массив (чтобы вставлять или удалять элементы).
В React вы будете использовать slice (без p) гораздо чаще, потому что не стоит мутировать объекты или массивы в состоянии. В стать об Обновлении объектов объясняется, что такое мутация и почему ее не рекомендуется использовать для состояния.

Добавление в массив

push() мутирует массив, что нам не нужно:
import { useState } from 'react';

let nextId = 0;

export default function List() {
  const [name, setName] = useState('');
  const [artists, setArtists] = useState([]);

  return (
    <>
      <h1>Inspiring sculptors:</h1>
      <input value={name} onChange={(e) => setName(e.target.value)} />
      <button
        onClick={() => {
          setName('');
          artists.push({
            id: nextId++,
            name: name,
          });
        }}
      >
        Add
      </button>
      <ul>
        {artists.map((artist) => (
          <li key={artist.id}>{artist.name}</li>
        ))}
      </ul>
    </>
  );
}
Вместо этого создайте новый массив, содержащий существующие элементы и новый элемент в конце. Есть несколько способов сделать это, но самый простой — использовать синтаксис ... распыления массива:
setArtists(
  // заменим массив
  [
    // новым массивом
    ...artists, // который содержит все старые значения
    { id: nextId++, name: name }, // и новое в конце
  ]
);
Теперь код работает корректно:
import { useState } from 'react';

let nextId = 0;

export default function List() {
  const [name, setName] = useState('');
  const [artists, setArtists] = useState([]);

  return (
    <>
      <h1>Inspiring sculptors:</h1>
      <input value={name} onChange={(e) => setName(e.target.value)} />
      <button
        onClick={() => {
          setName('');
          setArtists([...artists, { id: nextId++, name: name }]);
        }}
      >
        Add
      </button>
      <ul>
        {artists.map((artist) => (
          <li key={artist.id}>{artist.name}</li>
        ))}
      </ul>
    </>
  );
}
Синтаксис распыления массива также позволяет вам добавить элемент, поместив его перед исходными элментами:
setArtists([
  { id: nextId++, name: name },
  ...artists, // поместим старые элементы в конец
]);
Таким образом, распыление (spread) может выполнять работу как push(), добавляя в конец массива, так и unshift(), добавляя в начало массива.

Удаление из массива

Самый простой способ удалить элемент из массива — отфильтровать его. Другими словами, вы создадите новый массив, который не будет содержать этот элемент. Для этого используйте метод filter, например:
import { useState } from 'react';

let initialArtists = [
  { id: 0, name: 'Marta Colvin Andrade' },
  { id: 1, name: 'Lamidi Olonade Fakeye' },
  { id: 2, name: 'Louise Nevelson' },
];

export default function List() {
  const [artists, setArtists] = useState(initialArtists);

  return (
    <>
      <h1>Inspiring sculptors:</h1>
      <ul>
        {artists.map((artist) => (
          <li key={artist.id}>
            {artist.name}{' '}
            <button
              onClick={() => {
                setArtists(artists.filter((a) => a.id !== artist.id));
              }}
            >
              Delete
            </button>
          </li>
        ))}
      </ul>
    </>
  );
}
setArtists(artists.filter((a) => a.id !== artist.id));
Здесь artist.filter(a => a.id !== artist.id) означает «создать массив, состоящий из тех исполнителей, идентификаторы которых отличаются от artist.id». Другими словами, кнопка «Удалить» каждого исполнителя отфильтрует этого исполнителя из массива, а затем запросит повторный рендеринг с результирующим массивом. Обратите внимание, что фильтр не мутирует исходный массив.

Преобразование массива

Если вы хотите изменить некоторые или все элементы массива, вы можете использовать map() для создания нового массива. Функция, которую вы передадите в map, может решить, что делать с каждым элементом, на основе его данных или его индекса (или того и другого). В этом примере массив содержит координаты двух кругов и квадрата. Когда вы нажимаете кнопку, она перемещает только круги вниз на 50 пикселей. Он делает это, создавая новый массив данных с помощью map():
import { useState } from 'react';

let initialShapes = [
  { id: 0, type: 'circle', x: 50, y: 100 },
  { id: 1, type: 'square', x: 150, y: 100 },
  { id: 2, type: 'circle', x: 250, y: 100 },
];

export default function ShapeEditor() {
  const [shapes, setShapes] = useState(initialShapes);

  function handleClick() {
    const nextShapes = shapes.map((shape) => {
      if (shape.type === 'square') {
        // не меняем
        return shape;
      } else {
        // возвращаем новый круг ниже на 50px
        return {
          ...shape,
          y: shape.y + 50,
        };
      }
    });
    // Ререндерим с новыми фигурами
    setShapes(nextShapes);
  }

  return (
    <>
      <button onClick={handleClick}>Move circles down!</button>
      {shapes.map((shape) => (
        <div
          key={shape.id}
          style={{
            background: 'purple',
            position: 'absolute',
            left: shape.x,
            top: shape.y,
            borderRadius: shape.type === 'circle' ? '50%' : '',
            width: 20,
            height: 20,
          }}
        />
      ))}
    </>
  );
}

Замена элементов в массиве

Особенно часто требуется заменить один или несколько элементов в массиве. Такие присваивания, как arr[0] = 'bird', мутируют исходный массив, поэтому вместо этого вы также захотите использовать для этого map. Чтобы заменить элемент, создайте новый массив с map. Внутри вашего вызова map вы получите индекс элемента в качестве второго аргумента. Используйте его, чтобы решить, следует ли вернуть исходный элемент (первый аргумент) или что-то еще:
import { useState } from 'react';

let initialCounters = [0, 0, 0];

export default function CounterList() {
  const [counters, setCounters] = useState(initialCounters);

  function handleIncrementClick(index) {
    const nextCounters = counters.map((c, i) => {
      if (i === index) {
        // Инкрементируем счетчик, который кликнули
        return c + 1;
      } else {
        // Остальные не меняем
        return c;
      }
    });
    setCounters(nextCounters);
  }

  return (
    <ul>
      {counters.map((counter, i) => (
        <li key={i}>
          {counter}
          <button
            onClick={() => {
              handleIncrementClick(i);
            }}
          >
            +1
          </button>
        </li>
      ))}
    </ul>
  );
}

Вставка в массив

Иногда вам может понадобиться вставить элемент в определенную позицию, которая не находится ни в начале, ни в конце. Для этого вы можете использовать синтаксис распыления массива ... вместе с методом slice(). Метод slice() позволяет вырезать «срез» массива. Чтобы вставить элемент, вы создадите массив, который распыляет фрагмент массива перед точкой вставки, затем новый элемент, а затем остальную часть исходного массива. В этом примере кнопка «Вставить» всегда вставляет по индексу 1:
import { useState } from 'react';

let nextId = 3;
const initialArtists = [
  { id: 0, name: 'Marta Colvin Andrade' },
  { id: 1, name: 'Lamidi Olonade Fakeye' },
  { id: 2, name: 'Louise Nevelson' },
];

export default function List() {
  const [name, setName] = useState('');
  const [artists, setArtists] = useState(initialArtists);

  function handleClick() {
    const insertAt = 1; // Может быть любой индекс
    const nextArtists = [
      // Элементы перед вставляемым элементом:
      ...artists.slice(0, insertAt),
      // Новый элемент:
      { id: nextId++, name: name },
      // Элементы после вставленного элемента:
      ...artists.slice(insertAt),
    ];
    setArtists(nextArtists);
    setName('');
  }

  return (
    <>
      <h1>Inspiring sculptors:</h1>
      <input value={name} onChange={(e) => setName(e.target.value)} />
      <button onClick={handleClick}>Insert</button>
      <ul>
        {artists.map((artist) => (
          <li key={artist.id}>{artist.name}</li>
        ))}
      </ul>
    </>
  );
}

Внесение других изменений в массив

Есть некоторые вещи, которые вы не можете сделать с помощью синтаксиса распыления и неизменяющих методов, таких как map() и filter(). Например, вы можете захотеть перевернуть или отсортировать массив. JavaScript методы reverse() и sort() мутируют исходный массив, поэтому вы не можете использовать их напрямую. Однако вы можете сначала скопировать массив, а затем внести в него изменения. Например:
import { useState } from 'react';

let nextId = 3;
const initialList = [
  { id: 0, title: 'Big Bellies' },
  { id: 1, title: 'Lunar Landscape' },
  { id: 2, title: 'Terracotta Army' },
];

export default function List() {
  const [list, setList] = useState(initialList);

  function handleClick() {
    const nextList = [...list];
    nextList.reverse();
    setList(nextList);
  }

  return (
    <>
      <button onClick={handleClick}>Reverse</button>
      <ul>
        {list.map((artwork) => (
          <li key={artwork.id}>{artwork.title}</li>
        ))}
      </ul>
    </>
  );
}
Здесь вы используете синтаксис распыления [...list], чтобы сначала создать копию исходного массива. Теперь, когда у вас есть копия, вы можете использовать мутирующие методы, такие как nextList.reverse() или nextList.sort(), или даже назначать отдельные элементы с помощью nextList[0] = "something". Однако, даже если вы скопируете массив, вы не сможете мутировать существующие элементы внутри него. Это связано с тем, что копирование неглубокое — новый массив будет содержать те же элементы, что и исходный. Поэтому, если вы мутируете объект внутри скопированного массива, вы изменяете существующее состояние. Например, такой код является проблемой.
const nextList = [...list];
nextList[0].seen = true; // Проблема: мутирует list[0]
setList(nextList);
Хотя nextList и list — это два разных массива, nextList[0] и list[0] указывают на один и тот же объект. Таким образом, изменяя nextList[0].seen, вы также меняете list[0].seen. Это мутация состояния, которой следует избегать. Вы можете решить эту проблему аналогично обновлению вложенных JavaScript объектов — копируя отдельные элементы, которые вы хотите изменить, вместо их изменения. Рассмотрим этот случай далее.

Обновление объектов внутри массивов

Объекты на самом деле не расположены «внутри» массивов. В коде они могут казаться «внутри», но каждый объект в массиве — это отдельное значение, на которое «указывает» массив. Вот почему вам нужно быть осторожным при изменении вложенных полей, таких как list[0]. При обновлении вложенного состояния вам необходимо создавать копии от точки, где вы хотите обновить, и вплоть до верхнего уровня. Давайте посмотрим, как это работает. В этом примере два отдельных списка иллюстраций имеют одинаковое начальное состояние. Предполагается, что они изолированы, но из-за мутации их состояние случайно становится общим, и установка флажка в одном списке влияет на другой список:
import { useState } from 'react';

let nextId = 3;
const initialList = [
  { id: 0, title: 'Big Bellies', seen: false },
  { id: 1, title: 'Lunar Landscape', seen: false },
  { id: 2, title: 'Terracotta Army', seen: true },
];

export default function BucketList() {
  const [myList, setMyList] = useState(initialList);
  const [yourList, setYourList] = useState(initialList);

  function handleToggleMyList(artworkId, nextSeen) {
    const myNextList = [...myList];
    const artwork = myNextList.find((a) => a.id === artworkId);
    artwork.seen = nextSeen;
    setMyList(myNextList);
  }

  function handleToggleYourList(artworkId, nextSeen) {
    const yourNextList = [...yourList];
    const artwork = yourNextList.find((a) => a.id === artworkId);
    artwork.seen = nextSeen;
    setYourList(yourNextList);
  }

  return (
    <>
      <h1>Art Bucket List</h1>
      <h2>My list of art to see:</h2>
      <ItemList artworks={myList} onToggle={handleToggleMyList} />
      <h2>Your list of art to see:</h2>
      <ItemList artworks={yourList} onToggle={handleToggleYourList} />
    </>
  );
}

function ItemList({ artworks, onToggle }) {
  return (
    <ul>
      {artworks.map((artwork) => (
        <li key={artwork.id}>
          <label>
            <input
              type="checkbox"
              checked={artwork.seen}
              onChange={(e) => {
                onToggle(artwork.id, e.target.checked);
              }}
            />
            {artwork.title}
          </label>
        </li>
      ))}
    </ul>
  );
}
Проблема в этом коде:
const myNextList = [...myList];
const artwork = myNextList.find((a) => a.id === artworkId);
artwork.seen = nextSeen; // Проблема: мутируется существующий элемент
setMyList(myNextList);
Хотя сам массив myNextList новый, сами элементы те же, что и в исходном массиве myList. Таким образом, изменение artwork.seen изменяет исходный элемент изображения. Этот предмет искусства также находится в ваших произведениях искусства, что вызывает ошибку. О таких ошибках может быть трудно догадаться, но, к счастью, они исчезают, если вы избегаете мутирующего состояния. Вы можете использовать map, чтобы заменить старый элемент его обновленной версией без изменения.
setMyList(myList.map(artwork => {
  if (artwork.id === artworkId) {
    // Создает *новый* объект с изменениями
    return { ...artwork, seen: nextSeen };
  } else {
    // без изменений
    return artwork;
  }
});
Здесь ... — это синтаксис распыления объекта, используемый для создания копии объекта.
При таком подходе ни один из существующих элементов состояния не мутируется, а ошибка исправлена:
import { useState } from 'react';

let nextId = 3;
const initialList = [
  { id: 0, title: 'Big Bellies', seen: false },
  { id: 1, title: 'Lunar Landscape', seen: false },
  { id: 2, title: 'Terracotta Army', seen: true },
];

export default function BucketList() {
  const [myList, setMyList] = useState(initialList);
  const [yourList, setYourList] = useState(initialList);

  function handleToggleMyList(artworkId, nextSeen) {
    setMyList(
      myList.map((artwork) => {
        if (artwork.id === artworkId) {
          // Создает *новый* объект с изменениями
          return { ...artwork, seen: nextSeen };
        } else {
          // без изменений
          return artwork;
        }
      })
    );
  }

  function handleToggleYourList(artworkId, nextSeen) {
    setYourList(
      yourList.map((artwork) => {
        if (artwork.id === artworkId) {
          // Создает *новый* объект с изменениями
          return { ...artwork, seen: nextSeen };
        } else {
          // без изменений
          return artwork;
        }
      })
    );
  }

  return (
    <>
      <h1>Art Bucket List</h1>
      <h2>My list of art to see:</h2>
      <ItemList artworks={myList} onToggle={handleToggleMyList} />
      <h2>Your list of art to see:</h2>
      <ItemList artworks={yourList} onToggle={handleToggleYourList} />
    </>
  );
}

function ItemList({ artworks, onToggle }) {
  return (
    <ul>
      {artworks.map((artwork) => (
        <li key={artwork.id}>
          <label>
            <input
              type="checkbox"
              checked={artwork.seen}
              onChange={(e) => {
                onToggle(artwork.id, e.target.checked);
              }}
            />
            {artwork.title}
          </label>
        </li>
      ))}
    </ul>
  );
}
Как правило, вам следует мутировать только те объекты, которые вы только что создали. Если бы вы вставляли новое изображение, вы могли бы изменить его, но если вы имеете дело с чем-то, что уже находится в состоянии, вам нужно сделать копию.

Напишем лаконичный код обновления с помощью Immer

Обновление вложенных массивов без изменения может стать немного повторяющимся. Так же, как и с объектами:
  • Как правило, вам не нужно обновлять состояние глубже, чем на пару уровней. Если ваши объекты состояния очень глубокие, вы можете захотеть реструктурировать их по-другому, чтобы они были плоскими.
  • Если вы не хотите менять свою структуру состояния, вы можете предпочесть использовать Immer, который позволяет вам писать с использованием удобного, но мутирующего синтаксиса и заботится о создании копий для вас.
Вот пример Art Bucket List, переписанный с помощью Immer:
import { useState } from 'react';
import { useImmer } from 'use-immer';

let nextId = 3;
const initialList = [
  { id: 0, title: 'Big Bellies', seen: false },
  { id: 1, title: 'Lunar Landscape', seen: false },
  { id: 2, title: 'Terracotta Army', seen: true },
];

export default function BucketList() {
  const [myList, updateMyList] = useImmer(initialList);
  const [yourArtworks, updateYourList] = useImmer(initialList);

  function handleToggleMyList(id, nextSeen) {
    updateMyList((draft) => {
      const artwork = draft.find((a) => a.id === id);
      artwork.seen = nextSeen;
    });
  }

  function handleToggleYourList(artworkId, nextSeen) {
    updateYourList((draft) => {
      const artwork = draft.find((a) => a.id === artworkId);
      artwork.seen = nextSeen;
    });
  }

  return (
    <>
      <h1>Art Bucket List</h1>
      <h2>My list of art to see:</h2>
      <ItemList artworks={myList} onToggle={handleToggleMyList} />
      <h2>Your list of art to see:</h2>
      <ItemList artworks={yourArtworks} onToggle={handleToggleYourList} />
    </>
  );
}

function ItemList({ artworks, onToggle }) {
  return (
    <ul>
      {artworks.map((artwork) => (
        <li key={artwork.id}>
          <label>
            <input
              type="checkbox"
              checked={artwork.seen}
              onChange={(e) => {
                onToggle(artwork.id, e.target.checked);
              }}
            />
            {artwork.title}
          </label>
        </li>
      ))}
    </ul>
  );
}
package.json
{
  "dependencies": {
    "immer": "1.7.3",
    "react": "latest",
    "react-dom": "latest",
    "react-scripts": "latest",
    "use-immer": "0.5.1"
  },
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test --env=jsdom",
    "eject": "react-scripts eject"
  },
  "devDependencies": {}
}
Обратите внимание, как с Immer мутация, такая как artwork.seen = nextSeen, теперь исправлена:
updateMyTodos((draft) => {
  const artwork = draft.find((a) => a.id === artworkId);
  artwork.seen = nextSeen;
});
Это связано с тем, что вы мутируете не исходное состояние, а изменяете специальный объект-черновик (draft), предоставленный Immer. Точно так же вы можете применять методы мутирования, такие как push() и pop(), к содержимому черновика. За кулисами Immer всегда строит следующее состояние с нуля в соответствии с изменениями, которые вы внесли в черновик. Это позволяет вашим обработчикам событий быть очень лаконичными без мутирования состояния.

Резюме

  • Вы можете поместить массивы в состояние, но вы не можете их мутировать.
  • Вместо того, чтобы мутировать массив, создайте его новую версию и обновите для нее состояние.
  • Вы можете использовать синтаксис распыления массива [...arr, newItem] для создания массивов с новыми элементами.
  • Вы можете использовать filter() и map() для создания новых массивов с отфильтрованными или преобразованными элементами.
  • Вы можете использовать Immer, чтобы ваш код был короче.