Skip to content

Commit 0b40e67

Browse files
committed
Merge branch 'v5/improved-helper-plugin-bc' into next
2 parents e8d85ad + 35f44c5 commit 0b40e67

File tree

3 files changed

+34
-8
lines changed

3 files changed

+34
-8
lines changed

docusaurus/docs/dev-docs/migration/v4-to-v5/breaking-changes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ You can click on the description of any breaking change in the following tables
7777
| Description | Affects plugins | Handled by codemods |
7878
|-------------|-----------------|---------------------|
7979
| [Users & Permissions `register.allowedFields` defaults to `[]`](/dev-docs/migration/v4-to-v5/breaking-changes/register-allowed-fields) | No | ✅ Yes |
80-
| [The `helper-plugin` is deprecated](/dev-docs/migration/v4-to-v5/breaking-changes/helper-plugin-deprecated) | Yes | No |
80+
| [The `helper-plugin` is removed](/dev-docs/migration/v4-to-v5/breaking-changes/helper-plugin-deprecated) | Yes | 👷 Partly |
8181
| [`injectContentManagerComponent()` is removed in favor of `getPlugin('content-manager').injectComponent()`](/dev-docs/migration/v4-to-v5/breaking-changes/inject-content-manager-component) | Yes | No |
8282
| [Some Mailgun provider legacy variables are not supported](/dev-docs/migration/v4-to-v5/breaking-changes/mailgun-provider-variables) | Yes | No |
8383
| [The `lockIcon` property has been replaced by `licenseOnly`](/dev-docs/migration/v4-to-v5/breaking-changes/license-only) | Yes | No |

docusaurus/docs/dev-docs/migration/v4-to-v5/breaking-changes/helper-plugin-deprecated.md

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: helper-plugin deprecated
3-
description: In Strapi 5, the `helper-plugin` is deprecated. A whole migration reference is available for plugin developers.
4-
sidebar_label: helper-plugin deprecated
2+
title: helper-plugin removed
3+
description: In Strapi 5, the `helper-plugin` is removed. A whole migration reference is available for plugin developers, and codemods will automatically handle some changes.
4+
sidebar_label: helper-plugin removed
55
displayed_sidebar: devDocsMigrationV5Sidebar
66
tags:
77
- breaking changes
@@ -12,16 +12,16 @@ tags:
1212
import Intro from '/docs/snippets/breaking-change-page-intro.md'
1313
import MigrationIntro from '/docs/snippets/breaking-change-page-migration-intro.md'
1414
import YesPlugins from '/docs/snippets/breaking-change-affecting-plugins.md'
15-
import NoCodemods from '/docs/snippets/breaking-change-not-handled-by-codemod.md'
15+
import PartialCodemods from '/docs/snippets/breaking-change-partially-handled-by-codemod.md'
1616

1717
# `helper-plugin` deprecated
1818

19-
In Strapi 5, the `helper-plugin` is deprecated. A whole migration guide is available for plugin developers.
19+
In Strapi 5, the `helper-plugin` is removed. A whole migration reference is available for plugin developers, and codemods will automatically handle some changes.
2020

2121
<Intro />
2222

2323
<YesPlugins />
24-
<NoCodemods />
24+
<PartialCodemods />
2525

2626
## Breaking change description
2727

@@ -47,4 +47,26 @@ The `helper-plugin` is deprecated.
4747

4848
## Migration
4949

50-
Users should follow information found in the extensive [migration guide](/dev-docs/migration/v4-to-v5/additional-resources/helper-plugin).
50+
Codemods handles some but not all of the changes. The following changes are handled:
51+
52+
| Action | Now handled in Strapi 5 by… |
53+
|---------------------------------------------|-------------------------------|
54+
| Change `AnErrorOccurred` import | @strapi/strapi/admin |
55+
| Replace `AnErrorOccurred` with `Page.Error` | @strapi/strapi/admin |
56+
| Change `ConfirmDialog` import | @strapi/strapi/admin |
57+
| Change `getFetchClient` import | @strapi/strapi/admin |
58+
| Change `LoadingIndicatorPage` import | @strapi/strapi/admin |
59+
| Replace `LoadingIndicatorPage` with `Page.Loading` | @strapi/strapi/admin |
60+
| Change `NoPermissions` import | @strapi/strapi/admin |
61+
| Replace `NoPermissions` with `Page.NoPermissions` | @strapi/strapi/admin |
62+
| Change `translatedErrors` import | @strapi/strapi/admin |
63+
| Change `useFetchClient` import | @strapi/strapi/admin |
64+
| Change `useQueryParams` import | @strapi/strapi/admin |
65+
| Change `SearchURLQuery` import | @strapi/strapi/admin |
66+
| Change `DateTimePicker` import | @strapi/design-system |
67+
| Change `Status` import | @strapi/design-system |
68+
| Change `useCallbackRef` import | @strapi/design-system |
69+
| Change `useCollator` import | @strapi/design-system |
70+
| Change `useFilter` import | @strapi/design-system |
71+
72+
Users should refer to additional information found in the extensive [migration guide](/dev-docs/migration/v4-to-v5/additional-resources/helper-plugin) to ensure a smooth migration.

docusaurus/docs/dev-docs/migration/v4-to-v5/step-by-step.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ Strapi provides a tool to automate some parts of the upgrade to Strapi 5: the [u
7272
| [use-uid-for-config-namespace](https://github.com/strapi/strapi/blob/v5/main/packages/utils/upgrade/resources/codemods/5.0.0/use-uid-for-config-namespace.code.ts) | Replace string dot format for config get/set/has with uid format for 'plugin' and 'api' namespace where possible |
7373
| [utils-public-interface](https://github.com/strapi/strapi/blob/v5/main/packages/utils/upgrade/resources/codemods/5.0.0/utils-public-interface.code.ts) | Update utils to use the new public interface |
7474

75+
:::tip
76+
If you develop Strapi plugins, other codemods handle some aspects of the helper-plugin deprecation. See the [related breaking change](/dev-docs/migration/v4-to-v5/breaking-changes/helper-plugin-deprecated) for more information.
77+
:::
78+
7579
2. Go over the changes made by the upgrade tool to **check if you have to manually complete some code updates**:
7680

7781
Look for `__TODO__` automatically added to your code by the codemods. Some of them might have been added while migrating from the Entity Service API to the new Document Service API introduced in Strapi 5.

0 commit comments

Comments
 (0)