@ddm-center/create-plugin 0.0.1 → 0.0.2

package/README.md

@@ -4,13 +4,13 @@
 
 它只创建一种推荐工程形态：`renderer + main` mixed 插件。单独 renderer 或单独 main 的插件可以在生成后自行删除不需要的入口。
 
-## 创建 TypeScript 插件
+## 创建 JavaScript 插件
 
 ```bash
-npm create @ddm-center/plugin my-plugin -- --ts
+npm create @ddm-center/plugin my-plugin
 ```
 
-## 创建 JavaScript 插件
+也可以显式指定 JavaScript：
 
 ```bash
 npm create @ddm-center/plugin my-plugin -- --js
@@ -20,21 +20,6 @@ npm create @ddm-center/plugin my-plugin -- --js
 
 ## 生成目录
 
-TypeScript 模板会生成：
-
-```text
-ddm-plugin-my-plugin/
-    src/main/index.ts
-    src/renderer/index.ts
-    src/renderer/views/Settings.vue
-    src/i18n/index.ts
-    package.json
-    tsconfig.json
-    webpack.config.js
-```
-
-JavaScript 模板会生成：
-
 ```text
 ddm-plugin-my-plugin/
     src/main/index.js
@@ -53,12 +38,6 @@ npm install
 npm run build
 ```
 
-TypeScript 模板额外提供：
-
-```bash
-npm run typecheck
-```
-
 ## 入口约定
 
 生成的插件包含三个入口：
@@ -93,8 +72,8 @@ npm run typecheck
 
 ## 参数
 
-- `--ts`：创建 TypeScript mixed 插件。
 - `--js`：创建 JavaScript mixed 插件。
-- `--language=ts`：等同于 `--ts`。
 - `--language=js`：等同于 `--js`。
 - `--force`：目标目录不为空时仍然写入。
+
+当前脚手架暂不支持创建 TypeScript 工程。

package/bin/create-plugin.js

@@ -46,7 +46,7 @@ function parseArgs(argv) {
 }
 
 /**
- * 没有传插件名或语言时，用交互问题补齐。
+ * 没有传插件名时，用交互问题补齐。
  */
 function ask(question) {
     const rl = readline.createInterface({
@@ -112,14 +112,13 @@ async function main() {
     const args = parseArgs(process.argv.slice(2));
     const inputName = args.name || await ask('插件名称: ');
     const pluginName = normalizePluginName(inputName);
-    const languageInput = args.language || await ask('语言(js/ts，默认 ts): ');
-    const language = (languageInput || 'ts').toLowerCase();
+    const language = (args.language || 'js').toLowerCase();
 
-    if (!['js', 'ts', 'javascript', 'typescript'].includes(language)) {
-        throw new Error('language 只支持 js 或 ts');
+    if (!['js', 'javascript'].includes(language)) {
+        throw new Error('当前脚手架只支持创建 JavaScript 插件工程，暂不支持 TypeScript 模板');
     }
 
-    const templateName = language.startsWith('j') ? 'mixed-js' : 'mixed-ts';
+    const templateName = 'mixed-js';
     const targetDir = path.resolve(process.cwd(), pluginName.includes('/') ? pluginName.split('/').pop() : pluginName);
 
     if (fs.existsSync(targetDir) && !args.force && fs.readdirSync(targetDir).length > 0) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ddm-center/create-plugin",
-    "version": "0.0.1",
+    "version": "0.0.2",
     "description": "Create a mixed renderer and main plugin project for Dubbo Desktop Manager.",
     "bin": {
         "create-plugin": "bin/create-plugin.js"

package/templates/mixed-js/package.json.tpl

@@ -21,6 +21,9 @@
         "webpack": "^5.92.0",
         "webpack-cli": "^5.1.4"
     },
+    "engines": {
+        "ddm": ">=1.1.0 <3.0.0"
+    },
     "pluginSandbox": {
         "permissions": {
             "require": {

package/templates/mixed-js/src/i18n/index.js.tpl

@@ -5,7 +5,7 @@ export default function installI18n(registrar) {
     return {
         async install() {
             registrar.addPluginLocaleMessage('zh-CN', {
-                title: '__PLUGIN_TITLE__',
+                title: '中文语言包: __PLUGIN_TITLE__',
             });
             registrar.addPluginLocaleMessage('en-US', {
                 title: '__PLUGIN_TITLE__',

package/templates/mixed-js/src/renderer/index.js.tpl

@@ -25,7 +25,7 @@ export default function installRenderer() {
              */
             appView.addToolbarMenu({
                 label: '__PLUGIN_TITLE__',
-                icon: 'plugin',
+                icon: 'el-icon-watermelon',
                 click: async () => {
                     const result = await helloService.sayHello('__PLUGIN_TITLE__');
                     appView.notify({

package/templates/mixed-js/src/renderer/views/Settings.vue.tpl

@@ -2,6 +2,7 @@
     <div class="ddm-plugin-settings">
         <h3>{{ title }}</h3>
         <p>{{ message }}</p>
+        <p>{{ $pluginT('title') }}</p>
         <el-button size="mini" type="primary" @click="loadMessage">调用主进程服务</el-button>
     </div>
 </template>

package/templates/mixed-ts/README.md.tpl

@@ -1,11 +0,0 @@
-# __PLUGIN_TITLE__
-
-DDM mixed plugin template.
-
-```bash
-npm install
-npm run typecheck
-npm run build
-```
-
-构建后把当前目录作为插件包安装到 DDM，宿主会读取 `dist/main.js`、`dist/renderer.js` 和 `dist/i18n.js`。

package/templates/mixed-ts/package.json.tpl

@@ -1,34 +0,0 @@
-{
-    "name": "__PLUGIN_NAME__",
-    "version": "0.1.0",
-    "description": "__PLUGIN_TITLE__ plugin for Dubbo Desktop Manager.",
-    "pluginNickName": "__PLUGIN_TITLE__",
-    "main": "dist/main.js",
-    "rendererMain": "dist/renderer.js",
-    "i18nMain": "dist/i18n.js",
-    "scripts": {
-        "build": "webpack --mode production",
-        "dev": "webpack --mode development --watch",
-        "typecheck": "tsc --noEmit"
-    },
-    "dependencies": {},
-    "devDependencies": {
-        "@ddm-center/plugin-api": "^0.0.1",
-        "css-loader": "^6.11.0",
-        "ts-loader": "^9.5.1",
-        "typescript": "^5.4.5",
-        "vue": "^2.6.14",
-        "vue-loader": "^15.11.1",
-        "vue-style-loader": "^4.1.3",
-        "vue-template-compiler": "^2.6.14",
-        "webpack": "^5.92.0",
-        "webpack-cli": "^5.1.4"
-    },
-    "pluginSandbox": {
-        "permissions": {
-            "require": {
-                "allow": []
-            }
-        }
-    }
-}

package/templates/mixed-ts/src/i18n/index.ts.tpl

@@ -1,19 +0,0 @@
-import type { I18nRegistrar, PluginInstallable } from '@ddm-center/plugin-api';
-
-/**
- * i18n 入口用于注册当前插件自己的语言包。
- */
-function installI18n(registrar: I18nRegistrar): PluginInstallable {
-    return {
-        async install() {
-            registrar.addPluginLocaleMessage('zh-CN', {
-                title: '__PLUGIN_TITLE__',
-            });
-            registrar.addPluginLocaleMessage('en-US', {
-                title: '__PLUGIN_TITLE__',
-            });
-        },
-    };
-}
-
-export default installI18n;

package/templates/mixed-ts/src/main/index.ts.tpl

@@ -1,39 +0,0 @@
-import appMain            from 'appMain';
-import type { MainEntry } from '@ddm-center/plugin-api';
-
-interface HelloResult {
-    message: string;
-    time: string;
-}
-
-/**
- * 主进程入口由 DDM 宿主加载。
- */
-const entry: MainEntry = () => {
-    return {
-        async install() {
-            appMain.logger.info('__PLUGIN_TITLE__ main installed');
-
-            /**
-             * 暴露给渲染进程调用的服务，渲染端通过 referenceService('helloService') 获取。
-             */
-            appMain.exportPluginService('helloService', {
-                async sayHello(name?: string): Promise<HelloResult> {
-                    return {
-                        message: `Hello ${name || 'DDM'} from ${appMain.pluginName}`,
-                        time: new Date().toISOString(),
-                    };
-                },
-            });
-        },
-
-        /**
-         * 插件卸载时宿主会优先调用 uninstall，可在这里释放资源。
-         */
-        async uninstall() {
-            appMain.logger.info('__PLUGIN_TITLE__ main uninstalled');
-        },
-    };
-};
-
-export default entry;

package/templates/mixed-ts/src/renderer/index.ts.tpl

@@ -1,49 +0,0 @@
-import appView                from 'appView';
-import type { RendererEntry } from '@ddm-center/plugin-api';
-import Settings               from './views/Settings.vue';
-
-interface HelloService {
-    sayHello(name?: string): Promise<{
-        message: string;
-        time: string;
-    }>;
-}
-
-/**
- * 渲染进程入口由 DDM 宿主加载。
- */
-const entry: RendererEntry = () => {
-    return {
-        async install() {
-            /**
-             * 调用主进程通过 exportPluginService 暴露的服务。
-             */
-            const helloService = appView.referenceService<HelloService>('helloService');
-
-            /**
-             * 注册一个插件设置页，Settings 组件会被宿主自动注入插件上下文。
-             */
-            appView.addPluginSettingPage({
-                label: '__PLUGIN_TITLE__',
-                component: Settings,
-            });
-
-            /**
-             * 注册标题栏菜单，演示渲染进程调用主进程服务后发通知。
-             */
-            appView.addToolbarMenu({
-                label: '__PLUGIN_TITLE__',
-                icon: 'plugin',
-                click: async () => {
-                    const result = await helloService.sayHello('__PLUGIN_TITLE__');
-                    appView.notify({
-                        title: '__PLUGIN_TITLE__',
-                        body: result.message,
-                    });
-                },
-            });
-        },
-    };
-};
-
-export default entry;

package/templates/mixed-ts/src/renderer/views/Settings.vue.tpl

@@ -1,43 +0,0 @@
-<template>
-    <div class="ddm-plugin-settings">
-        <h3>{{ title }}</h3>
-        <p>{{ message }}</p>
-        <el-button size="mini" type="primary" @click="loadMessage">调用主进程服务</el-button>
-    </div>
-</template>
-
-<script lang="ts">
-import Vue from 'vue';
-import appView from 'appView';
-
-interface HelloService {
-    sayHello(name?: string): Promise<{
-        message: string;
-        time: string;
-    }>;
-}
-
-const helloService = appView.referenceService<HelloService>('helloService');
-
-export default Vue.extend({
-    name: 'PluginSettings',
-    data() {
-        return {
-            title: '__PLUGIN_TITLE__',
-            message: 'Ready',
-        };
-    },
-    methods: {
-        async loadMessage() {
-            const result = await helloService.sayHello(this.title);
-            this.message = result.message;
-        },
-    },
-});
-</script>
-
-<style scoped>
-.ddm-plugin-settings {
-    padding: 12px;
-}
-</style>

package/templates/mixed-ts/src/types/vue.d.ts.tpl

@@ -1,4 +0,0 @@
-declare module '*.vue' {
-    import Vue from 'vue';
-    export default Vue;
-}

package/templates/mixed-ts/tsconfig.json.tpl

@@ -1,17 +0,0 @@
-{
-    "compilerOptions": {
-        "target": "ES2019",
-        "module": "commonjs",
-        "strict": true,
-        "esModuleInterop": true,
-        "skipLibCheck": true,
-        "moduleResolution": "node",
-        "baseUrl": ".",
-        "paths": {
-            "appMain": ["node_modules/@ddm-center/plugin-api/appMain.d.ts"],
-            "appView": ["node_modules/@ddm-center/plugin-api/appView.d.ts"]
-        },
-        "types": ["@ddm-center/plugin-api"]
-    },
-    "include": ["src/**/*"]
-}

package/templates/mixed-ts/webpack.config.js.tpl

@@ -1,56 +0,0 @@
-const path                     = require('path');
-const { VueLoaderPlugin }      = require('vue-loader');
-
-module.exports = {
-    target: 'electron-renderer',
-    entry: {
-        main: './src/main/index.ts',
-        renderer: './src/renderer/index.ts',
-        i18n: './src/i18n/index.ts',
-    },
-    output: {
-        path: path.resolve(__dirname, 'dist'),
-        filename: '[name].js',
-        library: {
-            type: 'commonjs2',
-            export: 'default',
-        },
-    },
-    resolve: {
-        extensions: ['.ts', '.js', '.vue', '.json'],
-        alias: {
-            '@': path.resolve(__dirname, 'src'),
-        },
-    },
-    externals: {
-        appMain: 'commonjs appMain',
-        appView: 'commonjs appView',
-        axios: 'commonjs axios',
-        constant: 'commonjs constant',
-        logger: 'commonjs logger',
-        appConfig: 'commonjs appConfig',
-    },
-    module: {
-        rules: [
-            {
-                test: /\.vue$/,
-                loader: 'vue-loader',
-            },
-            {
-                test: /\.ts$/,
-                loader: 'ts-loader',
-                options: {
-                    appendTsSuffixTo: [/\.vue$/],
-                },
-                exclude: /node_modules/,
-            },
-            {
-                test: /\.css$/,
-                use: ['vue-style-loader', 'css-loader'],
-            },
-        ],
-    },
-    plugins: [
-        new VueLoaderPlugin(),
-    ],
-};