feat: 更新插件结构

Author: YingFeng256

.github/workflows/deploy.yml

@@ -64,7 +64,17 @@ jobs:
       - name: Build Project
         run: yarn build
 
-      # 11. 上传至 Aliyun OSS
+      # 11. 读取 package.json 中的 Plugin ID 及 Version
+      - name: Extract Plugin ID and Version
+        run: |
+          PLUGIN_ID=$(jq -r '.plugin.id' package.json)
+          VERSION=$(jq -r '.version' package.json)
+          echo "PLUGIN_ID=$PLUGIN_ID" >> $GITHUB_ENV
+          echo "::notice::Plugin ID is $PLUGIN_ID"
+          echo "VERSION=$VERSION" >> $GITHUB_ENV
+          echo "::notice::Version is $VERSION"
+
+      # 12. 上传至 Aliyun OSS
       - name: Upload to Aliyun OSS
         env:
           OSS_ACCESS_KEY_ID: ${{ secrets.OSS_ACCESS_KEY_ID }}
@@ -73,4 +83,8 @@ jobs:
           OSS_REGION: ${{ secrets.OSS_REGION }}
           OSS_BUCKET: ${{ secrets.OSS_BUCKET }}
         run: |
-          ossutil cp -r ./dist/ oss://${OSS_BUCKET}/oflow/plugins/template-drawer/ --force
+          echo "::notice::Uploading to oss://${OSS_BUCKET}/oflow/plugins/${PLUGIN_ID}/v${VERSION}/"
+          ossutil cp -r ./dist/ oss://${OSS_BUCKET}/oflow/plugins/${PLUGIN_ID}/v${VERSION}/ --force
+          echo ""
+          echo "::notice::Uploading to oss://${OSS_BUCKET}/oflow/plugins/${PLUGIN_ID}/latest/"
+          ossutil cp -r ./dist/ oss://${OSS_BUCKET}/oflow/plugins/${PLUGIN_ID}/latest/ --force

package.json

@@ -2,6 +2,15 @@
   "name": "ofp-template-drawer",
   "version": "1.0.0",
   "description": "",
+  "plugin": {
+    "id": "",
+    "type": "DRAWER",
+    "theme": "BLUE",
+    "port": {
+      "dev": 8080,
+      "debug": 8081
+    }
+  },
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {

scripts/commit.js

@@ -5,8 +5,10 @@ const { execSync } = require('child_process')
 const path = require('path')
 const fs = require('fs')
 
+const packageJson = require('../package.json');
+
 const PROJECT_PATH = path.resolve(__dirname, '../')
-const ACTIONS_URL = 'https://github.com/O-FLOW/ofp-template-drawer/actions'
+const ACTIONS_URL = 'https://github.com/O-FLOW/' + packageJson.name + '/actions'
 
 function checkPackageJson(projectPath) {
   if (!fs.existsSync(path.join(projectPath, 'package.json'))) {

src/api.ts

@@ -46,6 +46,8 @@ import {
   RsModelServiceApi,
   RsEnvironmentServiceApi,
   UseBase,
+  EasyPropertyAnimationApi,
+  RsServiceApi,
 } from "oflow-interface";
 import type { FunctionComponent } from "react";
 
@@ -78,12 +80,16 @@ export let lightAnimation: LightAnimationApi
 export let shadowAnimation: ShadowAnimationApi
 export let skyboxAnimation: SkyboxAnimationApi
 
+export let easyPropertyAnimation: EasyPropertyAnimationApi
+
 export let rsSelectionService: RsSelectionServiceApi
 
 export let rsNodeService: RsNodeServiceApi
 export let rsModelService: RsModelServiceApi
 export let rsEnvironmentService: RsEnvironmentServiceApi
 
+export let rsService: RsServiceApi
+
 export let syncService: SyncServiceApi
 export let historyService: HistoryServiceApi
 
@@ -177,12 +183,16 @@ export function loadApi() {
   shadowAnimation = api.services.engine.animation.shadowAnimation
   skyboxAnimation = api.services.engine.animation.skyboxAnimation
 
+  easyPropertyAnimation = api.services.engine.animation.easyPropertyAnimation
+
   rsSelectionService = api.services.engine.operate.rsSelectionService
 
   rsNodeService = api.services.engine.render.rsNodeService
   rsModelService = api.services.engine.render.rsModelService
   rsEnvironmentService = api.services.engine.render.rsEnvironmentService
 
+  rsService = api.services.engine.rsService
+
   syncService = api.services.sync.syncService
   historyService = api.services.sync.historyService
   rvGlobalService = api.services.sync.rvGlobalService

src/plugin.tsx

@@ -1,45 +1,30 @@
+import packageJson from '../package.json'
 import {IconPluginPosition, PluginType, ThemeColor} from 'oflow-interface'
 import {DrawerPlugin} from "oflow-interface";
 import {loadApi} from "./api";
 import React from 'react';
 import Drawer from "./drawer/drawer";
-import {proxy} from "valtio";
 
 
 export default class Plugin implements DrawerPlugin {
 
-  id: string = ''
-  name: string = ''
-  version: string = '0.0.1'
-  description = ''
+  id: string = packageJson.plugin.id
+  name: string = packageJson.name
+  version: string = packageJson.version
+  description = packageJson.description
 
-  type: PluginType = PluginType.DRAWER
-  theme: ThemeColor = ThemeColor.BLUE
+  type: PluginType = packageJson.plugin.type as PluginType
+  theme: ThemeColor = packageJson.plugin.theme as ThemeColor
 
-  data = proxy({
-
-  })
-
-  async onInstall() {
-    loadApi()
-  }
-  async onEnable() {
-
-  }
-  async onDisable() {
-
-  }
-  async onUninstall() {
-
-  }
+  loadApi = loadApi
 
   weight = 50
   title = ''
   tip = ''
   position = IconPluginPosition.TOP_LEFT
   group = ''
   label = ''
-  color = ThemeColor.BLUE
+  color = packageJson.plugin.theme as ThemeColor
   open = false
 
   icon = () => {

webpack.config.js

@@ -2,13 +2,15 @@ const path = require('path')
 const webpack = require('webpack')
 const WebSocket = require('ws')
 
+const packageJson = require('./package.json');
+
 class CompilationNotifierPlugin {
   apply(compiler) {
     let wss
 
     compiler.hooks.compile.tap('CompilationNotifierPlugin', () => {
       if (wss) return;
-      wss = new WebSocket.Server({ port: 8081 })
+      wss = new WebSocket.Server({ port: packageJson.plugin.port.debug })
       console.log('\nCompilation NotifierPlugin Websocket Started.\n')
     })
 
@@ -96,7 +98,7 @@ module.exports = {
     static: {
       directory: path.join(__dirname, 'dist'),
     },
-    port: 8080,
+    port: packageJson.plugin.port.dev,
     hot: false,
     watchFiles: ['src/**/*'],
     liveReload: false,