create-halo-plugin-template 1.0.4 → 1.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-halo-plugin-template",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Create and initialize reusable Halo plugin starter projects.",
   "type": "module",
   "license": "GPL-3.0",

package/scripts/init-template.mjs

@@ -9,6 +9,7 @@ import {
   normalizePluginName,
   normalizeRoutePrefix,
   reverseBasePackage,
+  slugify,
   toClassPrefix,
   toKebabToken,
 } from './lib/template-meta.mjs'

package/scripts/verify-template.mjs

@@ -125,6 +125,28 @@ const walkFiles = async (directory) => {
   return files
 }
 
+const collectFiles = async (directory, matcher, result = []) => {
+  if (!(await exists(directory))) {
+    return result
+  }
+
+  const entries = await fs.readdir(path.join(ROOT, directory), { withFileTypes: true })
+
+  for (const entry of entries) {
+    const relativePath = path.posix.join(directory, entry.name)
+    if (entry.isDirectory()) {
+      await collectFiles(relativePath, matcher, result)
+      continue
+    }
+
+    if (matcher(relativePath)) {
+      result.push(relativePath)
+    }
+  }
+
+  return result
+}
+
 const escapeRegExp = (value) => value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
 
 const readText = async (relativePath) =>
@@ -261,6 +283,10 @@ const verifyRepo = async (args) => {
   const permissionPrefix = `${configuredPermissionPrefix}:`
   const resolvedConsolePath = consolePath || routePrefix
   const resolvedUcPath = ucPath || routePrefix
+  const generatedApiFiles = await collectFiles(
+    path.posix.join(generatedClientPath, 'api'),
+    (filePath) => filePath.endsWith('.ts'),
+  )
 
   if (!pluginName || !displayName || !basePackage) {
     fail(results, 'Unable to resolve plugin constants from SettingKeys.java or build.gradle')
@@ -325,6 +351,26 @@ const verifyRepo = async (args) => {
     fail(results, `Generated model directory is missing: ${generatedClientPath}/models`)
   }
 
+  if (generatedApiFiles.length > 0) {
+    const generatedApiContent = (
+      await Promise.all(generatedApiFiles.map((relativePath) => readText(relativePath)))
+    ).join('\n')
+    assertContains(
+      results,
+      generatedApiContent,
+      `/apis/console.${apiGroupSuffix}/v1alpha1/`,
+      'Generated client console path matches API group suffix',
+    )
+    assertContains(
+      results,
+      generatedApiContent,
+      `/apis/uc.${apiGroupSuffix}/v1alpha1/`,
+      'Generated client UC path matches API group suffix',
+    )
+  } else {
+    fail(results, `Generated API files are missing under ${generatedClientPath}/api`)
+  }
+
   if (args['plugin-name'] && args['plugin-name'] !== pluginName) {
     fail(results, `Expected plugin name ${args['plugin-name']}, got ${pluginName}`)
   } else if (args['plugin-name']) {

package/src/main/java/run/halo/plugintemplate/utils/PluginTemplateSeeds.java

@@ -148,10 +148,10 @@ public final class PluginTemplateSeeds {
         return List.of(
             PluginTemplateChecklistItem.builder()
                 .key("init-script")
-                .title("运行初始化脚本")
-                .description("先替换插件名、包名、权限前缀和仓库地址，再开始写业务。")
+                .title("确认初始化结果")
+                .description("通过 npm create 或 create-project 创建项目时，这一步已经自动完成；只有手工复制模板源码时，才需要单独运行初始化脚本。")
                 .audience("all")
-                .status("todo")
+                .status("done")
                 .build(),
             PluginTemplateChecklistItem.builder()
                 .key("settings")

package/ui/src/api/generated/api/plugin-template-console-api.ts

@@ -35,7 +35,7 @@ export const PluginTemplateConsoleApiAxiosParamCreator = function (configuration
          * @throws {RequiredError}
          */
         pluginTemplateOverviewForConsole: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
-            const localVarPath = `/apis/console.halo-plugin-template.halo.run/v1alpha1/template-overview/summary`;
+            const localVarPath = `/apis/console.plugintemplate.halo.run/v1alpha1/template-overview/summary`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;

package/ui/src/api/generated/api/plugin-template-uc-api.ts

@@ -35,7 +35,7 @@ export const PluginTemplateUcApiAxiosParamCreator = function (configuration?: Co
          * @throws {RequiredError}
          */
         pluginTemplateOverviewForUc: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
-            const localVarPath = `/apis/uc.halo-plugin-template.halo.run/v1alpha1/template-overview/summary`;
+            const localVarPath = `/apis/uc.plugintemplate.halo.run/v1alpha1/template-overview/summary`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;

package/ui/src/components/PluginTemplateOverviewPage.vue

@@ -3,7 +3,7 @@ import { stores, utils } from '@halo-dev/ui-shared'
 import { ElAlert, ElButton, ElLink, ElSkeleton } from 'element-plus'
 import { storeToRefs } from 'pinia'
 import { computed, onMounted } from 'vue'
-import { buildAudienceLabel, checklistColumns, featureColumns } from '@/lib/template'
+import { buildAudienceLabel, checklistColumns, featureColumns, formatChecklistStatus } from '@/lib/template'
 import { useTemplateOverview } from '@/composables/useTemplateOverview'
 import PluginTemplateCommonTable from './PluginTemplateCommonTable.vue'
 import PluginUiProvider from './ui/PluginUiProvider.vue'
@@ -142,7 +142,7 @@ onMounted(load)
                       {{ item.description }}
                     </p>
                   </div>
-                  <UiStatusPill :label="item.status" :tone="item.status" />
+                  <UiStatusPill :label="formatChecklistStatus(item.status)" :tone="item.status" />
                 </article>
               </div>
             </UiSectionCard>
@@ -226,7 +226,7 @@ onMounted(load)
               empty-description="暂无初始化清单"
             >
               <template #cell-status="{ value }">
-                <UiStatusPill :label="String(value)" :tone="String(value)" />
+                <UiStatusPill :label="formatChecklistStatus(String(value))" :tone="String(value)" />
               </template>
             </PluginTemplateCommonTable>
           </UiSectionCard>
@@ -236,14 +236,13 @@ onMounted(load)
             description="模板的真实价值在于后续多个插件项目都沿用同一套工程边界。"
           >
             <ul style="margin: 0; padding-left: 18px; color: var(--halo-plugin-template-text-secondary); line-height: 1.8">
-              <li>先运行初始化脚本，再修改 `plugin.yaml`、`settings.yaml`、角色模板和 Java 包名。</li>
-              <li>初始化后执行 `node scripts/verify-template.mjs`，确认插件名、包名、权限前缀和文档入口已经全部收敛。</li>
+              <li>如果你是通过 `npm create halo-plugin-template` 或 `create-project.mjs` 创建项目，初始化和一致性校验已经自动完成。</li>
+              <li>只有在手工复制模板源码仓库时，才需要额外运行初始化脚本和校验脚本。</li>
               <li>新接口补好 Springdoc 后，执行 `./gradlew generateApiClient`，再在 `ui/src/api/index.ts` 暴露新增能力。</li>
               <li>按插件实际范围裁剪 UC、附件扩展和工作台部件，避免模板示例残留到正式项目。</li>
               <li>
                 如需切换到 Rsbuild，可参考
-                <ElLink :href="rsbuildGuideLink" target="_blank">Halo 官方 UI 构建说明</ElLink>
-                和仓库内的 `docs/rsbuild-switch.md`。
+                <ElLink :href="rsbuildGuideLink" target="_blank">Halo 官方 UI 构建说明</ElLink>。
               </li>
             </ul>
           </UiSectionCard>

package/ui/src/lib/template.spec.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest'
-import { buildAudienceLabel, formatCellValue, toTagType } from './template'
+import { buildAudienceLabel, formatCellValue, formatChecklistStatus, toTagType } from './template'
 
 describe('template helpers', () => {
   it('maps known audiences to readable labels', () => {
@@ -17,8 +17,19 @@ describe('template helpers', () => {
 
   it('maps semantic tones to Element Plus tags', () => {
     expect(toTagType('primary')).toBe('primary')
+    expect(toTagType('now')).toBe('primary')
     expect(toTagType('success')).toBe('success')
+    expect(toTagType('done')).toBe('success')
     expect(toTagType('recommended')).toBe('warning')
+    expect(toTagType('todo')).toBe('warning')
     expect(toTagType('unknown')).toBe('info')
   })
+
+  it('formats checklist statuses for display', () => {
+    expect(formatChecklistStatus('done')).toBe('已完成')
+    expect(formatChecklistStatus('recommended')).toBe('建议处理')
+    expect(formatChecklistStatus('todo')).toBe('待处理')
+    expect(formatChecklistStatus('optional')).toBe('按需处理')
+    expect(formatChecklistStatus('other')).toBe('other')
+  })
 })

package/ui/src/lib/template.ts

@@ -18,11 +18,15 @@ export const checklistColumns: ResponsiveColumn[] = [
 export const toTagType = (tone?: string): TagProps['type'] => {
   switch (tone) {
     case 'primary':
+    case 'now':
       return 'primary'
     case 'success':
+    case 'done':
+    case 'auto':
       return 'success'
     case 'warning':
     case 'recommended':
+    case 'todo':
       return 'warning'
     case 'danger':
       return 'danger'
@@ -31,6 +35,27 @@ export const toTagType = (tone?: string): TagProps['type'] => {
   }
 }
 
+export const formatChecklistStatus = (status?: string) => {
+  switch (status) {
+    case 'done':
+      return '已完成'
+    case 'auto':
+      return '已自动完成'
+    case 'recommended':
+      return '建议处理'
+    case 'now':
+      return '当前处理'
+    case 'optional':
+      return '按需处理'
+    case 'todo':
+      return '待处理'
+    case 'success':
+      return '已完成'
+    default:
+      return formatCellValue(status)
+  }
+}
+
 export const buildAudienceLabel = (audience: string) => {
   if (audience === 'console') {
     return 'Console'