Merge pull request #502 from VitNode/lang/improve_admin_keys

perf(frontend): Improve name keys for plugin in AdminCP
VitNode · Sep 9, 2024 · 32a2763 · 32a2763
2 parents 0a12058 + aa1d084
commit 32a2763
Show file tree

Hide file tree

Showing 15 changed files with 55 additions and 62 deletions.
diff --git a/apps/docs/content/docs/dev/pages-admin.mdx b/apps/docs/content/docs/dev/pages-admin.mdx
@@ -52,21 +52,20 @@ Default language is English `en`. If you have more then one language add keys to
 
 ### Language Keys
 
-- **Title Plugin** - key is always `{your_plugin_code}.admin.nav.title`.  
+- **Title Plugin** - key is always `admin_{your_plugin_code}.nav.title`.  
   For example: `blog.admin.nav.title`,
-- **Navigation item** - key is always `{your_plugin_code}.admin.nav.{navigation_item_name}`.  
+- **Navigation item** - key is always `admin_{your_plugin_code}.nav.{navigation_item_name}`.  
   For example: `blog.admin.nav.categories`.
 
 Here is an example of the language keys:
 
 ```json title="en.json"
 {
-  "blog": {
-    "admin": {
-      "nav": {
-        "title": "Blog",
-        "categories": "Categories"
-      }
+  "blog": {},
+  "admin_blog": {
+    "nav": {
+      "title": "Blog",
+      "categories": "Categories"
     }
   }
 }

diff --git a/apps/frontend/src/plugins/core/langs/en.json b/apps/frontend/src/plugins/core/langs/en.json
@@ -338,27 +338,6 @@
         "contact": "Contact with Us"
       }
     },
-    "admin": {
-      "nav": {
-        "title": "Core",
-        "dashboard": "Dashboard",
-        "settings": "Settings",
-        "settings_general": "General",
-        "settings_security": "Security",
-        "settings_metadata": "Metadata",
-        "settings_email": "Email",
-        "settings_authorization": "Authorization",
-        "settings_legal": "Legal & Policies",
-        "plugins": "Plugins",
-        "styles": "Styles",
-        "styles_theme-editor": "Theme Editor",
-        "styles_nav": "Navigation",
-        "styles_editor": "Editor",
-        "langs": "Languages",
-        "advanced": "Advanced",
-        "advanced_files": "Files"
-      }
-    },
     "legal": {
       "title": "Legal & Policies",
       "title_page": "Explore our Legal documents and Policies",
@@ -367,16 +346,35 @@
       "empty": "No documents found."
     }
   },
-  "members": {
-    "admin": {
-      "nav": {
-        "title": "Members",
-        "users": "Users List",
-        "groups": "Groups",
-        "staff": "Staff",
-        "staff_moderators": "Moderators",
-        "staff_administrators": "Administrators"
-      }
+  "admin_core": {
+    "nav": {
+      "title": "Core",
+      "dashboard": "Dashboard",
+      "settings": "Settings",
+      "settings_general": "General",
+      "settings_security": "Security",
+      "settings_metadata": "Metadata",
+      "settings_email": "Email",
+      "settings_authorization": "Authorization",
+      "settings_legal": "Legal & Policies",
+      "plugins": "Plugins",
+      "styles": "Styles",
+      "styles_theme-editor": "Theme Editor",
+      "styles_nav": "Navigation",
+      "styles_editor": "Editor",
+      "langs": "Languages",
+      "advanced": "Advanced",
+      "advanced_files": "Files"
+    }
+  },
+  "admin_members": {
+    "nav": {
+      "title": "Members",
+      "users": "Users List",
+      "groups": "Groups",
+      "staff": "Staff",
+      "staff_moderators": "Moderators",
+      "staff_administrators": "Administrators"
     }
   }
 }
diff --git a/apps/frontend/src/plugins/welcome/langs/en.json b/apps/frontend/src/plugins/welcome/langs/en.json
@@ -1,5 +1,4 @@
 {
-  "welcome": {
-    "admin": {}
-  }
-}
+  "welcome": {},
+  "admin_welcome": {}
+}
diff --git a/packages/backend/scripts/database.ts b/packages/backend/scripts/database.ts
@@ -7,8 +7,6 @@ const execShellCommand = async (cmd: string) => {
         reject(error);
       }
       const result = stdout ? stdout : stderr;
-      // eslint-disable-next-line no-console
-      console.log(result);
 
       resolve(result);
     });

diff --git a/packages/backend/src/core/admin/plugins/create/create.service.ts b/packages/backend/src/core/admin/plugins/create/create.service.ts
@@ -72,9 +72,8 @@ export class CreateAdminPluginsService {
         join(langPath, `${lang.code}.json`),
         JSON.stringify(
           {
-            [code]: {
-              admin: {},
-            },
+            [code]: {},
+            [`admin_${code}`]: {},
           },
           null,
           2,

diff --git a/packages/frontend/src/views/admin/layout/auth/aside/search/items/page.tsx b/packages/frontend/src/views/admin/layout/auth/aside/search/items/page.tsx
@@ -20,7 +20,7 @@ export const PageItemContentSearchAsideAuthAdmin = ({
 }: Props) => {
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-expect-error
-  const t = useTranslations(`${code_plugin}.admin`);
+  const t = useTranslations(`admin_${code_plugin}`);
   const { push } = useRouter();
   const href = parent_nav_code
     ? `/admin/${code_plugin}/${parent_nav_code}/${hrefFromProps}`

diff --git a/packages/frontend/src/views/admin/layout/auth/nav/item/item.tsx b/packages/frontend/src/views/admin/layout/auth/nav/item/item.tsx
@@ -12,7 +12,7 @@ export const ItemNavAdmin = ({
 }) => {
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-expect-error
-  const t = useTranslations(`${id}.admin`);
+  const t = useTranslations(`admin_${id}`);
 
   return (
     <>

diff --git a/packages/frontend/src/views/admin/layout/auth/nav/item/link.tsx b/packages/frontend/src/views/admin/layout/auth/nav/item/link.tsx
@@ -31,7 +31,7 @@ export const LinkItemNavAdmin = ({
 }: Props) => {
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-expect-error
-  const t = useTranslations(`${plugin_code}.admin.nav`);
+  const t = useTranslations(`admin_${plugin_code}.nav`);
   const pathname = usePathname();
   const href = `/admin/${plugin_code}/${hrefFromProps}`;
   const active = pathname.startsWith(`/admin/${plugin_code}/${id}`);

diff --git a/packages/frontend/src/views/admin/views/core/plugins/views/dev/layout/layout.tsx b/packages/frontend/src/views/admin/views/core/plugins/views/dev/layout/layout.tsx
@@ -26,7 +26,7 @@ export async function generateMetadataDevPluginAdminLayout({
 }: DevPluginAdminLayoutProps): Promise<Metadata> {
   const [t, tCore, config] = await Promise.all([
     getTranslations('admin'),
-    getTranslations('core.admin'),
+    getTranslations('admin_core'),
     getGlobalData(),
   ]);
 

diff --git a/...ges/frontend/src/views/admin/views/core/plugins/views/dev/nav/create-edit/create-edit.tsx b/...ges/frontend/src/views/admin/views/core/plugins/views/dev/nav/create-edit/create-edit.tsx
@@ -38,7 +38,7 @@ export const CreateEditNavDevPluginAdmin = ({
   const tPlugin = useTranslations(
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-expect-error
-    `${Array.isArray(code) ? code[0] : code}.admin.nav`,
+    `admin_${Array.isArray(code) ? code[0] : code}.nav`,
   );
 
   return (

diff --git a/packages/frontend/src/views/admin/views/core/plugins/views/dev/nav/item/item.tsx b/packages/frontend/src/views/admin/views/core/plugins/views/dev/nav/item/item.tsx
@@ -12,7 +12,7 @@ export const ItemContentNavDevPluginAdmin = (
   const { code: pluginCode } = useParams();
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-expect-error
-  const t = useTranslations(`${pluginCode}.admin.nav`);
+  const t = useTranslations(`admin_${pluginCode}.nav`);
   const tAdmin = useTranslations('admin.core.plugins.dev.nav');
   const tCore = useTranslations('core');
   const { parentId, icons } = useItemNavDevPluginAdmin();
@@ -30,7 +30,7 @@ export const ItemContentNavDevPluginAdmin = (
         <p className="text-muted-foreground text-sm">
           {tAdmin.rich('lang_key', {
             key: () => (
-              <span className="text-foreground">{`${pluginCode}.admin.nav.${langKey}`}</span>
+              <span className="text-foreground">{`admin_${pluginCode}.nav.${langKey}`}</span>
             ),
           })}
         </p>

diff --git a/.../views/admin/views/core/settings/authorization/authorization-settings-core-admin-view.tsx b/.../views/admin/views/core/settings/authorization/authorization-settings-core-admin-view.tsx
@@ -21,7 +21,7 @@ const getData = async () => {
 
 export const generateMetadataAuthorizationSettingsAdmin =
   async (): Promise<Metadata> => {
-    const t = await getTranslations('core.admin.nav');
+    const t = await getTranslations('admin_core.nav');
 
     return {
       title: t('settings_authorization'),
@@ -30,7 +30,7 @@ export const generateMetadataAuthorizationSettingsAdmin =
 
 export const AuthorizationSettingsCoreAdminView = async () => {
   const [t, data] = await Promise.all([
-    getTranslations('core.admin.nav'),
+    getTranslations('admin_core.nav'),
     getData(),
   ]);
 

diff --git a/packages/frontend/src/views/admin/views/core/settings/email/email-settings-admin-view.tsx b/packages/frontend/src/views/admin/views/core/settings/email/email-settings-admin-view.tsx
@@ -26,7 +26,7 @@ const getData = async () => {
 
 export const generateMetadataEmailSettingsAdmin =
   async (): Promise<Metadata> => {
-    const t = await getTranslations('core.admin.nav');
+    const t = await getTranslations('admin_core.nav');
 
     return {
       title: t('settings_email'),
@@ -35,7 +35,7 @@ export const generateMetadataEmailSettingsAdmin =
 
 export const EmailSettingsAdminView = async () => {
   const [t, data] = await Promise.all([
-    getTranslations('core.admin.nav'),
+    getTranslations('admin_core.nav'),
     getData(),
   ]);
 

diff --git a/packages/frontend/src/views/admin/views/core/settings/main/main-settings-core-admin-view.tsx b/packages/frontend/src/views/admin/views/core/settings/main/main-settings-core-admin-view.tsx
@@ -24,7 +24,7 @@ const getData = async () => {
 
 export const generateMetadataMainSettingsCoreAdmin =
   async (): Promise<Metadata> => {
-    const t = await getTranslations('core.admin.nav');
+    const t = await getTranslations('admin_core.nav');
 
     return {
       title: t('settings_general'),
@@ -33,7 +33,7 @@ export const generateMetadataMainSettingsCoreAdmin =
 
 export const MainSettingsCoreAdminView = async () => {
   const [t, data] = await Promise.all([
-    getTranslations('core.admin.nav'),
+    getTranslations('admin_core.nav'),
     getData(),
   ]);
 

diff --git a/packages/frontend/src/views/admin/views/theme_editor/theme-editor-view.tsx b/packages/frontend/src/views/admin/views/theme_editor/theme-editor-view.tsx
@@ -23,7 +23,7 @@ const getData = async () => {
 };
 
 export const generateMetadataThemeEditor = async (): Promise<Metadata> => {
-  const t = await getTranslations('core.admin.nav');
+  const t = await getTranslations('admin_core.nav');
 
   return {
     title: t('styles_theme-editor'),