@widget-js/cli 1.1.8 → 1.1.10

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/src/widgets/test/Test.widget.ts

@@ -0,0 +1,39 @@
+import { Widget, WidgetKeyword } from '@widget-js/core';
+//TODO 修改组件信息，标题，描述，关键词
+const name = 'cn.widgetjs.widgets.hotspot.test';
+//组件标题
+const title = { 'zh-CN': '123' };
+//组件描述
+const description = { 'zh-CN': '' };
+//组件关键词
+const keywords = [WidgetKeyword.RECOMMEND];
+//组件路由地址
+const url = '/widget/test';
+//配置页路由地址
+const configUrl = '/widget/config/test';
+//组件关键词
+const TestWidgetDefine = new Widget({
+  name: name,
+  title: title,
+  description: description,
+  keywords: keywords,
+  lang: 'zh-CN',
+  width: 2,
+  height: 3,
+  minWidth: 1,
+  maxWidth: 3,
+  minHeight: 2,
+  maxHeight: 3,
+  routes: [
+    {
+      url: url,
+      name: 'index',
+    },
+    {
+      url: configUrl,
+      name: 'config',
+    },
+  ],
+});
+
+export default TestWidgetDefine;

package/src/widgets/test/TestConfigView.vue

@@ -0,0 +1,41 @@
+<template>
+  <widget-edit-dialog
+    :widget-params="widgetParams"
+    :option="widgetConfigOption"
+    :widget-data="widgetData"
+    @confirm="onSaveClick()"
+  >
+    <template v-slot:form>
+      <!--  TODO 这里写自定义表单内容          -->
+    </template>
+  </widget-edit-dialog>
+</template>
+
+<script lang="ts" setup>
+import {
+  useWidget,
+  WidgetConfigOption,
+  WidgetEditDialog,
+} from '@widget-js/vue3';
+import { WidgetData, WidgetDataApi } from '@widget-js/core';
+import { reactive } from 'vue';
+
+const { widgetData, widgetParams } = useWidget(WidgetData);
+
+//修改成需要设置组件参数配置
+const widgetConfigOption = reactive(
+  new WidgetConfigOption({
+    custom: true,
+    backgroundColor: true,
+    borderRadius: true,
+    preview: false,
+  })
+);
+
+const onSaveClick = async () => {
+  await WidgetDataApi.save(widgetData);
+  window.close();
+};
+</script>
+
+<style scoped></style>

package/src/widgets/test/TestWidget.vue

@@ -0,0 +1,7 @@
+<template>
+  <!-- TODO 这里只写组件内容，不做自定义数据、业务处理   -->
+</template>
+
+<script lang="ts" setup></script>
+
+<style scoped></style>

package/src/widgets/test/TestWidgetRoutes.ts

@@ -0,0 +1,27 @@
+import TestWidgetDefine from './Test.widget';
+
+const url = TestWidgetDefine.getIndexRoute().url;
+const name = TestWidgetDefine.name;
+
+const configUrl = TestWidgetDefine.getConfigRoute()!.url;
+
+const TestWidgetRoutes = [
+  {
+    path: url,
+    name: `${name}`,
+    component: () =>
+      import(
+        /* webpackChunkName: "cn.widgetjs.widgets.hotspot.test" */ './TestWidgetView.vue'
+      ),
+  },
+  {
+    path: configUrl,
+    name: `${name}.config`,
+    component: () =>
+      import(
+        /* webpackChunkName: "cn.widgetjs.widgets.hotspot.test.config" */ './TestConfigView.vue'
+      ),
+  },
+];
+
+export default TestWidgetRoutes;

package/src/widgets/test/TestWidgetView.vue

@@ -0,0 +1,14 @@
+<template>
+  <!-- TODO:组件页面，这里编写组件业务逻辑-->
+  <test-widget></test-widget>
+</template>
+
+<script lang="ts" setup>
+import { WidgetData } from '@widget-js/core';
+import TestWidget from './TestWidget.vue';
+import { useWidget } from '@widget-js/vue3';
+
+const { widgetData, widgetParams } = useWidget(WidgetData);
+</script>
+
+<style scoped></style>

package/src/widgets/widget-router.ts

@@ -0,0 +1,8 @@
+import TestWidgetRoutes from "./test/TestWidgetRoutes";
+//FBI WANING! IMPORT PLACE, DONT DELETE THIS LINE
+
+const WidgetRouter = [
+    ...TestWidgetRoutes,
+    //FBI WANING! ROUTE PLACE, DONT DELETE THIS LINE
+];
+export default WidgetRouter

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/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/',
+  },
 });