From 0020291d63c0bba3015be5e47ca76fa71e34756e Mon Sep 17 00:00:00 2001 From: Spencer Miskoviak Date: Wed, 5 Oct 2022 09:10:15 -0600 Subject: [PATCH] docs: initial v6 migration guide --- README.md | 5 +++-- docs/migration-guides/v6.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 31 insertions(+), 2 deletions(-) create mode 100644 docs/migration-guides/v6.md diff --git a/README.md b/README.md index 8ece9fd0..c5d8f25d 100644 --- a/README.md +++ b/README.md @@ -49,8 +49,9 @@ $ yarn add --dev eslint-plugin-testing-library You can find detailed guides for migrating `eslint-plugin-testing-library` in the [migration guide docs](docs/migration-guides): -- [Migrate guide for v4](docs/migration-guides/v4.md) -- [Migrate guide for v5](docs/migration-guides/v5.md) +- [Migration guide for v4](docs/migration-guides/v4.md) +- [Migration guide for v5](docs/migration-guides/v5.md) +- [Migration guide for v6](docs/migration-guides/v6.md) ## Usage diff --git a/docs/migration-guides/v6.md b/docs/migration-guides/v6.md new file mode 100644 index 00000000..574020f4 --- /dev/null +++ b/docs/migration-guides/v6.md @@ -0,0 +1,28 @@ +# Guide: migrating to v6 + +If you are not on v5 yet, we recommend first following the [v5 migration guide](docs/migration-guides/v5.md). + +## Overview + +- `prefer-wait-for` was removed +- `await-fire-event` is now called `await-async-events` with support for an `eventModule` option with `userEvent` and/or `fireEvent` +- `await-async-events` is now enabled by default for `fireEvent` in Vue and Marko shared configs +- `await-async-events` is now enabled by default for `userEvent` in all shared configs +- `await-async-query` is now called `await-async-queries` +- `no-await-async-query` is now called `no-await-async-queries` +- `no-render-in-setup` is now called `no-render-in-lifecycle` +- `no-await-sync-events` is now enabled by default in React, Angular, and DOM shared configs +- `no-manual-cleanup` is now enabled by default in React and Vue shared configs +- `no-global-regexp-flag-in-query` is now enabled by default in all shared configs +- `no-node-access` is now enabled by default in DOM shared config +- `no-debugging-utils` now reports all debugging utility methods by default +- `no-debugging-utils` now defaults to `warn` instead of `error` in all shared configs + +## Steps to upgrade + +- Removing `testing-library/prefer-wait-for` if you were referencing it manually somewhere +- Renaming `testing-library/await-fire-event` to `testing-library/await-async-events` if you were referencing it manually somewhere +- Renaming `testing-library/await-async-query` to `testing-library/await-async-queries` if you were referencing it manually somewhere +- Renaming `testing-library/no-await-async-query` to `testing-library/no-await-async-queries` if you were referencing it manually somewhere +- Renaming `testing-library/no-render-in-setup` to `testing-library/no-render-in-lifecycle` if you were referencing it manually somewhere +- Being aware of new rules enabled or changed above in shared configs which can lead to newly reported errors