create-halo-plugin-template 1.0.0 → 1.0.1

package/src/main/resources/extensions/settings.yaml

@@ -0,0 +1,47 @@
+apiVersion: v1alpha1
+kind: Setting
+metadata:
+  name: halo-plugin-template-settings
+spec:
+  forms:
+    - group: general
+      label: 通用设置
+      formSchema:
+        - $formkit: switch
+          name: enableConsoleDashboard
+          label: 启用 Console 工作台
+          value: true
+          help: 控制插件默认 Console 页面和仪表盘小部件是否启用。
+        - $formkit: switch
+          name: enableUcDashboard
+          label: 启用 UC 页面
+          value: true
+          help: 控制插件是否向 Halo UC 注册默认示例页面。
+        - $formkit: switch
+          name: enableAttachmentProvider
+          label: 启用附件扩展标签页
+          value: true
+          help: 开启后在附件选择器里显示模板扩展示例。
+    - group: ui
+      label: 界面主题
+      formSchema:
+        - $formkit: color
+          name: accentColor
+          label: 主色
+          value: "#2457F5"
+        - $formkit: radio
+          name: density
+          label: 页面密度
+          value: balanced
+          options:
+            - value: compact
+              label: 紧凑
+            - value: balanced
+              label: 平衡
+            - value: relaxed
+              label: 宽松
+        - $formkit: text
+          name: supportLink
+          label: 支持地址
+          value: "https://docs.halo.run/developer-guide/plugin/introduction"
+          help: 模板页右上角默认按钮可直接跳转到该地址。

package/src/main/resources/plugin.yaml

@@ -0,0 +1,24 @@
+# Refer https://docs.halo.run/developer-guide/plugin/basics/manifest
+
+apiVersion: plugin.halo.run/v1alpha1
+kind: Plugin
+metadata:
+  # The name defines how the plugin is invoked, A unique name
+  name: halo-plugin-template
+spec:
+  enabled: true
+  requires: ">=2.23.0"
+  author:
+    name: Template Author
+    website: https://github.com/example
+  logo: logo.png
+  settingName: halo-plugin-template-settings
+  configMapName: halo-plugin-template-configmap
+  homepage: https://github.com/example/halo-plugin-template#readme
+  repo: https://github.com/example/halo-plugin-template
+  issues: https://github.com/example/halo-plugin-template/issues
+  displayName: "Halo Plugin Template"
+  description: "Halo plugin starter with Vite, Element Plus, extension points, and an initialization script."
+  license:
+    - name: "GPL-3.0"
+      url: "https://github.com/example/halo-plugin-template/blob/main/LICENSE"

package/src/test/java/run/halo/plugintemplate/PluginTemplatePluginTest.java

@@ -0,0 +1,34 @@
+package run.halo.plugintemplate;
+
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.verify;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+import run.halo.app.extension.SchemeManager;
+import run.halo.app.plugin.PluginContext;
+import run.halo.plugintemplate.scheme.PluginTemplateRecord;
+
+@ExtendWith(MockitoExtension.class)
+class PluginTemplatePluginTest {
+
+    @Mock
+    PluginContext context;
+
+    @Mock
+    SchemeManager schemeManager;
+
+    @Test
+    void shouldRegisterAndUnregisterTemplateScheme() {
+        PluginTemplatePlugin plugin = new PluginTemplatePlugin(context, schemeManager);
+
+        plugin.start();
+        plugin.stop();
+
+        verify(schemeManager).register(eq(PluginTemplateRecord.class), any());
+        verify(schemeManager).unregister(any());
+    }
+}

package/src/test/java/run/halo/plugintemplate/service/impl/PluginTemplateOverviewServiceImplTest.java

@@ -0,0 +1,97 @@
+package run.halo.plugintemplate.service.impl;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.when;
+
+import java.time.Clock;
+import java.time.Instant;
+import java.time.ZoneOffset;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+import reactor.core.publisher.Mono;
+import run.halo.app.plugin.ReactiveSettingFetcher;
+import run.halo.plugintemplate.model.PluginTemplateAudience;
+import run.halo.plugintemplate.setting.PluginTemplateGeneralSetting;
+import run.halo.plugintemplate.setting.PluginTemplateSettingKeys;
+import run.halo.plugintemplate.setting.PluginTemplateUiSetting;
+
+@ExtendWith(MockitoExtension.class)
+class PluginTemplateOverviewServiceImplTest {
+
+    private static final Clock FIXED_CLOCK = Clock.fixed(
+        Instant.parse("2026-04-07T10:00:00Z"),
+        ZoneOffset.UTC
+    );
+
+    @Mock
+    ReactiveSettingFetcher settingFetcher;
+
+    @Test
+    void shouldApplyFetchedSettingsIntoOverview() {
+        var generalSetting = new PluginTemplateGeneralSetting();
+        generalSetting.setEnableConsoleDashboard(true);
+        generalSetting.setEnableUcDashboard(false);
+        generalSetting.setEnableAttachmentProvider(false);
+
+        var uiSetting = new PluginTemplateUiSetting();
+        uiSetting.setAccentColor("#102030");
+        uiSetting.setDensity("compact");
+        uiSetting.setSupportLink("https://example.com/help");
+
+        when(settingFetcher.fetch(PluginTemplateSettingKeys.GENERAL_GROUP, PluginTemplateGeneralSetting.class))
+            .thenReturn(Mono.just(generalSetting));
+        when(settingFetcher.fetch(PluginTemplateSettingKeys.UI_GROUP, PluginTemplateUiSetting.class))
+            .thenReturn(Mono.just(uiSetting));
+
+        var service = new PluginTemplateOverviewServiceImpl(FIXED_CLOCK, settingFetcher);
+
+        var overview = service.getOverview(PluginTemplateAudience.CONSOLE).block();
+
+        assertThat(overview).isNotNull();
+        assertThat(overview.getEnableConsoleDashboard()).isTrue();
+        assertThat(overview.getEnableUcDashboard()).isFalse();
+        assertThat(overview.getEnableAttachmentProvider()).isFalse();
+        assertThat(overview.getAccentColor()).isEqualTo("#102030");
+        assertThat(overview.getDensity()).isEqualTo("compact");
+        assertThat(overview.getSupportLink()).isEqualTo("https://example.com/help");
+        assertThat(overview.getStats())
+            .extracting("key", "value")
+            .containsExactly(
+                org.assertj.core.groups.Tuple.tuple("routes", "1"),
+                org.assertj.core.groups.Tuple.tuple("extension-points", "2"),
+                org.assertj.core.groups.Tuple.tuple("ui-density", "紧凑")
+            );
+        assertThat(overview.getFeatures())
+            .filteredOn(feature -> "uc-route".equals(feature.getKey()))
+            .singleElement()
+            .extracting(feature -> feature.getEnabled())
+            .isEqualTo(false);
+        assertThat(overview.getFeatures())
+            .filteredOn(feature -> "attachment-tab".equals(feature.getKey()))
+            .singleElement()
+            .extracting(feature -> feature.getEnabled())
+            .isEqualTo(false);
+    }
+
+    @Test
+    void shouldFallbackToDefaultSettingsWhenFetcherReturnsEmpty() {
+        when(settingFetcher.fetch(PluginTemplateSettingKeys.GENERAL_GROUP, PluginTemplateGeneralSetting.class))
+            .thenReturn(Mono.empty());
+        when(settingFetcher.fetch(PluginTemplateSettingKeys.UI_GROUP, PluginTemplateUiSetting.class))
+            .thenReturn(Mono.empty());
+
+        var service = new PluginTemplateOverviewServiceImpl(FIXED_CLOCK, settingFetcher);
+
+        var overview = service.getOverview(PluginTemplateAudience.UC).block();
+
+        assertThat(overview).isNotNull();
+        assertThat(overview.getEnableConsoleDashboard()).isTrue();
+        assertThat(overview.getEnableUcDashboard()).isTrue();
+        assertThat(overview.getEnableAttachmentProvider()).isTrue();
+        assertThat(overview.getAccentColor()).isEqualTo(PluginTemplateSettingKeys.DEFAULT_ACCENT_COLOR);
+        assertThat(overview.getDensity()).isEqualTo(PluginTemplateSettingKeys.DEFAULT_DENSITY);
+        assertThat(overview.getSupportLink()).isEqualTo(PluginTemplateSettingKeys.DEFAULT_SUPPORT_LINK);
+    }
+}

package/ui/build.gradle

@@ -0,0 +1,41 @@
+plugins {
+    id 'base'
+    id "com.github.node-gradle.node" version "7.1.0"
+}
+
+group 'run.halo.plugintemplate.ui'
+
+tasks.register('pnpmBuild', PnpmTask) {
+    group = 'build'
+    description = 'Build the UI project using pnpm'
+    args = ['build']
+    dependsOn tasks.named('pnpmInstall')
+    inputs.dir(layout.projectDirectory.dir('src'))
+    inputs.files(fileTree(
+        dir: layout.projectDirectory,
+        includes: ['*.cjs', '*.ts', '*.js', '*.json', '*.yaml']))
+    outputs.dir(layout.buildDirectory.dir('dist'))
+}
+
+tasks.register('pnpmCheck', PnpmTask) {
+    group = 'verification'
+    description = 'Run unit tests for the UI project using pnpm'
+    args = ['test:unit']
+    dependsOn tasks.named('pnpmInstall')
+}
+
+tasks.register('pnpmLint', PnpmTask) {
+    group = 'verification'
+    description = 'Run lint checks for the UI project using pnpm'
+    args = ['lint']
+    dependsOn tasks.named('pnpmInstall')
+}
+
+tasks.named('check') {
+    dependsOn tasks.named('pnpmCheck')
+    dependsOn tasks.named('pnpmLint')
+}
+
+tasks.named('assemble') {
+    dependsOn tasks.named('pnpmBuild')
+}

package/ui/env.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="vite/client" />
+/// <reference types="unplugin-icons/types/vue" />

package/ui/eslint.config.ts

@@ -0,0 +1,30 @@
+import { globalIgnores } from 'eslint/config'
+import { defineConfigWithVueTs, vueTsConfigs } from '@vue/eslint-config-typescript'
+import pluginVue from 'eslint-plugin-vue'
+import pluginVitest from '@vitest/eslint-plugin'
+import pluginOxlint from 'eslint-plugin-oxlint'
+import skipFormatting from '@vue/eslint-config-prettier/skip-formatting'
+
+// To allow more languages other than `ts` in `.vue` files, uncomment the following lines:
+// import { configureVueProject } from '@vue/eslint-config-typescript'
+// configureVueProject({ scriptLangs: ['ts', 'tsx'] })
+// More info at https://github.com/vuejs/eslint-config-typescript/#advanced-setup
+
+export default defineConfigWithVueTs(
+  {
+    name: 'app/files-to-lint',
+    files: ['**/*.{ts,mts,tsx,vue}'],
+  },
+
+  globalIgnores(['**/dist/**', '**/dist-ssr/**', '**/coverage/**', 'src/api/generated/**']),
+
+  pluginVue.configs['flat/essential'],
+  vueTsConfigs.recommended,
+  
+  {
+    ...pluginVitest.configs.recommended,
+    files: ['src/**/*.spec.ts', 'src/**/*.test.ts'],
+  },
+  ...pluginOxlint.configs['flat/recommended'],
+  skipFormatting,
+)

package/ui/package.json

@@ -0,0 +1,57 @@
+{
+  "type": "module",
+  "scripts": {
+    "build": "run-p type-check \"build-only {@}\" --",
+    "build-only": "vite build",
+    "dev": "vite build --watch --mode=development",
+    "lint:oxlint": "oxlint . --fix -D correctness --ignore-path ../.gitignore",
+    "lint:eslint": "eslint . --fix",
+    "lint": "run-s lint:*",
+    "prettier": "prettier --write src/",
+    "test:unit": "vitest --passWithNoTests",
+    "type-check": "vue-tsc --build",
+    "verify": "run-s lint test:unit type-check"
+  },
+  "prettier": {
+    "printWidth": 100,
+    "semi": false,
+    "singleQuote": true,
+    "tabWidth": 2
+  },
+  "dependencies": {
+    "@halo-dev/api-client": "^2.23.0",
+    "@halo-dev/components": "^2.23.0",
+    "@halo-dev/ui-shared": "^2.23.0",
+    "@element-plus/icons-vue": "^2.3.1",
+    "axios": "^1.13.5",
+    "element-plus": "^2.10.2",
+    "pinia": "^3.0.3",
+    "vue": "^3.5.28"
+  },
+  "devDependencies": {
+    "@halo-dev/ui-plugin-bundler-kit": "^2.23.0",
+    "@iconify-json/ri": "^1.2.6",
+    "@tsconfig/node20": "^20.1.6",
+    "@types/jsdom": "^21.1.7",
+    "@types/node": "^20.19.1",
+    "@vitest/eslint-plugin": "^1.2.7",
+    "@vue/eslint-config-prettier": "^10.2.0",
+    "@vue/eslint-config-typescript": "^14.5.1",
+    "@vue/test-utils": "^2.4.6",
+    "@vue/tsconfig": "^0.7.0",
+    "eslint": "^9.29.0",
+    "eslint-plugin-oxlint": "^0.16.12",
+    "eslint-plugin-vue": "~10.0.1",
+    "jsdom": "^26.1.0",
+    "npm-run-all2": "^7.0.2",
+    "oxlint": "^0.16.12",
+    "prettier": "^3.6.0",
+    "sass": "^1.89.2",
+    "typescript": "~5.8.3",
+    "unplugin-icons": "^23.0.1",
+    "vite": "^8.0.0",
+    "vitest": "^4.1.0",
+    "vue-tsc": "^3.2.4"
+  },
+  "packageManager": "pnpm@10.12.4"
+}