feat(plugins): add meta.js for plugins and replace all hard-coding pl…

…ugin id (#506)

* feat(plugins): add meta.js for plugins

* feat(plugins): add generateComment vite plugin for tiny-engine plugins

* feat(plugins): remove metaService comments

* add i18n plugin metaService comment

packages/common/component/BindI18n.vue

@@ -117,7 +117,8 @@ export default {
       emit('bind', { ...data, key })
     }
 
-    const activeI18n = () => useLayout().activePlugin('I18n')
+    const { PLUGIN_NAME, activePlugin } = useLayout()
+    const activeI18n = () => activePlugin(PLUGIN_NAME.I18n)
 
     const addBindI18n = () => {
       useTranslate().ensureI18n(editForm, true)

packages/controller/src/useLayout.js

@@ -16,13 +16,20 @@ import { constants } from '@opentiny/tiny-engine-utils'
 const { PAGE_STATUS } = constants
 
 const PLUGIN_NAME = {
-  Materials: 'Materials',
-  AppManage: 'AppManage',
-  BlockManage: 'BlockManage',
-  PageController: 'PageController',
+  Materials: 'engine.plugins.materials',
+  AppManage: 'engine.plugins.appmanage',
+  BlockManage: 'engine.plugins.blockmanage',
+  Bridge: 'engine.plugins.bridge',
+  DataSource: 'engine.plugins.datasource',
+  Collections: 'engine.plugins.collections',
+  EditorHelp: 'engine.plugins.editorhelp',
+  I18n: 'engine.plugins.i18n',
+  Robot: 'engine.plugins.robot',
+  Schema: 'engine.plugins.schema',
+  PageController: 'engine.plugins.pagecontroller',
+  OutlineTree: 'engine.plugins.outlinetree',
+  Tutorial: 'engine.plugins.tutorial',
   Lock: 'Lock',
-  Tutorial: 'Tutorial',
-  OutlineTree: 'OutlineTree',
   save: 'save'
 }
 

packages/design-core/src/DesignPlugins.vue

@@ -119,9 +119,9 @@ export default {
     const robotVisible = ref(false)
     const robotComponent = ref(null)
     const { isTemporaryPage } = usePage()
-    const HELP_PLUGIN_ID = 'EditorHelp'
 
     const {
+      PLUGIN_NAME,
       pluginState,
       registerPluginApi,
       layoutState: { plugins: pluginsState }
@@ -154,7 +154,7 @@ export default {
     }
 
     const clickMenu = ({ item, index }) => {
-      if (item.id === HELP_PLUGIN_ID) return
+      if (item.id === PLUGIN_NAME.EditorHelp) return
       state.prevIdex = index
 
       // 切换插件与关闭插件时确认
@@ -177,16 +177,16 @@ export default {
     }
     watch(isTemporaryPage, () => {
       if (isTemporaryPage.saved) {
-        const pagePanel = state.topNavLists?.find((item) => item.id === 'AppManage') || null
-        const pageIndex = state.topNavLists?.findIndex((item) => item.id === 'AppManage') || -1
+        const pagePanel = state.topNavLists?.find((item) => item.id === PLUGIN_NAME.AppManage) || null
+        const pageIndex = state.topNavLists?.findIndex((item) => item.id === PLUGIN_NAME.AppManage) || -1
         if (pagePanel !== props.renderPanel) {
           clickMenu({ item: pagePanel, index: pageIndex })
         }
       }
     })
 
     const openAIRobot = () => {
-      robotComponent.value = components.Robot
+      robotComponent.value = components[PLUGIN_NAME.Robot]
       robotVisible.value = !robotVisible.value
     }
     const close = () => {

packages/plugins/block/index.js

@@ -1,22 +1,20 @@
 /**
-* Copyright (c) 2023 - present TinyEngine Authors.
-* Copyright (c) 2023 - present Huawei Cloud Computing Technologies Co., Ltd.
-*
-* Use of this source code is governed by an MIT-style license.
-*
-* THE OPEN SOURCE SOFTWARE IN THIS PRODUCT IS DISTRIBUTED IN THE HOPE THAT IT WILL BE USEFUL,
-* BUT WITHOUT ANY WARRANTY, WITHOUT EVEN THE IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR
-* A PARTICULAR PURPOSE. SEE THE APPLICABLE LICENSES FOR MORE DETAILS.
-*
-*/
+ * Copyright (c) 2023 - present TinyEngine Authors.
+ * Copyright (c) 2023 - present Huawei Cloud Computing Technologies Co., Ltd.
+ *
+ * Use of this source code is governed by an MIT-style license.
+ *
+ * THE OPEN SOURCE SOFTWARE IN THIS PRODUCT IS DISTRIBUTED IN THE HOPE THAT IT WILL BE USEFUL,
+ * BUT WITHOUT ANY WARRANTY, WITHOUT EVEN THE IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR
+ * A PARTICULAR PURPOSE. SEE THE APPLICABLE LICENSES FOR MORE DETAILS.
+ *
+ */
 
 import component, { api } from './src/Main.vue'
+import metaData from './meta.js'
 
 export default {
-  id: 'BlockManage',
-  title: '区块管理',
-  icon: 'plugin-icon-symbol',
-  align: 'top',
+  ...metaData,
   api,
   component
 }

packages/plugins/block/meta.js

@@ -0,0 +1,7 @@
+export default {
+  id: 'engine.plugins.blockmanage',
+  title: '区块管理',
+  type: 'plugins',
+  align: 'top',
+  icon: 'plugin-icon-symbol'
+}

packages/plugins/block/package.json

@@ -27,12 +27,14 @@
     "@opentiny/tiny-engine-canvas": "workspace:*",
     "@opentiny/tiny-engine-common": "workspace:*",
     "@opentiny/tiny-engine-controller": "workspace:*",
+    "@opentiny/tiny-engine-entry": "workspace:*",
     "@opentiny/tiny-engine-http": "workspace:*",
     "@opentiny/tiny-engine-utils": "workspace:*",
     "html2canvas": "^1.4.1",
     "pinyin-pro": "^3.13.0"
   },
   "devDependencies": {
+    "@opentiny/vite-plugin-generate-comments": "workspace:*",
     "@vitejs/plugin-vue": "^4.2.3",
     "@vitejs/plugin-vue-jsx": "^3.1.0",
     "vite": "^4.3.7"

packages/plugins/block/vite.config.js

@@ -14,10 +14,11 @@ import { defineConfig } from 'vite'
 import path from 'path'
 import vue from '@vitejs/plugin-vue'
 import vueJsx from '@vitejs/plugin-vue-jsx'
+import generateComment from '@opentiny/vite-plugin-generate-comments'
 
 // https://vitejs.dev/config/
 export default defineConfig({
-  plugins: [vue(), vueJsx()],
+  plugins: [generateComment(), vue(), vueJsx()],
   publicDir: false,
   resolve: {},
   build: {

packages/plugins/bridge/index.js

@@ -1,21 +1,19 @@
 /**
-* Copyright (c) 2023 - present TinyEngine Authors.
-* Copyright (c) 2023 - present Huawei Cloud Computing Technologies Co., Ltd.
-*
-* Use of this source code is governed by an MIT-style license.
-*
-* THE OPEN SOURCE SOFTWARE IN THIS PRODUCT IS DISTRIBUTED IN THE HOPE THAT IT WILL BE USEFUL,
-* BUT WITHOUT ANY WARRANTY, WITHOUT EVEN THE IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR
-* A PARTICULAR PURPOSE. SEE THE APPLICABLE LICENSES FOR MORE DETAILS.
-*
-*/
+ * Copyright (c) 2023 - present TinyEngine Authors.
+ * Copyright (c) 2023 - present Huawei Cloud Computing Technologies Co., Ltd.
+ *
+ * Use of this source code is governed by an MIT-style license.
+ *
+ * THE OPEN SOURCE SOFTWARE IN THIS PRODUCT IS DISTRIBUTED IN THE HOPE THAT IT WILL BE USEFUL,
+ * BUT WITHOUT ANY WARRANTY, WITHOUT EVEN THE IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR
+ * A PARTICULAR PURPOSE. SEE THE APPLICABLE LICENSES FOR MORE DETAILS.
+ *
+ */
 
 import component from './src/Main.vue'
+import metaData from './meta.js'
 
 export default {
-  id: 'Bridge',
-  title: '资源管理',
-  icon: 'plugin-icon-sresources',
-  align: 'top',
+  ...metaData,
   component
 }

packages/plugins/bridge/meta.js

@@ -0,0 +1,7 @@
+export default {
+  id: 'engine.plugins.bridge',
+  title: '资源管理',
+  type: 'plugins',
+  align: 'top',
+  icon: 'plugin-icon-sresources'
+}

packages/plugins/bridge/package.json

@@ -27,9 +27,11 @@
     "@opentiny/tiny-engine-canvas": "workspace:*",
     "@opentiny/tiny-engine-common": "workspace:*",
     "@opentiny/tiny-engine-controller": "workspace:*",
+    "@opentiny/tiny-engine-entry": "workspace:*",
     "@opentiny/tiny-engine-http": "workspace:*"
   },
   "devDependencies": {
+    "@opentiny/vite-plugin-generate-comments": "workspace:*",
     "@vitejs/plugin-vue": "^4.2.3",
     "@vitejs/plugin-vue-jsx": "^3.1.0",
     "vite": "^4.3.7"

packages/plugins/bridge/vite.config.js

@@ -14,10 +14,11 @@ import { defineConfig } from 'vite'
 import path from 'path'
 import vue from '@vitejs/plugin-vue'
 import vueJsx from '@vitejs/plugin-vue-jsx'
+import generateComment from '@opentiny/vite-plugin-generate-comments'
 
 // https://vitejs.dev/config/
 export default defineConfig({
-  plugins: [vue(), vueJsx()],
+  plugins: [generateComment(), vue(), vueJsx()],
   publicDir: false,
   resolve: {},
   build: {

packages/plugins/data/index.js

@@ -1,21 +1,19 @@
 /**
-* Copyright (c) 2023 - present TinyEngine Authors.
-* Copyright (c) 2023 - present Huawei Cloud Computing Technologies Co., Ltd.
-*
-* Use of this source code is governed by an MIT-style license.
-*
-* THE OPEN SOURCE SOFTWARE IN THIS PRODUCT IS DISTRIBUTED IN THE HOPE THAT IT WILL BE USEFUL,
-* BUT WITHOUT ANY WARRANTY, WITHOUT EVEN THE IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR
-* A PARTICULAR PURPOSE. SEE THE APPLICABLE LICENSES FOR MORE DETAILS.
-*
-*/
+ * Copyright (c) 2023 - present TinyEngine Authors.
+ * Copyright (c) 2023 - present Huawei Cloud Computing Technologies Co., Ltd.
+ *
+ * Use of this source code is governed by an MIT-style license.
+ *
+ * THE OPEN SOURCE SOFTWARE IN THIS PRODUCT IS DISTRIBUTED IN THE HOPE THAT IT WILL BE USEFUL,
+ * BUT WITHOUT ANY WARRANTY, WITHOUT EVEN THE IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR
+ * A PARTICULAR PURPOSE. SEE THE APPLICABLE LICENSES FOR MORE DETAILS.
+ *
+ */
 
 import component from './src/Main.vue'
+import metaData from './meta.js'
 
 export default {
-  id: 'DataSource',
-  title: '状态管理',
-  icon: 'plugin-icon-var',
-  align: 'top',
+  ...metaData,
   component
 }

packages/plugins/data/meta.js

@@ -0,0 +1,7 @@
+export default {
+  id: 'engine.plugins.datasource',
+  title: '状态管理',
+  type: 'plugins',
+  align: 'top',
+  icon: 'plugin-icon-var'
+}

packages/plugins/data/package.json

@@ -27,11 +27,13 @@
     "@opentiny/tiny-engine-canvas": "workspace:*",
     "@opentiny/tiny-engine-common": "workspace:*",
     "@opentiny/tiny-engine-controller": "workspace:*",
+    "@opentiny/tiny-engine-entry": "workspace:*",
     "@opentiny/tiny-engine-http": "workspace:*",
     "@opentiny/tiny-engine-utils": "workspace:*",
     "monaco-editor": "0.33.0"
   },
   "devDependencies": {
+    "@opentiny/vite-plugin-generate-comments": "workspace:*",
     "@vitejs/plugin-vue": "^4.2.3",
     "@vitejs/plugin-vue-jsx": "^3.1.0",
     "vite": "^4.3.7"

packages/plugins/data/vite.config.js

@@ -14,10 +14,11 @@ import { defineConfig } from 'vite'
 import path from 'path'
 import vue from '@vitejs/plugin-vue'
 import vueJsx from '@vitejs/plugin-vue-jsx'
+import generateComment from '@opentiny/vite-plugin-generate-comments'
 
 // https://vitejs.dev/config/
 export default defineConfig({
-  plugins: [vue(), vueJsx()],
+  plugins: [generateComment(), vue(), vueJsx()],
   publicDir: false,
   resolve: {},
   build: {

packages/plugins/datasource/index.js

@@ -1,23 +1,21 @@
 /**
-* Copyright (c) 2023 - present TinyEngine Authors.
-* Copyright (c) 2023 - present Huawei Cloud Computing Technologies Co., Ltd.
-*
-* Use of this source code is governed by an MIT-style license.
-*
-* THE OPEN SOURCE SOFTWARE IN THIS PRODUCT IS DISTRIBUTED IN THE HOPE THAT IT WILL BE USEFUL,
-* BUT WITHOUT ANY WARRANTY, WITHOUT EVEN THE IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR
-* A PARTICULAR PURPOSE. SEE THE APPLICABLE LICENSES FOR MORE DETAILS.
-*
-*/
+ * Copyright (c) 2023 - present TinyEngine Authors.
+ * Copyright (c) 2023 - present Huawei Cloud Computing Technologies Co., Ltd.
+ *
+ * Use of this source code is governed by an MIT-style license.
+ *
+ * THE OPEN SOURCE SOFTWARE IN THIS PRODUCT IS DISTRIBUTED IN THE HOPE THAT IT WILL BE USEFUL,
+ * BUT WITHOUT ANY WARRANTY, WITHOUT EVEN THE IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR
+ * A PARTICULAR PURPOSE. SEE THE APPLICABLE LICENSES FOR MORE DETAILS.
+ *
+ */
 
 import { fetchDataSourceList, fetchDataSourceDetail } from './src/js/http'
 import component from './src/Main.vue'
+import metaData from './meta.js'
 
 export default {
-  id: 'Collections',
-  title: '数据源',
-  icon: 'plugin-icon-data',
-  align: 'top',
+  ...metaData,
   component
 }
 

packages/plugins/datasource/meta.js

@@ -0,0 +1,7 @@
+export default {
+  id: 'engine.plugins.collections',
+  title: '数据源',
+  type: 'plugins',
+  align: 'top',
+  icon: 'plugin-icon-data'
+}

packages/plugins/datasource/package.json

@@ -27,6 +27,7 @@
     "@opentiny/tiny-engine-canvas": "workspace:*",
     "@opentiny/tiny-engine-common": "workspace:*",
     "@opentiny/tiny-engine-controller": "workspace:*",
+    "@opentiny/tiny-engine-entry": "workspace:*",
     "@opentiny/tiny-engine-http": "workspace:*",
     "@opentiny/tiny-engine-utils": "workspace:*",
     "@vue/shared": "^3.3.4",
@@ -35,6 +36,7 @@
     "xlsx": "^0.18.5"
   },
   "devDependencies": {
+    "@opentiny/vite-plugin-generate-comments": "workspace:*",
     "@vitejs/plugin-vue": "^4.2.3",
     "@vitejs/plugin-vue-jsx": "^3.1.0",
     "vite": "^4.3.7"

packages/plugins/datasource/vite.config.js

@@ -14,10 +14,11 @@ import { defineConfig } from 'vite'
 import path from 'path'
 import vue from '@vitejs/plugin-vue'
 import vueJsx from '@vitejs/plugin-vue-jsx'
+import generateComment from '@opentiny/vite-plugin-generate-comments'
 
 // https://vitejs.dev/config/
 export default defineConfig({
-  plugins: [vue(), vueJsx()],
+  plugins: [generateComment(), vue(), vueJsx()],
   publicDir: false,
   resolve: {},
   build: {

packages/plugins/help/index.js

@@ -10,11 +10,8 @@
  *
  */
 
-import HelpIcon from './src/HelpIcon.vue'
+import metaData from './meta.js'
 
 export default {
-  id: 'EditorHelp',
-  title: '',
-  icon: HelpIcon,
-  align: 'bottom'
+  ...metaData
 }

packages/plugins/help/meta.js

@@ -0,0 +1,9 @@
+import HelpIcon from './src/HelpIcon.vue'
+
+export default {
+  id: 'engine.plugins.editorhelp',
+  title: '',
+  type: 'plugins',
+  icon: HelpIcon,
+  align: 'bottom'
+}

packages/plugins/help/package.json

@@ -26,9 +26,11 @@
   "dependencies": {
     "@opentiny/tiny-engine-common": "workspace:*",
     "@opentiny/tiny-engine-controller": "workspace:*",
+    "@opentiny/tiny-engine-entry": "workspace:*",
     "@opentiny/tiny-engine-http": "workspace:*"
   },
   "devDependencies": {
+    "@opentiny/vite-plugin-generate-comments": "workspace:*",
     "@vitejs/plugin-vue": "^4.2.3",
     "@vitejs/plugin-vue-jsx": "^3.1.0",
     "vite": "^4.3.7"