fix: build templates for Strapi 5 (#11)

strapi · May 8, 2024 · 8891da5 · 8891da5
1 parent 8b8b5aa
commit 8891da5
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 18 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1,4 +1,5 @@
 bin
 coverage
 dist
-*.yaml
+*.yaml
+.changeset
diff --git a/.prettierignore b/.prettierignore
@@ -1,3 +1,4 @@
 bin
 dist
-pnpm-lock.yaml
+pnpm-lock.yaml
+.changeset
diff --git a/README.md b/README.md
@@ -29,6 +29,8 @@ npx @strapi/sdk-plugin@latest init my-plugin
 
 That will create a directory with all your plugin project files.
 
+Once your project has been installed, you will have access to the `strapi-plugin` command.
+
 Run `strapi-plugin -h` for more information on CLI usage.
 
 ## Commands

diff --git a/bin/sdk-plugin.js → bin/strapi-plugin.js b/bin/sdk-plugin.js → bin/strapi-plugin.js
diff --git a/package.json b/package.json
@@ -34,7 +34,7 @@
     },
     "./package.json": "./package.json"
   },
-  "bin": "./bin/sdk-plugin.js",
+  "bin": "./bin/strapi-plugin.js",
   "files": [
     "bin",
     "dist"

diff --git a/src/cli/commands/plugin/init/action.ts b/src/cli/commands/plugin/init/action.ts
@@ -13,6 +13,13 @@ import type { InitOptions, TemplateFile } from '@strapi/pack-up';
 
 type ActionOptions = Pick<InitOptions, 'silent' | 'debug'>;
 
+// TODO: remove these when release versions are available
+const USE_BETA_VERSIONS: string[] = [
+  '@strapi/design-system',
+  '@strapi/icons',
+  '@strapi/strapi',
+] as const;
+
 export default async (
   packagePath: string,
   { silent, debug }: ActionOptions,
@@ -246,7 +253,8 @@ const PLUGIN_TEMPLATE = defineTemplate(async ({ logger, gitConfig, packagePath }
           prettier: '*',
         },
         peerDependencies: {
-          '@strapi/strapi': '^4.0.0',
+          // TODO: set this to 5.0.0 when Strapi 5 is released
+          '@strapi/strapi': '^5.0.0-beta',
         },
         strapi: {
           kind: 'plugin',
@@ -306,15 +314,15 @@ const PLUGIN_TEMPLATE = defineTemplate(async ({ logger, gitConfig, packagePath }
                   react: '*',
                   'react-dom': '*',
                   'react-router-dom': '*',
-                  'styled-components': '5.3.3',
+                  'styled-components': '*',
                 };
 
                 pkgJson.peerDependencies = {
                   ...pkgJson.peerDependencies,
                   react: '^17.0.0 || ^18.0.0',
                   'react-dom': '^17.0.0 || ^18.0.0',
                   'react-router-dom': '^6.0.0',
-                  'styled-components': '^5.2.1',
+                  'styled-components': '^6.0.0',
                 };
               }
 
@@ -364,7 +372,6 @@ const PLUGIN_TEMPLATE = defineTemplate(async ({ logger, gitConfig, packagePath }
                     ...pkgJson.devDependencies,
                     '@types/react': '*',
                     '@types/react-dom': '*',
-                    '@types/styled-components': '5.1.32',
                   };
 
                   const { adminTsconfigFiles } = await import('./files/typescript');
@@ -526,7 +533,8 @@ const resolveLatestVerisonOfDeps = async (
 
   for (const [name, version] of Object.entries(deps)) {
     try {
-      const latestVersion = await getLatestVersion(name, version);
+      const range = USE_BETA_VERSIONS.includes(name) ? 'beta' : version;
+      const latestVersion = await getLatestVersion(name, { range });
       latestDeps[name] = latestVersion ? `^${latestVersion}` : '*';
     } catch (err) {
       latestDeps[name] = '*';

diff --git a/src/cli/commands/plugin/init/files/admin.ts b/src/cli/commands/plugin/init/files/admin.ts
@@ -11,19 +11,17 @@ export { PluginIcon };
 `;
 
 const APP_CODE = outdent`
-import { Page } from '@strapi/strapi/admin';
-import { Switch, Route } from 'react-router-dom';
-
-import { PLUGIN_ID } from '../pluginId';
+import { Page } from '@strapi/design-system';
+import { Routes, Route } from 'react-router-dom';
 
 import { HomePage } from './HomePage';
 
 const App = () => {
   return (
-    <Switch>
+    <Routes>
       <Route index element={<HomePage />} />
       <Route path="*" element={<Page.Error />} />
-    </Switch>
+    </Routes>
   );
 };
 
@@ -53,7 +51,7 @@ const TYPESCRIPT: TemplateFile[] = [
   {
     name: 'admin/src/index.ts',
     contents: outdent`
-        import { prefixPluginTranslations } from './utils/prefixPluginTranslations';
+        import { getTranslation } from './utils/getTranslation';
         import { PLUGIN_ID } from './pluginId';
         import { Initializer } from './components/Initializer';
         import { PluginIcon } from './components/PluginIcon';
@@ -90,7 +88,7 @@ const TYPESCRIPT: TemplateFile[] = [
                 return import(\`./translations/\${locale}.json\`)
                   .then(({ default: data }) => {
                     return {
-                      data: prefixPluginTranslations(data, PLUGIN_ID),
+                      data: getTranslation(data),
                       locale,
                     };
                   })
@@ -176,7 +174,7 @@ const JAVASCRIPT: TemplateFile[] = [
   {
     name: 'admin/src/index.js',
     contents: outdent`
-            import { prefixPluginTranslations } from './utils/prefixPluginTranslations';
+            import { getTranslation } from './utils/getTranslation';
             import { PLUGIN_ID } from './pluginId';
             import { Initializer } from './components/Initializer';
             import { PluginIcon } from './components/PluginIcon';
@@ -213,7 +211,7 @@ const JAVASCRIPT: TemplateFile[] = [
                     return import(\`./translations/\${locale}.json\`)
                       .then(({ default: data }) => {
                         return {
-                          data: prefixPluginTranslations(data, PLUGIN_ID),
+                          data: getTranslation(data),
                           locale,
                         };
                       })