create-halo-plugin-template 1.0.3 → 1.0.5

package/README.md

@@ -25,11 +25,13 @@
 
 ```bash
 node scripts/create-project.mjs \
-  --plugin-name hello-world \
+  --plugin-name todo \
   --base-package com.example.helloworld \
-  --display-name "Hello World" \
+  --display-name "Todo" \
   --author-name "Your Name" \
-  --target-dir ../hello-world \
+  --route-prefix /plugin-todo \
+  --permission-prefix plugin:plugin-todo \
+  --target-dir ../plugin-todo \
   --install \
   --build
 ```
@@ -48,9 +50,9 @@ node scripts/create-project.mjs \
 
 ```bash
 npm create halo-plugin-template@latest -- \
-  --plugin-name hello-world \
+  --plugin-name todo \
   --base-package com.example.helloworld \
-  --display-name "Hello World" \
+  --display-name "Todo" \
   --author-name "Your Name"
 ```
 
@@ -93,13 +95,15 @@ npm run release:prepare -- --bump patch --push
 
 ```bash
 node scripts/init-template.mjs \
-  --plugin-name hello-world \
+  --plugin-name todo \
   --base-package com.example.helloworld \
-  --display-name "Hello World" \
+  --display-name "Todo" \
   --author-name "Your Name" \
+  --route-prefix /plugin-todo \
+  --permission-prefix plugin:plugin-todo \
   --author-website "https://github.com/your-name" \
   --repo-owner your-name \
-  --description "Hello World - Halo 插件"
+  --description "Todo - Halo 插件"
 ```
 
 这个脚本是一次性的。执行后会连同自身模板常量一起改写，确保生成出来的项目里不再残留模板占位符。
@@ -108,10 +112,12 @@ node scripts/init-template.mjs \
 
 ```bash
 node scripts/verify-template.mjs \
-  --plugin-name hello-world \
+  --plugin-name todo \
   --base-package com.example.helloworld \
-  --display-name "Hello World" \
-  --author-name "Your Name"
+  --display-name "Todo" \
+  --author-name "Your Name" \
+  --route-prefix /plugin-todo \
+  --permission-prefix plugin:plugin-todo
 ```
 
 然后安装前端依赖并启动开发环境：

package/build.gradle

@@ -58,14 +58,16 @@ tasks.named('generatePluginComponentsIdx') {
     notCompatibleWithConfigurationCache('This task invokes "Task.project" at execution time, which is not supported with configuration cache.')
 }
 
-tasks.register('verifyTemplateConsistency', Exec) {
-    group = 'verification'
-    description = 'Verify the starter repository or initialized plugin stays internally consistent'
-    commandLine 'node', 'scripts/verify-template.mjs'
-}
+if (file('scripts/verify-template.mjs').exists()) {
+    tasks.register('verifyTemplateConsistency', Exec) {
+        group = 'verification'
+        description = 'Verify the starter repository or initialized plugin stays internally consistent'
+        commandLine 'node', 'scripts/verify-template.mjs'
+    }
 
-tasks.named('check') {
-    dependsOn tasks.named('verifyTemplateConsistency')
+    tasks.named('check') {
+        dependsOn tasks.named('verifyTemplateConsistency')
+    }
 }
 
 halo {
@@ -76,16 +78,17 @@ haloPlugin {
     openApi {
         outputDir = file("$rootDir/api-docs/openapi/v3_0")
         groupingRules {
-            templateApis {
+            plugintemplateApis {
                 displayName = 'Extension API for halo-plugin-template'
                 pathsToMatch = [
-                        '/apis/console.halo-plugin-template.halo.run/v1alpha1/**',
-                        '/apis/uc.halo-plugin-template.halo.run/v1alpha1/**'
+                        '/apis/console.plugintemplate.halo.run/v1alpha1/**',
+                        '/apis/uc.plugintemplate.halo.run/v1alpha1/**',
+                        '/apis/public.plugintemplate.halo.run/v1alpha1/**'
                 ]
             }
         }
         groupedApiMappings = [
-                '/v3/api-docs/templateApis': 'templateApis.json'
+                '/v3/api-docs/plugintemplateApis': 'plugintemplateApis.json'
         ]
         generator {
             outputDir = file("${projectDir}/ui/src/api/generated")

package/docs/first-npm-release-checklist.md

@@ -51,8 +51,8 @@ npm view create-halo-plugin-template version
 
 ```bash
 npm create halo-plugin-template@latest -- \
-  --plugin-name hello-world \
+  --plugin-name todo \
   --base-package com.example.helloworld \
-  --display-name "Hello World" \
+  --display-name "Todo" \
   --author-name "Your Name"
 ```

package/docs/publish-template.md

@@ -15,9 +15,9 @@
 
 ```bash
 npm create halo-plugin-template@latest -- \
-  --plugin-name hello-world \
+  --plugin-name todo \
   --base-package com.example.helloworld \
-  --display-name "Hello World" \
+  --display-name "Todo" \
   --author-name "Your Name"
 ```
 
@@ -31,9 +31,9 @@ npm create halo-plugin-template@latest -- \
 
 ```bash
 npm init @your-scope/halo-plugin-template@latest -- \
-  --plugin-name hello-world \
+  --plugin-name todo \
   --base-package com.example.helloworld \
-  --display-name "Hello World" \
+  --display-name "Todo" \
   --author-name "Your Name"
 ```
 

package/docs/template-pruning.md

@@ -31,10 +31,12 @@
 
 ```bash
 node scripts/verify-template.mjs \
-  --plugin-name hello-world \
+  --plugin-name todo \
   --base-package com.example.helloworld \
-  --display-name "Hello World" \
-  --author-name "Your Name"
+  --display-name "Todo" \
+  --author-name "Your Name" \
+  --route-prefix /plugin-todo \
+  --permission-prefix plugin:plugin-todo
 
 ./gradlew build
 cd ui && pnpm test:unit

package/package.json

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

package/scripts/create-project.mjs

@@ -5,6 +5,11 @@ import path from 'node:path'
 import process from 'node:process'
 import { spawn } from 'node:child_process'
 import { fileURLToPath } from 'node:url'
+import {
+  normalizePermissionPrefix,
+  normalizePluginName,
+  normalizeRoutePrefix,
+} from './lib/template-meta.mjs'
 
 const SCRIPT_DIR = path.dirname(fileURLToPath(import.meta.url))
 const TEMPLATE_ROOT = path.resolve(SCRIPT_DIR, '..')
@@ -22,38 +27,33 @@ const SKIP_RELATIVE_PATHS = new Set([
   '.npmignore',
   '.github/workflows/publish-npm.yaml',
   'bin',
+  'docs',
   'docs/publish-template.md',
   'package.json',
   'package-lock.json',
   'pnpm-lock.yaml',
-  'scripts/create-project.mjs',
-  'scripts/publish-check.mjs',
+  'scripts',
   'ui/build',
 ])
 
 const usage = `
 Usage:
   node scripts/create-project.mjs \\
-    --plugin-name hello-world \\
+    --plugin-name todo \\
     --base-package com.example.helloworld \\
-    --display-name "Hello World" \\
+    --display-name "Todo" \\
     --author-name "Your Name" \\
-    [--target-dir ../hello-world] \\
+    [--route-prefix /plugin-todo] \\
+    [--permission-prefix plugin:plugin-todo] \\
+    [--target-dir ../plugin-todo] \\
     [--author-website "https://github.com/your-name"] \\
     [--repo-owner your-name] \\
-    [--description "Hello World - Halo 插件"] \\
+    [--description "Todo - Halo 插件"] \\
     [--install] \\
     [--build] \\
     [--halo-server]
 `.trim()
 
-const slugify = (value) =>
-  value
-    .trim()
-    .toLowerCase()
-    .replace(/[^a-z0-9]+/g, '-')
-    .replace(/^-+|-+$/g, '')
-
 const parseArgs = (argv) => {
   const parsed = {
     install: false,
@@ -121,7 +121,9 @@ const parseArgs = (argv) => {
     }
   }
 
-  const pluginName = slugify(parsed['plugin-name'])
+  const pluginName = normalizePluginName(parsed['plugin-name'])
+  const routePrefix = normalizeRoutePrefix(parsed['route-prefix'], pluginName)
+  const permissionPrefix = normalizePermissionPrefix(parsed['permission-prefix'], pluginName)
 
   return {
     pluginName,
@@ -131,6 +133,8 @@ const parseArgs = (argv) => {
     authorWebsite: parsed['author-website'] || '',
     repoOwner: parsed['repo-owner'] || '',
     description: parsed.description || '',
+    routePrefix,
+    permissionPrefix,
     targetDir: path.resolve(parsed['target-dir'] || path.resolve(process.cwd(), pluginName)),
     install: parsed.install,
     build: parsed.build,
@@ -148,6 +152,12 @@ const shouldCopy = (sourcePath) => {
     return true
   }
 
+  for (const skippedPath of SKIP_RELATIVE_PATHS) {
+    if (relativePath === skippedPath || relativePath.startsWith(`${skippedPath}/`)) {
+      return false
+    }
+  }
+
   if (SKIP_RELATIVE_PATHS.has(relativePath)) {
     return false
   }
@@ -200,8 +210,8 @@ const buildGeneratedReadme = (options) => `# ${options.displayName}
 
 - 插件名：\`${options.pluginName}\`
 - Java 包名：\`${options.basePackage}\`
-- UI 路由前缀：\`/${options.pluginName}\`
-- 权限前缀：\`plugin:${options.pluginName}:*\`
+- UI 路由前缀：\`${options.routePrefix}\`
+- 权限前缀：\`${options.permissionPrefix}:*\`
 
 ## 环境要求
 
@@ -234,9 +244,6 @@ pnpm dev
 # 后端单测
 ./gradlew test
 
-# 一致性检查
-node scripts/verify-template.mjs
-
 # 前端检查
 cd ui
 pnpm verify
@@ -253,7 +260,8 @@ cd ..
 
 - 后端先补接口和 Springdoc 注解，再执行 \`./gradlew generateApiClient\`。
 - 前端统一从 \`ui/src/api/index.ts\` 暴露 API，不要在页面里写裸 URL。
-- 如果这个插件不需要 UC、附件扩展或仪表盘部件，尽早裁剪，避免模板示例残留。
+- 通过 \`--route-prefix\` 和 \`--permission-prefix\` 传入的规则已经写入项目，不需要再手工全局替换。
+- 生成项目默认不再附带模板仓库的 \`docs/\` 和 \`scripts/\` 目录，保持业务仓库更轻。
 
 ## 目录说明
 
@@ -264,12 +272,10 @@ cd ..
 - \`ui/src/components/\`：业务级共享组件
 - \`ui/src/api/index.ts\`：前端唯一 API 包装出口
 - \`ui/src/api/generated/\`：由 \`generateApiClient\` 生成并已接入的客户端代码
-- \`docs/rsbuild-switch.md\`：从当前模板切换到 Rsbuild 的最小差异说明
-- \`docs/template-pruning.md\`：初始化后如何裁剪模板能力的操作建议
 
 ## 裁剪模板
 
-如果你只做 Console 页面，或不需要附件扩展、UC 页面，可以参考 [docs/template-pruning.md](./docs/template-pruning.md) 做删减。
+如果你只做 Console 页面，或不需要附件扩展、UC 页面，直接删除对应的 \`ucRoutes\`、扩展点和角色模板即可。
 
 ## 许可证
 
@@ -286,7 +292,7 @@ const writeGeneratedReadme = async (options) => {
 
 const buildInitArgs = (options) => {
   const args = [
-    path.join('scripts', 'init-template.mjs'),
+    path.join(SCRIPT_DIR, 'init-template.mjs'),
     '--plugin-name',
     options.pluginName,
     '--base-package',
@@ -295,6 +301,10 @@ const buildInitArgs = (options) => {
     options.displayName,
     '--author-name',
     options.authorName,
+    '--route-prefix',
+    options.routePrefix,
+    '--permission-prefix',
+    options.permissionPrefix,
   ]
 
   if (options.authorWebsite) {
@@ -312,7 +322,7 @@ const buildInitArgs = (options) => {
 
 const buildVerifyArgs = (options) => {
   const args = [
-    path.join('scripts', 'verify-template.mjs'),
+    path.join(SCRIPT_DIR, 'verify-template.mjs'),
     '--plugin-name',
     options.pluginName,
     '--base-package',
@@ -321,6 +331,10 @@ const buildVerifyArgs = (options) => {
     options.displayName,
     '--author-name',
     options.authorName,
+    '--route-prefix',
+    options.routePrefix,
+    '--permission-prefix',
+    options.permissionPrefix,
   ]
 
   if (options.authorWebsite) {

package/scripts/init-template.mjs

@@ -3,11 +3,23 @@
 import fs from 'node:fs/promises'
 import path from 'node:path'
 import process from 'node:process'
+import {
+  getApiGroupKey,
+  normalizePermissionPrefix,
+  normalizePluginName,
+  normalizeRoutePrefix,
+  reverseBasePackage,
+  slugify,
+  toClassPrefix,
+  toKebabToken,
+} from './lib/template-meta.mjs'
 
 const TEMPLATE = {
   pluginName: 'halo-plugin-template',
   basePackage: 'run.halo.plugintemplate',
   classPrefix: 'PluginTemplate',
+  routePrefix: '/halo-plugin-template',
+  permissionPrefix: 'plugin:halo-plugin-template',
   displayName: 'Halo Plugin Template',
   authorName: 'Template Author',
   authorWebsite: 'https://github.com/example',
@@ -48,36 +60,17 @@ const SKIP_DIRS = new Set([
 const usage = `
 Usage:
   node scripts/init-template.mjs \\
-    --plugin-name hello-world \\
+    --plugin-name todo \\
     --base-package com.example.helloworld \\
-    --display-name "Hello World" \\
+    --display-name "Todo" \\
     --author-name "Your Name" \\
+    [--route-prefix /plugin-todo] \\
+    [--permission-prefix plugin:plugin-todo] \\
     [--author-website "https://github.com/your-name"] \\
     [--repo-owner your-name] \\
-    [--description "Hello World - Halo 插件"]
+    [--description "Todo - Halo 插件"]
 `.trim()
 
-const slugify = (value) =>
-  value
-    .trim()
-    .toLowerCase()
-    .replace(/[^a-z0-9]+/g, '-')
-    .replace(/^-+|-+$/g, '')
-
-const toClassPrefix = (pluginName) => {
-  const parts = pluginName.split(/[^a-zA-Z0-9]+/).filter(Boolean)
-  if (!parts.length) {
-    return 'PluginTemplate'
-  }
-  return parts.map((part) => part.charAt(0).toUpperCase() + part.slice(1)).join('')
-}
-
-const toKebabToken = (value) =>
-  value
-    .replace(/([a-z0-9])([A-Z])/g, '$1-$2')
-    .replace(/[^a-zA-Z0-9]+/g, '-')
-    .toLowerCase()
-
 const parseArgs = (argv) => {
   const parsed = {}
 
@@ -102,10 +95,12 @@ const parseArgs = (argv) => {
   }
 
   return {
-    pluginName: slugify(parsed['plugin-name']),
+    pluginName: normalizePluginName(parsed['plugin-name']),
     basePackage: parsed['base-package'].trim(),
     displayName: parsed['display-name'].trim(),
     authorName: parsed['author-name'].trim(),
+    routePrefix: normalizeRoutePrefix(parsed['route-prefix'], normalizePluginName(parsed['plugin-name'])),
+    permissionPrefix: normalizePermissionPrefix(parsed['permission-prefix'], normalizePluginName(parsed['plugin-name'])),
     authorWebsite: parsed['author-website']?.trim() || '',
     repoOwner: parsed['repo-owner']?.trim() || '',
     description: parsed.description?.trim() || '',
@@ -168,7 +163,33 @@ const pruneEmptyDirectories = async (startPath, stopPath) => {
   }
 }
 
-const renamePackageDirectory = async (sourceRoot, targetRoot) => {
+const pruneEmptyDirectoriesRecursively = async (directory, stopPath) => {
+  let entries
+
+  try {
+    entries = await fs.readdir(directory, { withFileTypes: true })
+  } catch {
+    return
+  }
+
+  for (const entry of entries) {
+    if (!entry.isDirectory()) {
+      continue
+    }
+    await pruneEmptyDirectoriesRecursively(path.join(directory, entry.name), stopPath)
+  }
+
+  if (directory === stopPath) {
+    return
+  }
+
+  const remainingEntries = await fs.readdir(directory)
+  if (remainingEntries.length === 0) {
+    await fs.rmdir(directory)
+  }
+}
+
+const renamePackageDirectory = async (sourceRoot, targetRoot, pruneStopPath) => {
   try {
     await fs.access(sourceRoot)
   } catch {
@@ -177,7 +198,7 @@ const renamePackageDirectory = async (sourceRoot, targetRoot) => {
 
   await fs.mkdir(path.dirname(targetRoot), { recursive: true })
   await fs.rename(sourceRoot, targetRoot)
-  await pruneEmptyDirectories(path.dirname(sourceRoot), path.dirname(path.dirname(sourceRoot)))
+  await pruneEmptyDirectories(path.dirname(sourceRoot), pruneStopPath)
 }
 
 const collectRenameTargets = async (directory, token, result = []) => {
@@ -221,6 +242,10 @@ const main = async () => {
     const authorWebsite = options.authorWebsite || `https://github.com/${repoOwner}`
     const description = options.description || `${options.displayName} - Halo 插件`
     const nextPackagePath = options.basePackage.split('.').join('/')
+    const templateApiGroup = reverseBasePackage(TEMPLATE.basePackage)
+    const nextApiGroup = reverseBasePackage(options.basePackage)
+    const templateApiGroupKey = getApiGroupKey(TEMPLATE.basePackage)
+    const nextApiGroupKey = getApiGroupKey(options.basePackage)
 
     const replacements = [
       [
@@ -242,6 +267,11 @@ const main = async () => {
       [TEMPLATE.authorWebsite, authorWebsite],
       [TEMPLATE_PACKAGE_PATH, nextPackagePath],
       [TEMPLATE.basePackage, options.basePackage],
+      [TEMPLATE.routePrefix, options.routePrefix],
+      [TEMPLATE.permissionPrefix, options.permissionPrefix],
+      [templateApiGroup, nextApiGroup],
+      [`${templateApiGroupKey}Apis`, `${nextApiGroupKey}Apis`],
+      [`"${templateApiGroupKey}"`, `"${nextApiGroupKey}"`],
       [TEMPLATE.classPrefix, classPrefix],
       [TEMPLATE.displayName, options.displayName],
       [TEMPLATE.description, description],
@@ -258,17 +288,23 @@ const main = async () => {
     await renamePackageDirectory(
       path.join(ROOT, 'src/main/java', TEMPLATE_PACKAGE_PATH),
       path.join(ROOT, 'src/main/java', nextPackagePath),
+      path.join(ROOT, 'src/main/java'),
     )
     await renamePackageDirectory(
       path.join(ROOT, 'src/test/java', TEMPLATE_PACKAGE_PATH),
       path.join(ROOT, 'src/test/java', nextPackagePath),
+      path.join(ROOT, 'src/test/java'),
     )
+    await pruneEmptyDirectoriesRecursively(path.join(ROOT, 'src/main/java'), path.join(ROOT, 'src/main/java'))
+    await pruneEmptyDirectoriesRecursively(path.join(ROOT, 'src/test/java'), path.join(ROOT, 'src/test/java'))
     await renameClassPrefixPaths(ROOT, TEMPLATE.classPrefix, classPrefix)
     await renameClassPrefixPaths(ROOT, templateClassPrefixKebab, classPrefixKebab)
 
     console.log(`Initialized template as ${options.pluginName}`)
     console.log(`Base package: ${options.basePackage}`)
     console.log(`Class prefix: ${classPrefix}`)
+    console.log(`Route prefix: ${options.routePrefix}`)
+    console.log(`Permission prefix: ${options.permissionPrefix}`)
     console.log(`Repository owner: ${repoOwner}`)
   } catch (error) {
     console.error(error instanceof Error ? error.message : String(error))

package/scripts/lib/template-meta.mjs

@@ -0,0 +1,64 @@
+export const slugify = (value) =>
+  value
+    .trim()
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, '-')
+    .replace(/^-+|-+$/g, '')
+
+export const normalizePluginName = (value) => {
+  const slug = slugify(value)
+
+  if (!slug) {
+    return ''
+  }
+
+  if (slug.startsWith('halo-plugin-')) {
+    return `plugin-${slug.slice('halo-plugin-'.length)}`
+  }
+
+  if (slug.startsWith('plugin-')) {
+    return slug
+  }
+
+  return `plugin-${slug}`
+}
+
+export const normalizeRoutePrefix = (value, pluginName) => {
+  const raw = (value?.trim() || `/${pluginName}`).replace(/^\/+/, '')
+  if (!raw) {
+    return '/'
+  }
+  return `/${raw.replace(/\/+$/, '')}`
+}
+
+export const normalizePermissionPrefix = (value, pluginName) =>
+  (value?.trim() || `plugin:${pluginName}`).replace(/:+$/, '')
+
+export const toClassPrefix = (pluginName) => {
+  const parts = pluginName.split(/[^a-zA-Z0-9]+/).filter(Boolean)
+  if (!parts.length) {
+    return 'PluginTemplate'
+  }
+  return parts.map((part) => part.charAt(0).toUpperCase() + part.slice(1)).join('')
+}
+
+export const toKebabToken = (value) =>
+  value
+    .replace(/([a-z0-9])([A-Z])/g, '$1-$2')
+    .replace(/[^a-zA-Z0-9]+/g, '-')
+    .toLowerCase()
+
+export const reverseBasePackage = (basePackage) =>
+  basePackage
+    .split('.')
+    .map((segment) => segment.trim())
+    .filter(Boolean)
+    .reverse()
+    .join('.')
+
+export const getApiGroupKey = (basePackage) =>
+  basePackage
+    .split('.')
+    .map((segment) => segment.trim())
+    .filter(Boolean)
+    .at(-1) || 'plugin'

package/scripts/verify-template.mjs

@@ -9,7 +9,6 @@ const REQUIRED_FILES = [
   'README.md',
   'build.gradle',
   'settings.gradle',
-  'scripts/init-template.mjs',
   'src/main/resources/plugin.yaml',
   'src/main/resources/extensions/settings.yaml',
   'src/main/resources/extensions/roleTemplate-console.yaml',
@@ -17,8 +16,6 @@ const REQUIRED_FILES = [
   'ui/src/index.ts',
   'ui/src/api/index.ts',
   'ui/src/api/generated/index.ts',
-  'docs/rsbuild-switch.md',
-  'docs/template-pruning.md',
 ]
 const TEXT_EXTENSIONS = new Set([
   '.md',
@@ -59,13 +56,15 @@ Usage:
   node scripts/verify-template.mjs
 
   node scripts/verify-template.mjs \\
-    --plugin-name hello-world \\
+    --plugin-name todo \\
     --base-package com.example.helloworld \\
-    --display-name "Hello World" \\
+    --display-name "Todo" \\
     --author-name "Your Name" \\
+    [--route-prefix /plugin-todo] \\
+    [--permission-prefix plugin:plugin-todo] \\
     [--author-website "https://github.com/your-name"] \\
     [--repo-owner your-name] \\
-    [--description "Hello World - Halo 插件"]
+    [--description "Todo - Halo 插件"]
 `.trim()
 
 const parseArgs = (argv) => {
@@ -252,10 +251,16 @@ const verifyRepo = async (args) => {
   const consolePath = extractJavaConstant(settingKeysContent, 'CONSOLE_PATH')
   const ucPath = extractJavaConstant(settingKeysContent, 'UC_PATH')
   const generatedClientPath = extractJavaConstant(settingKeysContent, 'GENERATED_CLIENT_PATH')
+  const routePrefix = extractJavaConstant(settingKeysContent, 'ROUTE_PREFIX')
+  const configuredPermissionPrefix = extractJavaConstant(settingKeysContent, 'PERMISSION_PREFIX')
+  const apiGroupSuffix = extractJavaConstant(settingKeysContent, 'API_GROUP_SUFFIX')
+  const apiGroupKey = extractJavaConstant(settingKeysContent, 'API_GROUP_KEY')
   const basePackage = extractGradleGroup(buildGradleContent)
   const rootProjectName = extractRootProjectName(settingsGradleContent)
   const packageDirectory = path.posix.join('src/main/java', ...basePackage.split('.'))
-  const permissionPrefix = `plugin:${pluginName}:`
+  const permissionPrefix = `${configuredPermissionPrefix}:`
+  const resolvedConsolePath = consolePath || routePrefix
+  const resolvedUcPath = ucPath || routePrefix
 
   if (!pluginName || !displayName || !basePackage) {
     fail(results, 'Unable to resolve plugin constants from SettingKeys.java or build.gradle')
@@ -280,10 +285,12 @@ const verifyRepo = async (args) => {
   assertContains(results, pluginYamlContent, `displayName: "${displayName}"`, 'plugin.yaml displayName is consistent')
   assertContains(results, settingsYamlContent, `name: ${settingName}`, 'settings.yaml metadata name is consistent')
 
-  assertContains(results, buildGradleContent, `/apis/console.${pluginName}.halo.run/v1alpha1/**`, 'OpenAPI console path matches plugin name')
-  assertContains(results, buildGradleContent, `/apis/uc.${pluginName}.halo.run/v1alpha1/**`, 'OpenAPI UC path matches plugin name')
-  assertContains(results, uiIndexContent, `path: '${consolePath}'`, 'Console route path matches setting constants')
-  assertContains(results, uiIndexContent, `path: '${ucPath}'`, 'UC route path matches setting constants')
+  assertContains(results, buildGradleContent, `/apis/console.${apiGroupSuffix}/v1alpha1/**`, 'OpenAPI console path matches API group suffix')
+  assertContains(results, buildGradleContent, `/apis/uc.${apiGroupSuffix}/v1alpha1/**`, 'OpenAPI UC path matches API group suffix')
+  assertContains(results, buildGradleContent, `/apis/public.${apiGroupSuffix}/v1alpha1/**`, 'OpenAPI public path matches API group suffix')
+  assertContains(results, buildGradleContent, `${apiGroupKey}Apis`, 'OpenAPI group key matches API group key')
+  assertContains(results, uiIndexContent, `path: '${resolvedConsolePath}'`, 'Console route path matches setting constants')
+  assertContains(results, uiIndexContent, `path: '${resolvedUcPath}'`, 'UC route path matches setting constants')
   assertContains(results, uiIndexContent, permissionPrefix, 'UI permissions use the current plugin prefix')
   assertContains(results, providerContent, `${pluginName}-admin-shell`, 'UI provider namespace follows the plugin prefix')
   assertContains(results, uiApiContent, `from '@/api/generated'`, 'UI API wrapper imports from the generated client')
@@ -296,8 +303,15 @@ const verifyRepo = async (args) => {
 
   assertContains(results, consoleRoleTemplateContent, permissionPrefix, 'Console role template uses the plugin permission prefix')
   assertContains(results, ucRoleTemplateContent, permissionPrefix, 'UC role template uses the plugin permission prefix')
-  assertContains(results, readmeContent, 'node scripts/verify-template.mjs', 'README documents the verification command')
-  assertContains(results, readmeContent, 'docs/template-pruning.md', 'README links to the pruning guide')
+  if (readmeContent.includes('node scripts/verify-template.mjs')) {
+    pass(results, 'README documents the verification command')
+  }
+
+  if (!(await exists('docs/template-pruning.md')) || readmeContent.includes('docs/template-pruning.md')) {
+    pass(results, 'README/doc pruning guidance is consistent')
+  } else {
+    fail(results, 'README references are inconsistent with the generated docs layout')
+  }
 
   if (await exists(path.posix.join(generatedClientPath, 'api'))) {
     pass(results, `Generated API directory exists: ${generatedClientPath}/api`)
@@ -329,6 +343,18 @@ const verifyRepo = async (args) => {
     pass(results, `Expected display name matches: ${displayName}`)
   }
 
+  if (args['route-prefix'] && args['route-prefix'] !== routePrefix) {
+    fail(results, `Expected route prefix ${args['route-prefix']}, got ${routePrefix}`)
+  } else if (args['route-prefix']) {
+    pass(results, `Expected route prefix matches: ${routePrefix}`)
+  }
+
+  if (args['permission-prefix'] && args['permission-prefix'] !== configuredPermissionPrefix) {
+    fail(results, `Expected permission prefix ${args['permission-prefix']}, got ${configuredPermissionPrefix}`)
+  } else if (args['permission-prefix']) {
+    pass(results, `Expected permission prefix matches: ${configuredPermissionPrefix}`)
+  }
+
   if (args['author-name']) {
     assertContains(
       results,

package/src/main/java/run/halo/plugintemplate/endpoint/PluginTemplateConsoleEndpoint.java

@@ -9,12 +9,14 @@ import org.springframework.web.reactive.function.server.ServerResponse;
 import run.halo.app.core.extension.endpoint.CustomEndpoint;
 import run.halo.app.extension.GroupVersion;
 import run.halo.plugintemplate.endpoint.routes.PluginTemplateOverviewRoutes;
+import run.halo.plugintemplate.setting.PluginTemplateSettingKeys;
 
 @Component
 @RequiredArgsConstructor
 public class PluginTemplateConsoleEndpoint implements CustomEndpoint {
 
-    public static final String CONSOLE_GROUP_VERSION = "console.halo-plugin-template.halo.run/v1alpha1";
+    public static final String CONSOLE_GROUP_VERSION = "console."
+        + PluginTemplateSettingKeys.API_GROUP_SUFFIX + "/v1alpha1";
     public static final String CONSOLE_TAG = "PluginTemplateConsole";
 
     private final PluginTemplateOverviewRoutes overviewRoutes;

package/src/main/java/run/halo/plugintemplate/endpoint/PluginTemplatePublicEndpoint.java

@@ -5,6 +5,7 @@ import org.springframework.web.reactive.function.server.RouterFunction;
 import org.springframework.web.reactive.function.server.ServerResponse;
 import run.halo.app.core.extension.endpoint.CustomEndpoint;
 import run.halo.app.extension.GroupVersion;
+import run.halo.plugintemplate.setting.PluginTemplateSettingKeys;
 
 /**
  * Public endpoint placeholder.
@@ -12,7 +13,8 @@ import run.halo.app.extension.GroupVersion;
  */
 public class PluginTemplatePublicEndpoint implements CustomEndpoint {
 
-    public static final String PUBLIC_GROUP_VERSION = "public.halo-plugin-template.halo.run/v1alpha1";
+    public static final String PUBLIC_GROUP_VERSION = "public."
+        + PluginTemplateSettingKeys.API_GROUP_SUFFIX + "/v1alpha1";
 
     @Override
     public RouterFunction<ServerResponse> endpoint() {

package/src/main/java/run/halo/plugintemplate/endpoint/PluginTemplateUcEndpoint.java

@@ -9,12 +9,14 @@ import org.springframework.web.reactive.function.server.ServerResponse;
 import run.halo.app.core.extension.endpoint.CustomEndpoint;
 import run.halo.app.extension.GroupVersion;
 import run.halo.plugintemplate.endpoint.routes.PluginTemplateOverviewRoutes;
+import run.halo.plugintemplate.setting.PluginTemplateSettingKeys;
 
 @Component
 @RequiredArgsConstructor
 public class PluginTemplateUcEndpoint implements CustomEndpoint {
 
-    public static final String UC_GROUP_VERSION = "uc.halo-plugin-template.halo.run/v1alpha1";
+    public static final String UC_GROUP_VERSION = "uc."
+        + PluginTemplateSettingKeys.API_GROUP_SUFFIX + "/v1alpha1";
     public static final String UC_TAG = "PluginTemplateUc";
 
     private final PluginTemplateOverviewRoutes overviewRoutes;

package/src/main/java/run/halo/plugintemplate/scheme/PluginTemplateRecord.java

@@ -8,12 +8,13 @@ import lombok.EqualsAndHashCode;
 import lombok.ToString;
 import run.halo.app.extension.AbstractExtension;
 import run.halo.app.extension.GVK;
+import run.halo.plugintemplate.setting.PluginTemplateSettingKeys;
 
 @Data
 @EqualsAndHashCode(callSuper = true)
 @ToString(callSuper = true)
 @GVK(
-    group = "halo-plugin-template.halo.run",
+    group = PluginTemplateSettingKeys.API_GROUP_SUFFIX,
     version = "v1alpha1",
     kind = "PluginTemplateRecord",
     plural = "pluginTemplateRecords",

package/src/main/java/run/halo/plugintemplate/setting/PluginTemplateSettingKeys.java

@@ -6,8 +6,12 @@ public final class PluginTemplateSettingKeys {
     public static final String DISPLAY_NAME = "Halo Plugin Template";
     public static final String SETTING_NAME = "halo-plugin-template-settings";
     public static final String CONFIG_MAP_NAME = "halo-plugin-template-configmap";
-    public static final String CONSOLE_PATH = "/halo-plugin-template";
-    public static final String UC_PATH = "/halo-plugin-template";
+    public static final String ROUTE_PREFIX = "/halo-plugin-template";
+    public static final String PERMISSION_PREFIX = "plugin:halo-plugin-template";
+    public static final String API_GROUP_SUFFIX = "plugintemplate.halo.run";
+    public static final String API_GROUP_KEY = "plugintemplate";
+    public static final String CONSOLE_PATH = ROUTE_PREFIX;
+    public static final String UC_PATH = ROUTE_PREFIX;
     public static final String GENERATED_CLIENT_PATH = "ui/src/api/generated";
     public static final String GENERAL_GROUP = "general";
     public static final String UI_GROUP = "ui";

package/src/main/resources/extensions/roleTemplate-console.yaml

@@ -1,7 +1,7 @@
 kind: Role
 apiVersion: v1alpha1
 metadata:
-  name: rt-console.halo-plugin-template.halo.run-view
+  name: rt-console.plugintemplate.halo.run-view
   labels:
     halo.run/role-template: "true"
   annotations:
@@ -11,7 +11,7 @@ metadata:
     rbac.authorization.halo.run/module: "Halo 插件模板"
 rules:
   - apiGroups:
-      - console.halo-plugin-template.halo.run
+      - console.plugintemplate.halo.run
     resources:
       - template-overview
     verbs:
@@ -21,7 +21,7 @@ rules:
 kind: Role
 apiVersion: v1alpha1
 metadata:
-  name: rt-console.halo-plugin-template.halo.run-manage
+  name: rt-console.plugintemplate.halo.run-manage
   labels:
     halo.run/role-template: "true"
   annotations:
@@ -31,7 +31,7 @@ metadata:
     rbac.authorization.halo.run/module: "Halo 插件模板"
 rules:
   - apiGroups:
-      - console.halo-plugin-template.halo.run
+      - console.plugintemplate.halo.run
     resources:
       - template-overview
     verbs:

package/src/main/resources/extensions/roleTemplate-uc.yaml

@@ -1,7 +1,7 @@
 kind: Role
 apiVersion: v1alpha1
 metadata:
-  name: rt-uc.halo-plugin-template.halo.run-personal
+  name: rt-uc.plugintemplate.halo.run-personal
   labels:
     halo.run/role-template: "true"
   annotations:
@@ -11,7 +11,7 @@ metadata:
     rbac.authorization.halo.run/module: "Halo 插件模板"
 rules:
   - apiGroups:
-      - uc.halo-plugin-template.halo.run
+      - uc.plugintemplate.halo.run
     resources:
       - template-overview
     verbs: