@widget-js/cli 1.1.8 → 1.1.11

package/src/utils.ts

@@ -1,26 +1,80 @@
 import path from "path";
 import process from "process";
 import fs from "fs";
+import packageJson from "package-json";
 
 export const widgetPackages: { [key: string]: string } = {
-    "@widget-js/core": "", "@widget-js/vue3": "", "@widget-js/cli": "", "@widget-js/vite-plugin-widget": ""
+  "@widget-js/core": "", "@widget-js/vue3": "", "@widget-js/cli": "", "@widget-js/vite-plugin-widget": ""
 };
 export default function exit(code: number = 0) {
-    if (exports.exitProcess) {
-        process.exit(code);
-    } else if (code > 0) {
-        throw new Error(`Process exited with code ${code}`);
-    }
+  if (exports.exitProcess) {
+    process.exit(code);
+  } else if (code > 0) {
+    throw new Error(`Process exited with code ${code}`);
+  }
 }
 
 export function getPackagePath() {
-    return path.join(process.cwd(), "package.json");
+  return path.join(process.cwd(), "package.json");
 }
 
-export function getPackageJson() {
-    return JSON.parse(fs.readFileSync(getPackagePath()).toString());
-}
 
-export function getPackageVersion() {
-    return getPackageJson()["version"];
+export class Utils {
+  static async getRemoteVersion(packageName: string): Promise<string> {
+    const metadata = await packageJson(packageName);
+    let version = metadata["version"];
+    return version as string;
+  }
+
+  static getPackagePath() {
+    return path.join(process.cwd(), "package.json");
+  }
+
+  static getPackageJson() {
+    return JSON.parse(fs.readFileSync(this.getPackagePath()).toString());
+  }
+
+ static getPackageVersion() {
+    return this.getPackageJson()["version"];
+  }
+
+  /**
+   * 检查包名是否合法，包名格式一般为 倒置域名与java包类似
+   * 1.只能包含小写字母、数字、下划线、小数点。
+   * 2.不能以小数点结尾
+   * 3.不能包含连续的小数点
+   * @param name
+   */
+  static checkPackageName(name: string):boolean {
+    // 检查包名是否以小数点结尾
+    if (name.endsWith('.')) {
+      return false;
+    }
+
+    // 检查包名是否包含无效字符
+    const invalidCharacters = /[\\/:*?\"<>| ]/g;
+    if (name.match(invalidCharacters)) {
+      return false;
+    }
+
+    // 检查包名是否至少包含一个子段
+    const segments = name.split('.');
+    if (segments.length < 2) {
+      return false;
+    }
+
+    // 检查每个子段是否以字母开头
+    for (const segment of segments) {
+      if (!segment.match(/^[a-z]/)) {
+        return false;
+      }
+
+      // 检查子段是否包含连续的小数点
+      if (segment.includes('.' + '.')) {
+        return false;
+      }
+    }
+
+    return true;
+  }
 }

package/template/WidgetDefine.ejs

@@ -8,9 +8,9 @@ const description = {"zh-CN": ""};
 //组件关键词
 const keywords = [WidgetKeyword.RECOMMEND];
 //组件路由地址
-const url = "/widget/<%= snakeCaseName %>";
+const path = "/widget/<%= snakeCaseName %>";
 //配置页路由地址
-const configUrl = <% if (configurable) { %>"/widget/config/<%= snakeCaseName %>"<% } else { %>undefined<% } %>;
+const configPagePath = <% if (configurable) { %>"/widget/config/<%= snakeCaseName %>"<% } else { %>undefined<% } %>;
 //组件关键词
 const <%= name %>WidgetDefine = new Widget({
 name: name,
@@ -24,17 +24,9 @@ minWidth: <%= minWidth %>,
 maxWidth: <%= maxWidth %>,
 minHeight: <%= minHeight %>,
 maxHeight: <%= maxHeight %>,
-routes: [
-{
-url: url,
-name: 'index'
-},
-<% if (configurable) { %> {
-url: configUrl,
-name: 'config'
-},
-<% } %>
-]
+previewImage: "修改为组件预览图地址",
+path,
+configPagePath
 })
 
 export default <%= name %>WidgetDefine;

package/template/WidgetPackage.ejs

@@ -0,0 +1,22 @@
+import {WidgetPackage} from '@widget-js/core';
+
+//TODO 完善组件包信息
+export default new WidgetPackage({
+  author: '修改成你的信息',
+  description: {
+    'zh-CN': '修改成你的组件描述',
+  },
+  entry: 'index.html',
+  hash: true,
+  homepage: '',
+  name: '<%= name  %>',
+  remoteEntry: '',
+  remotePackage: '',
+  title: {
+    'zh-CN': '修改成你的组件标题',
+  },
+  version: '1.0.0',
+  devOptions: {
+    folder: './src/widgets/'
+  }
+});

package/template/WidgetRoutes.ejs

@@ -1,18 +1,18 @@
 import <%= name %>WidgetDefine from "./<%= name %>.widget";
 
-const url = <%= name %>WidgetDefine.getIndexRoute().url;
+const path = <%= name %>WidgetDefine.path;
 const name = <%= name %>WidgetDefine.name;
 <% if (configurable) { %>
-const configUrl = <%= name %>WidgetDefine.getConfigRoute()!.url;
+const configPagePath = <%= name %>WidgetDefine.configPagePath;
 
 const <%= name %>WidgetRoutes = [
     {
-        path: url,
+        path: path,
         name: `${name}`,
         component: () => import(/* webpackChunkName: "<%= widgetName %>" */ './<%= name %>WidgetView.vue')
     },
     {
-        path: configUrl,
+        path: configPagePath,
         name: `${name}.config`,
         component: () => import(/* webpackChunkName: "<%= widgetName %>.config" */ './<%= name %>ConfigView.vue')
     }
@@ -20,7 +20,7 @@ const <%= name %>WidgetRoutes = [
 <% } else { %>
 const <%= name %>WidgetRoutes = [
     {
-        path: url,
+        path: path,
         name: `${name}`,
         component: () => import(/* webpackChunkName: "<%= widgetName %>" */ './<%= name %>WidgetView.vue')
     }

package/widget.package.ts

@@ -0,0 +1,23 @@
+import {WidgetPackage} from "@widget-js/core";
+
+export default new WidgetPackage({
+  author: "Neo Fu",
+  description: {
+    "zh-CN": "包含知乎、B站、抖音、微博等平台的热搜组件。",
+  },
+  entry: "index.html",
+  hash: true,
+  homepage: "https://widgetjs.cn",
+  name: "cn.widgetjs.widgets.hotspot",
+  remoteEntry: "https://rtugeek.gitee.io/hotspot",
+  remotePackage: "https://rtugeek.gitee.io/hotspot/widget.json",
+  title: {
+    "zh-CN": "全网热点组件",
+  },
+  version: "1.0.0",
+  devOptions: {
+    folder: "./src/widgets/",
+    route: true,
+    devUrl: "http://localhost:5173/hotspot"
+  }
+});

package/widget.ts

@@ -1,24 +1,22 @@
-import {WidgetPackage} from "@widget-js/core";
+import { WidgetPackage } from '@widget-js/core';
 
+//TODO 完善组件包信息
 export default new WidgetPackage({
-  author: "Neo Fu",
+  author: '修改成你的信息',
   description: {
-    "zh-CN": "包含知乎、B站、抖音、微博等平台的热搜组件。",
+    'zh-CN': '修改成你的组件描述',
   },
-  entry: "index.html",
+  entry: 'index.html',
   hash: true,
-  homepage: "https://widgetjs.cn",
-  name: "cn.widgetjs.widgets.hotspot",
-  remoteEntry: "https://rtugeek.gitee.io/hotspot",
-  remotePackage: "https://rtugeek.gitee.io/hotspot/widget.json",
+  homepage: '',
+  name: 'test',
+  remoteEntry: '',
+  remotePackage: '',
   title: {
-    "zh-CN": "全网热点组件",
+    'zh-CN': '修改成你的组件标题',
   },
-  url: "",
-  version: "1.0.0",
+  version: '1.0.0',
   devOptions: {
-    folder: "./src/widgets/",
-    route: true,
-    devUrl: "http://localhost:5173/hotspot"
-  }
+    folder: './src/widgets/',
+  },
 });