add plugin-cli

plugin-cli/.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+dist/

plugin-cli/.npmignore

@@ -0,0 +1,3 @@
+node_modules/
+src/
+tsconfig.json

plugin-cli/README.md

@@ -0,0 +1,27 @@
+### COOL-ADMIN
+
+cool-admin一个很酷的后台权限管理系统，开源免费，模块化、插件化、极速开发CRUD，方便快速构建迭代后台管理系统
+
+大数据、微服务、AI编码快速开发！！！
+
+
+### 技术栈
+
+- 后端：node.js midway.js koa.js mysql typescript
+- 前端：vue.js element-plus jsx pinia vue-router
+
+### 官网
+
+[https://cool-js.com](https://cool-js.com)
+
+
+### 演示地址
+
+[https://show.cool-admin.com](https://show.cool-admin.com)
+
+- 账户：admin
+- 密码：123456
+
+### 项目地址
+
+[https://github.com/cool-team-official/cool-admin-midway](https://github.com/cool-team-official/cool-admin-midway)

plugin-cli/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@cool-midway/plugin-cli",
+  "version": "8.0.0",
+  "description": "cool-admin midway plugin",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc"
+  },
+  "keywords": [
+    "cool",
+    "cool-admin",
+    "cooljs"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://cool-js.com"
+  },
+  "bin": {
+    "cool-plugin-cli": "scripts/index.js"
+  },
+  "author": "COOL",
+  "readme": "README.md",
+  "license": "MIT",
+  "dependencies": {
+    "@cool-midway/cache-manager-fs-hash": "^7.0.0",
+    "@midwayjs/cache-manager": "^3.20.3",
+    "@midwayjs/core": "^3.20.3",
+    "archiver": "^7.0.1",
+    "esbuild": "^0.25.0",
+    "esbuild-plugin-copy": "^2.1.1"
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.9",
+    "typescript": "^5.8.2"
+  }
+}

plugin-cli/scripts/build.js

@@ -0,0 +1,47 @@
+console.log("cool-plugin-cli run build");
+
+const esbuild = require('esbuild');
+const copyPlugin = require('esbuild-plugin-copy').default;
+const packageJson = require('../package.json');
+const path = require('path');
+const fs = require('fs');
+
+const projectRoot = process.cwd();
+
+// 输出目录
+const outdir = path.join(projectRoot, 'dist');
+
+// 删除 dist 目录
+if (fs.existsSync(outdir)) {
+  fs.rmdirSync(outdir, { recursive: true });
+}
+
+// 构建
+module.exports.result = esbuild.build({
+  entryPoints: [path.join(projectRoot, 'src', 'index.ts'), path.join(projectRoot, 'test', 'index.ts')],
+  external: Object.keys(packageJson.devDependencies),
+  bundle: true,
+  platform: 'node',
+  outdir,
+  plugins: [
+    copyPlugin({
+      assets: [{
+        from: ['./README.md'],
+        to: ['./README.md']
+      },{
+        from: ['./package.json'],
+        to: ['./package.json']
+      },{
+        from: ['./plugin.json'],
+        to: ['./plugin.json']
+      },{
+        from: ['./assets/*'],
+        to: ['./assets']
+      },{
+        from: ['./src/*'],
+        to: ['./source']
+      }]
+    })
+  ]
+}).catch(() => process.exit(1));
+

plugin-cli/scripts/index.js

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+const args = process.argv.slice(2); // 去掉数组的前两个元素
+
+// 发布
+if(args.includes('--release')){
+    require('./release.js');
+}
+
+// 打包
+if(args.includes('--build')){
+    require('./build.js');
+}

plugin-cli/scripts/release.js

@@ -0,0 +1,48 @@
+console.log("cool-plugin-cli run release");
+
+const projectRoot = process.cwd();
+
+const fs = require('fs');
+const path = require('path');
+const archiver = require('archiver');
+const pluginJson = require(path.join(projectRoot, 'plugin.json'));
+
+const packFolder = (folderPath, outputPath) => {
+    fs.mkdirSync(path.dirname(outputPath), { recursive: true });
+    // 创建文件写入流
+    const output = fs.createWriteStream(outputPath);
+    const archive = archiver('zip', {
+        zlib: { level: 9 } // 设置压缩级别
+    });
+
+    // 监听关闭事件
+    output.on('close', function() {
+        console.log(`cool plugin package successfully. Total size: ${archive.pointer()} bytes`);
+    });
+
+    // 监听错误事件
+    archive.on('error', function(err) {
+        throw err;
+    });
+
+    // 将压缩内容流连接到文件写入流
+    archive.pipe(output);
+
+    // 添加文件夹
+    archive.directory(folderPath, false);
+
+    // 完成归档
+    archive.finalize();
+}
+
+// 打包
+const folderPath = path.join(projectRoot, 'dist'); // 替换为你的文件夹路径
+const outputPath = path.join(projectRoot, 'release', `${pluginJson.name}_v${pluginJson.version}.cool`); // 替换为你希望创建的 .cool 文件路径
+
+const { result } = require('./build.js');
+
+result.then(()=>{
+    packFolder(folderPath, outputPath);
+})
+
+

plugin-cli/src/cache/store.ts

@@ -0,0 +1,64 @@
+import * as FsStore from "@cool-midway/cache-manager-fs-hash";
+
+/**
+ * cool 基于磁盘的缓存
+ */
+export class FsCacheStore {
+  options: any;
+
+  store: FsStore;
+
+  constructor(options = {}) {
+    options = {
+      ...options,
+      path: "cache",
+      ttl: -1,
+    };
+    this.options = options;
+    this.store = FsStore.create(options);
+  }
+
+  /**
+   * 获得
+   * @param key
+   * @returns
+   */
+  async get<T>(key: string): Promise<T> {
+    return await this.store.get(key);
+  }
+
+  /**
+   * 设置
+   * @param key
+   * @param value
+   * @param ttl
+   */
+  async set<T>(key: string, value: T, ttl?: number): Promise<void> {
+    let t = ttl ? ttl : this.options.ttl;
+    if (t > 0) {
+      t = t / 1000;
+    }
+    await this.store.set(key, value, {
+      ttl: t,
+    });
+  }
+
+  /**
+   * 删除
+   * @param key
+   */
+  async del(key: string): Promise<void> {
+    await this.store.del(key);
+  }
+
+  /**
+   * 重置
+   */
+  async reset(): Promise<void> {
+    await this.store.reset();
+  }
+}
+
+export const CoolCacheStore = function (options = {}) {
+  return new FsCacheStore(options);
+};

plugin-cli/src/constant/global.ts

@@ -0,0 +1,84 @@
+/**
+ * 返回码
+ */
+export enum RESCODE {
+  // 成功
+  SUCCESS = 1000,
+  // 失败
+  COMMFAIL = 1001,
+  // 参数验证失败
+  VALIDATEFAIL = 1002,
+  // 参数验证失败
+  COREFAIL = 1003,
+}
+
+/**
+ * 返回信息
+ */
+export enum RESMESSAGE {
+  // 成功
+  SUCCESS = "success",
+  // 失败
+  COMMFAIL = "comm fail",
+  // 参数验证失败
+  VALIDATEFAIL = "validate fail",
+  // 核心异常
+  COREFAIL = "core fail",
+}
+
+/**
+ * 错误提示
+ */
+export enum ERRINFO {
+  NOENTITY = "未设置操作实体",
+  NOID = "查询参数[id]不存在",
+  SORTFIELD = "排序参数不正确",
+}
+
+/**
+ * 事件
+ */
+export enum EVENT {
+  // 软删除
+  SOFT_DELETE = "onSoftDelete",
+  // 服务成功启动
+  SERVER_READY = "onServerReady",
+  // 服务就绪
+  READY = "onReady",
+  // ES 数据改变
+  ES_DATA_CHANGE = "esDataChange",
+}
+
+
+export class GlobalConfig {
+  private static instance: GlobalConfig;
+
+  RESCODE = {
+    SUCCESS: 1000,
+    COMMFAIL: 1001,
+    VALIDATEFAIL: 1002,
+    COREFAIL: 1003,
+  };
+
+  RESMESSAGE = {
+    SUCCESS: "success",
+    COMMFAIL: "comm fail",
+    VALIDATEFAIL: "validate fail",
+    COREFAIL: "core fail",
+  };
+
+  // ... 其他的配置 ...
+
+  private constructor() {}
+
+  static getInstance(): GlobalConfig {
+    if (!GlobalConfig.instance) {
+      GlobalConfig.instance = new GlobalConfig();
+    }
+    return GlobalConfig.instance;
+  }
+}
+
+
+
+

plugin-cli/src/exception/base.ts

@@ -0,0 +1,13 @@
+/**
+ * 异常基类
+ */
+export class BaseException extends Error {
+  status: number;
+
+  constructor(name: string, code: number, message: string) {
+    super(message);
+
+    this.name = name;
+    this.status = code;
+  }
+}

plugin-cli/src/exception/comm.ts

@@ -0,0 +1,16 @@
+import { GlobalConfig } from '../constant/global';
+import { BaseException } from './base';
+
+/**
+ * 通用异常
+ */
+export class CoolCommException extends BaseException {
+  constructor(message: string) {
+    const { RESCODE, RESMESSAGE } = GlobalConfig.getInstance();
+    super(
+      'CoolCommException',
+      RESCODE.COMMFAIL,
+      message ? message : RESMESSAGE.COMMFAIL
+    );
+  }
+}

plugin-cli/src/exception/core.ts

@@ -0,0 +1,16 @@
+import { GlobalConfig } from '../constant/global';
+import { BaseException } from './base';
+
+/**
+ * 核心异常
+ */
+export class CoolCoreException extends BaseException {
+  constructor(message: string) {
+    const { RESCODE, RESMESSAGE } = GlobalConfig.getInstance();
+    super(
+      'CoolCoreException',
+      RESCODE.COREFAIL,
+      message ? message : RESMESSAGE.COREFAIL
+    );
+  }
+}

plugin-cli/src/exception/validate.ts

@@ -0,0 +1,16 @@
+import { GlobalConfig } from "../constant/global";
+import { BaseException } from "./base";
+
+/**
+ * 校验异常
+ */
+export class CoolValidateException extends BaseException {
+  constructor(message: string) {
+    const { RESCODE, RESMESSAGE } = GlobalConfig.getInstance();
+    super(
+      "CoolValidateException",
+      RESCODE.VALIDATEFAIL,
+      message ? message : RESMESSAGE.VALIDATEFAIL
+    );
+  }
+}

plugin-cli/src/hook/upload.ts

@@ -0,0 +1,67 @@
+// 模式
+export enum MODETYPE {
+  // 本地
+  LOCAL = "local",
+  // 云存储
+  CLOUD = "cloud",
+  // 其他
+  OTHER = "other",
+}
+
+export enum CLOUDTYPE {
+  // 阿里云存储
+  OSS = "oss",
+  // 腾讯云存储
+  COS = "cos",
+  // 七牛云存储
+  QINIU = "qiniu",
+  /** AWS S3 */
+  AWS = "aws",
+}
+
+/**
+ * 上传模式
+ */
+export interface Mode {
+  // 模式
+  mode: MODETYPE;
+  // 类型
+  type: string;
+}
+
+/**
+ * 文件上传
+ */
+export interface BaseUpload {
+  /**
+   * 获得上传模式
+   */
+  getMode(): Promise<Mode>;
+
+  /**
+   * 获得原始操作对象
+   * @returns
+   */
+  getMetaFileObj();
+
+  /**
+   * 下载并上传
+   * @param url
+   * @param fileName 文件名
+   */
+  downAndUpload(url: string, fileName?: string): Promise<string>;
+
+  /**
+   * 指定Key(路径)上传，本地文件上传到存储服务
+   * @param filePath 文件路径
+   * @param key 路径一致会覆盖源文件
+   */
+  uploadWithKey(filePath, key): Promise<string>;
+
+  /**
+   * 上传文件
+   * @param ctx
+   * @param key 文件路径
+   */
+  upload(ctx): Promise<any>;
+}

plugin-cli/src/index.ts

@@ -0,0 +1,158 @@
+import { MidwayCache } from "@midwayjs/cache-manager";
+import { IMidwayContext, IMidwayApplication } from "@midwayjs/core";
+import { CoolCacheStore, FsCacheStore } from "./cache/store";
+
+// 文件上传
+export * from "./hook/upload";
+
+// 异常处理
+export * from "./exception/base";
+export * from "./exception/comm";
+export * from "./exception/core";
+export * from "./exception/validate";
+
+// 全局参数
+export * from "./constant/global";
+
+/**
+ * 插件信息
+ */
+export interface PluginInfo {
+  /** 名称 */
+  name: string;
+  /** 唯一标识 */
+  key: string;
+  /** 钩子 */
+  hook: string;
+  /** 版本 */
+  version: string;
+  /** 描述 */
+  description: string;
+  /** 作者 */
+  author: string;
+  /** logo */
+  logo: string;
+  /** README 使用说明 */
+  readme: string;
+  /** 配置 */
+  config: any;
+}
+
+/**
+ * 插件基类，不建议修改
+ */
+export abstract class BasePlugin {
+  /** 插件信息 */
+  pluginInfo: PluginInfo;
+  /** 请求上下文，用到此项无法本地调试，需安装到cool-admin中才能调试 */
+  ctx: IMidwayContext;
+  /** 应用实例，用到此项无法本地调试，需安装到cool-admin中才能调试 */
+  app: IMidwayApplication;
+  /** 缓存 */
+  cache: FsCacheStore | MidwayCache;
+  /** 插件 */
+  pluginService: PluginService;
+  /** 基础目录位置 */
+  baseDir: string;
+
+  setCtx(ctx: IMidwayContext) {
+    this.ctx = ctx;
+  }
+
+  setApp(app: IMidwayApplication) {
+    this.app = app;
+    this.baseDir = app.getBaseDir();
+    this.configDir();
+  }
+
+  constructor() {}
+
+  /**
+   * 获得App级别的实例
+   * @param name
+   * @returns
+   */
+  async getAppInstance(name: string) {
+    return await this.app.getApplicationContext().getAsync(name);
+  }
+
+  /**
+   * 获得请求级别的实例
+   * @param name
+   * @returns
+   */
+  async getCtxInstance(name: string) {
+    return await this.ctx.requestContext.getAsync(name);
+  }
+
+  /**
+   * 初始化插件
+   * @param pluginInfo
+   * @param ctx
+   * @param app
+   */
+  async init(
+    pluginInfo: PluginInfo,
+    ctx?: IMidwayContext,
+    app?: IMidwayApplication,
+    other?: any
+  ) {
+    this.pluginInfo = pluginInfo;
+    this.ctx = ctx;
+    this.app = app;
+    this.baseDir = process.cwd();
+    if (this.app) {
+      this.baseDir = this.app?.getBaseDir();
+    }
+    this.configDir();
+    this.cache = CoolCacheStore({});
+    if (other) {
+      this.cache = other.cache;
+      this.pluginService = other.pluginService;
+    }
+    await this.ready();
+  }
+
+  /**
+   * 处理配置目录
+   */
+  private configDir() {
+    // 替换\为/
+    this.baseDir = this.baseDir.replace(/\\/g, "/");
+    let config = this.pluginInfo.config || {};
+    config = JSON.stringify(config);
+    this.pluginInfo.config = JSON.parse(
+      config.replace(/@baseDir/g, this.baseDir)
+    );
+  }
+
+  /**
+   * 插件就绪
+   */
+  async ready() {}
+}
+
+/**
+ * 插件服务
+ */
+export declare class PluginService {
+  /**
+   * 调用插件
+   * @param key 插件key
+   * @param method 方法
+   * @param params 参数
+   * @returns
+   */
+  invoke(key: string, method: string, ...params: any[]): Promise<any>;
+  /**
+   * 获得插件实例
+   * @param key
+   * @returns
+   */
+  getInstance(key: string): Promise<any>;
+  /**
+   * 检查状态
+   * @param key
+   */
+  checkStatus(key: string): Promise<void>;
+}

plugin-cli/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "target": "ES2018",
+    "module": "CommonJS",
+    "esModuleInterop": true,
+    "moduleResolution": "Node",
+    "noImplicitAny": false,
+    "skipLibCheck": true,
+    "resolveJsonModule":true,
+    "outDir": "./dist"
+  },
+  "include": ["src/**/*", "scripts"],
+  "exclude": ["node_modules", "dist", "**/*.test.ts"]
+}