@kite-dev/create-plugin-sdk 0.0.1-beta.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,35 @@
+# Create Kite Plugin
+
+使用 `@clack/prompts` 提供交互向导，创建可在 Kite 中安装的 React/TypeScript 插件。
+
+```sh
+npm create @kite-dev/plugin-sdk@beta my-plugin
+# 或
+pnpm create @kite-dev/plugin-sdk@beta my-plugin
+```
+
+省略 `my-plugin` 时交互输入目录。插件 ID 使用目录名，显示名称可在向导中修改。目录必须为空；已有 Git 仓库的 `.git` 目录可以保留。取消向导不会创建文件。
+
+非交互创建：
+
+```sh
+npm create @kite-dev/plugin-sdk@beta -- my-plugin --yes --display-name "My Plugin"
+pnpm create @kite-dev/plugin-sdk@beta my-plugin --yes --display-name "My Plugin"
+```
+
+生成 `package.json`、TypeScript/Vite 配置、`plugin.config.tsx`、使用宿主 UI 的首页、CSS Modules、README 和 `.gitignore`。页面使用 `React.lazy`，菜单默认挂在 `core:other`。生成器复用已发布 SDK 的清单校验与依赖版本，不使用宿主源码或本地路径依赖。
+
+```sh
+cd my-plugin
+pnpm install
+pnpm run build
+pnpm run pack
+```
+
+然后从 Kite 的插件管理页面上传安装包。`dev` 执行监听构建，页面在 Kite 中运行。
+
+需要 Node.js `^20.19.0 || >=22.12.0`。npm/pnpm 的 `create @kite-dev/plugin-sdk` 会自动寻找本包 `@kite-dev/create-plugin-sdk`；当前使用 `beta` 标签。
+
+## 本地开发与发布
+
+在此目录执行 `npm ci`，然后运行 `node index.js <directory>`。使用 `npm pack` 检查发布包，发布测试版使用 `npm publish --tag beta --access public`。创建器与 SDK 位于同一仓库，分别作为 npm 包发布。

package/index.js

@@ -0,0 +1,152 @@
+#!/usr/bin/env node
+import { cpSync, existsSync, lstatSync, mkdirSync, readdirSync, renameSync, writeFileSync } from 'node:fs'
+import { basename, resolve } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { parseArgs } from 'node:util'
+import * as prompts from '@clack/prompts'
+import sdk from '@kite-dev/plugin-sdk/package.json' with { type: 'json' }
+import { validateManifest } from '@kite-dev/plugin-sdk/validation'
+
+const usage = `Usage: create-plugin-sdk [directory] [options]
+
+Options:
+  --display-name <name>  Plugin display name
+  -y, --yes             Use defaults without prompting
+  -h, --help            Show this help
+
+Examples:
+  npm create @kite-dev/plugin-sdk@beta my-plugin
+  pnpm create @kite-dev/plugin-sdk@beta my-plugin`
+
+function metadataError(id, name) {
+  try {
+    validateManifest({
+      schemaVersion: 1,
+      id,
+      name,
+      version: '0.1.0',
+      requires: { sdk: `^${sdk.version}` },
+      entry: 'mf-manifest.json',
+      module: './plugin',
+      routes: [],
+      menus: [],
+    })
+  } catch (error) {
+    return error.message
+  }
+}
+
+function directoryError(directory) {
+  const target = resolve(directory)
+  const error = metadataError(basename(target), 'Plugin')
+  if (error) return error
+  if (existsSync(target)) {
+    if (!lstatSync(target).isDirectory()) return 'The target path must be a directory.'
+    if (readdirSync(target).some((entry) => entry !== '.git')) return 'The target directory is not empty. Choose an empty directory.'
+  }
+}
+
+async function main() {
+  const { values, positionals } = parseArgs({
+    allowPositionals: true,
+    options: {
+      'display-name': { type: 'string' },
+      yes: { type: 'boolean', short: 'y', default: false },
+      help: { type: 'boolean', short: 'h', default: false },
+    },
+  })
+  if (values.help) {
+    console.log(usage)
+    return
+  }
+  if (positionals.length > 1) throw new Error(usage)
+  const interactive = process.stdin.isTTY && process.stdout.isTTY && !values.yes
+  if (!interactive && !positionals[0] && !values.yes) {
+    throw new Error('Specify a project directory or use --yes to create my-plugin.')
+  }
+  if (positionals[0]) {
+    const error = directoryError(positionals[0])
+    if (error) throw new Error(error)
+  }
+
+  prompts.intro('Create a Kite plugin')
+  const answers = await prompts.group({
+    directory: async () => positionals[0] ?? (interactive
+      ? prompts.text({
+          message: 'Project directory',
+          initialValue: 'my-plugin',
+          validate: (value) => value?.trim() ? directoryError(value.trim()) : 'Enter a project directory.',
+        })
+      : 'my-plugin'),
+    displayName: async ({ results }) => values['display-name'] ?? (interactive
+      ? prompts.text({
+          message: 'Plugin display name',
+          initialValue: basename(resolve(results.directory.trim())),
+          validate: (value) => metadataError(basename(resolve(results.directory.trim())), value?.trim()),
+        })
+      : basename(resolve(results.directory.trim()))),
+  }, {
+    onCancel: () => {
+      prompts.cancel('Plugin creation cancelled.')
+      process.exit(0)
+    },
+  })
+
+  const directory = answers.directory.trim()
+  const target = resolve(directory)
+  const id = basename(target)
+  const displayName = answers.displayName.trim()
+  const error = directoryError(directory) ?? metadataError(id, displayName)
+  if (error) throw new Error(error)
+
+  const metadata = {
+    name: id,
+    displayName,
+    version: '0.1.0',
+    private: true,
+    type: 'module',
+    license: 'Apache-2.0',
+    description: '',
+    scripts: {
+      'type-check': 'tsc --noEmit',
+      build: 'tsc --noEmit && vite build',
+      dev: 'vite build --watch',
+      pack: 'kite-plugin pack',
+    },
+    dependencies: {
+      [sdk.name]: sdk.version,
+      react: sdk.peerDependencies.react,
+      'react-dom': sdk.peerDependencies['react-dom'],
+      'react-router-dom': sdk.peerDependencies['react-router-dom'],
+    },
+    devDependencies: {
+      '@types/node': sdk.devDependencies['@types/node'],
+      '@types/react': sdk.devDependencies['@types/react'],
+      '@types/react-dom': sdk.devDependencies['@types/react-dom'],
+      typescript: sdk.devDependencies.typescript,
+      vite: sdk.peerDependencies.vite,
+    },
+  }
+  mkdirSync(target, { recursive: true })
+  cpSync(fileURLToPath(new URL('./template', import.meta.url)), target, {
+    recursive: true,
+    force: false,
+    errorOnExist: true,
+  })
+  renameSync(resolve(target, '_gitignore'), resolve(target, '.gitignore'))
+  writeFileSync(resolve(target, 'package.json'), `${JSON.stringify(metadata, null, 2)}\n`, { flag: 'wx' })
+
+  const manager = process.env.npm_config_user_agent?.startsWith('pnpm/') ? 'pnpm' : 'npm'
+  prompts.note([
+    `cd '${directory.replaceAll("'", "'\\''")}'`,
+    `${manager} install`,
+    `${manager} run build`,
+    `${manager} run pack`,
+  ].join('\n'), 'Next steps')
+  prompts.outro(`Created ${displayName}. Upload the built archive in Kite → Plugin management.`)
+}
+
+main().catch((error) => {
+  prompts.log.error(error.message)
+  process.exitCode = 1
+})

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@kite-dev/create-plugin-sdk",
+  "version": "0.0.1-beta.0",
+  "description": "Create a Kite frontend plugin",
+  "type": "module",
+  "license": "Apache-2.0",
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "bin": {
+    "create-plugin-sdk": "./index.js"
+  },
+  "files": [
+    "index.js",
+    "template",
+    "README.md"
+  ],
+  "dependencies": {
+    "@clack/prompts": "1.8.0",
+    "@kite-dev/plugin-sdk": "0.0.1-beta.0"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public",
+    "tag": "beta"
+  }
+}

package/template/README.md

@@ -0,0 +1,20 @@
+# Kite Plugin
+
+在生成的插件目录安装依赖、构建并打包：
+
+```sh
+npm install
+npm run build
+npm run pack
+```
+
+打包后得到 `<插件 ID>-<版本>.tar.gz`。在 Kite 头像菜单进入「插件」，上传安装包；启用后可在「其他」分组打开插件首页。
+
+- `package.json`：插件 ID、展示名称、版本和依赖。首页标题及菜单名称复用 `displayName`。
+- `plugin.config.tsx`：使用 `definePlugin` 注册路由和菜单，直接绑定 JSX。
+- `src/pages/home.tsx`：首页复用宿主 UI、语言、集群和命名空间上下文。
+- `src/pages/home.module.css`：插件自身布局样式。
+
+SDK 构建时自动生成导航清单；页面使用 `React.lazy`，首次访问时才加载。配置需要能在 Node 中执行，CSS、浏览器 API 和页面依赖留在 lazy 导入的页面模块中。
+
+插件需要在兼容的 Kite 宿主中运行，没有独立的开发网页。修改后重新构建、打包并安装；更新已安装插件时先递增 `package.json` 的版本。

package/template/_gitignore

@@ -0,0 +1,3 @@
+node_modules/
+dist/
+*.tar.gz

package/template/plugin.config.tsx

@@ -0,0 +1,20 @@
+import { lazy } from 'react'
+import { definePlugin } from '@kite-dev/plugin-sdk'
+import { displayName } from './package.json'
+
+const HomePage = lazy(() => import('./src/pages/home'))
+
+export default definePlugin({
+  routes: [
+    { id: 'home', path: '', title: displayName, element: <HomePage /> },
+  ],
+  menus: [
+    {
+      id: 'home',
+      parent: 'core:other',
+      label: displayName,
+      route: 'home',
+      icon: 'IconBox',
+    },
+  ],
+})

package/template/src/pages/home.module.css

@@ -0,0 +1,19 @@
+.page {
+  padding: 1.5rem;
+}
+
+.context {
+  display: grid;
+  grid-template-columns: max-content minmax(0, 1fr);
+  gap: 0.75rem 1.5rem;
+  margin: 0;
+}
+
+.context dt {
+  color: var(--muted-foreground);
+}
+
+.context dd {
+  margin: 0;
+  overflow-wrap: anywhere;
+}

package/template/src/pages/home.tsx

@@ -0,0 +1,30 @@
+import { useCluster, useNamespace } from '@kite-dev/plugin-sdk'
+import { usePluginTranslation } from '@kite-dev/plugin-sdk/i18n'
+import { Card, CardContent, CardDescription, CardHeader, CardTitle } from '@kite-dev/plugin-sdk/ui'
+import { displayName } from '../../package.json'
+import styles from './home.module.css'
+
+export default function HomePage() {
+  const { currentCluster } = useCluster()
+  const { namespace } = useNamespace()
+  const { t } = usePluginTranslation()
+
+  return (
+    <main className={styles.page}>
+      <Card>
+        <CardHeader>
+          <CardTitle>{displayName}</CardTitle>
+          <CardDescription>{t({ en: 'Current Kite context', zh: '当前 Kite 上下文' })}</CardDescription>
+        </CardHeader>
+        <CardContent>
+          <dl className={styles.context}>
+            <dt>{t({ en: 'Cluster', zh: '集群' })}</dt>
+            <dd>{currentCluster ?? '—'}</dd>
+            <dt>{t({ en: 'Namespace', zh: '命名空间' })}</dt>
+            <dd>{namespace === '_all' ? t({ en: 'All namespaces', zh: '全部命名空间' }) : namespace}</dd>
+          </dl>
+        </CardContent>
+      </Card>
+    </main>
+  )
+}

package/template/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "jsx": "react-jsx",
+    "strict": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "types": ["vite/client"],
+    "noEmit": true
+  },
+  "include": ["src", "plugin.config.tsx", "vite.config.ts"]
+}

package/template/vite.config.ts

@@ -0,0 +1,4 @@
+import { defineConfig } from 'vite'
+import { kitePlugin } from '@kite-dev/plugin-sdk/vite'
+
+export default defineConfig(kitePlugin())