npm - @wneng/create-keel - Versions diffs - 0.1.0 - Mend

@wneng/create-keel 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (230) hide show

package/src/templates/server-node/files/README.md ADDED Viewed

@@ -0,0 +1,6 @@
+# server/
+Backend service for **<%= it.options.projectName %>**.
+Contract-first: implementation must match `contracts/openapi/api.yaml`.
+Generated code lives in `generated/` and must not be hand-edited.

package/src/templates/server-node/files/generated-gitkeep ADDED Viewed

File without changes

package/src/templates/server-node/files/package.json ADDED Viewed

@@ -0,0 +1,9 @@
+{
+  "name": "<%= it.options.projectName %>-server",
+  "version": "0.1.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "start": "node src/index.js"
+  }
+}

package/src/templates/server-node/files/src-index.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ // Entry point. Implement per the OpenAPI contract under contracts/openapi/api.yaml.
2	+ console.log('server placeholder');

package/src/templates/server-node/fragment.yaml ADDED Viewed

@@ -0,0 +1,18 @@
+name: server-node
+version: 1.0.0
+appliesWhen:
+  backend: node
+priority: 30
+files:
+  - from: files/README.md
+    to: server/README.md
+    render: true
+  - from: files/package.json
+    to: server/package.json
+    render: true
+  - from: files/src-index.ts
+    to: server/src/index.ts
+    render: false
+  - from: files/generated-gitkeep
+    to: server/generated/.gitkeep
+    render: false

package/src/templates/server-python/files/README.md ADDED Viewed

@@ -0,0 +1,4 @@
+# server/
+Python backend for **<%= it.options.projectName %>**. Contract-first; see
+`contracts/openapi/api.yaml` for the authoritative API definition.

package/src/templates/server-python/files/app-init.py ADDED Viewed

	@@ -0,0 +1 @@
1	+ """Package marker. Implement per contracts/openapi/api.yaml."""

package/src/templates/server-python/files/generated-gitkeep ADDED Viewed

File without changes

package/src/templates/server-python/files/pyproject.toml ADDED Viewed

@@ -0,0 +1,5 @@
+[project]
+name = "<%= it.options.projectName %>-server"
+version = "0.1.0"
+requires-python = ">=3.11"
+dependencies = []

package/src/templates/server-python/fragment.yaml ADDED Viewed

@@ -0,0 +1,18 @@
+name: server-python
+version: 1.0.0
+appliesWhen:
+  backend: python
+priority: 30
+files:
+  - from: files/README.md
+    to: server/README.md
+    render: true
+  - from: files/pyproject.toml
+    to: server/pyproject.toml
+    render: true
+  - from: files/app-init.py
+    to: server/app/__init__.py
+    render: false
+  - from: files/generated-gitkeep
+    to: server/generated/.gitkeep
+    render: false

package/src/templates/web-react/files/README.md ADDED Viewed

@@ -0,0 +1,29 @@
+# <%= it.options.projectName %>-web
+Frontend scaffold (Vite + React 18 + AntD 5).
+## Stack
+- React 18.3
+- Vite 5
+- AntD 5（中文 locale 默认启用）
+- React Router 6
+- axios（与后端通信）
+- TypeScript 5
+## Development
+```bash
+npm install
+npm run dev          # http://localhost:5173 ; /api 反代到后端 8080
+npm run build
+npm run preview
+```
+## Conventions
+- 与后端契约交互：所有 HTTP 调用走 `axios` instance（base path `/api`），由 `vite.config.ts` 反代到 `http://localhost:8080`
+- 页面级模块：建议按 `src/pages/<feature>/` 组织
+- 共享组件：`src/components/`
+- API 客户端：`src/api/`，按特性拆分（每个 OpenAPI tag 一份）
+- AntD 全局配置：`src/main.tsx` 中的 `<ConfigProvider>`

package/src/templates/web-react/files/generated-gitkeep ADDED Viewed

File without changes

package/src/templates/web-react/files/index.html ADDED Viewed

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="zh-CN">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title><%= it.options.projectName %></title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>

package/src/templates/web-react/files/package.json ADDED Viewed

@@ -0,0 +1,25 @@
+{
+  "name": "<%= it.options.projectName %>-web",
+  "version": "0.1.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc -b && vite build",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "antd": "^5.21.0",
+    "axios": "^1.7.7",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-router-dom": "^6.27.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.3.10",
+    "@types/react-dom": "^18.3.0",
+    "@vitejs/plugin-react": "^4.3.1",
+    "typescript": "^5.6.2",
+    "vite": "^5.4.8"
+  }
+}

package/src/templates/web-react/files/src-App.tsx ADDED Viewed

@@ -0,0 +1,11 @@
+import { Result } from 'antd';
+export default function App() {
+  return (
+    <Result
+      status="success"
+      title="<%= it.options.projectName %> web"
+      subTitle="Vite + React + AntD scaffold ready. Implement contracts/ first, then build features here."
+    />
+  );
+}

package/src/templates/web-react/files/src-main.tsx ADDED Viewed

@@ -0,0 +1,14 @@
+import { StrictMode } from 'react';
+import { createRoot } from 'react-dom/client';
+import { ConfigProvider } from 'antd';
+import zhCN from 'antd/locale/zh_CN';
+import 'antd/dist/reset.css';
+import App from './App';
+createRoot(document.getElementById('root')!).render(
+  <StrictMode>
+    <ConfigProvider locale={zhCN}>
+      <App />
+    </ConfigProvider>
+  </StrictMode>,
+);

package/src/templates/web-react/files/tsconfig.json ADDED Viewed

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "useDefineForClassFields": true,
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "skipLibCheck": true,
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "react-jsx",
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "include": ["src"]
+}

package/src/templates/web-react/files/vite.config.ts ADDED Viewed

@@ -0,0 +1,15 @@
+import { defineConfig } from 'vite';
+import react from '@vitejs/plugin-react';
+export default defineConfig({
+  plugins: [react()],
+  server: {
+    port: 5173,
+    proxy: {
+      '/api': {
+        target: 'http://localhost:8080',
+        changeOrigin: true,
+      },
+    },
+  },
+});

package/src/templates/web-react/fragment.yaml ADDED Viewed

@@ -0,0 +1,30 @@
+name: web-react
+version: 1.1.0
+appliesWhen:
+  frontend: react
+priority: 30
+files:
+  - from: files/README.md
+    to: web/README.md
+    render: true
+  - from: files/package.json
+    to: web/package.json
+    render: true
+  - from: files/index.html
+    to: web/index.html
+    render: true
+  - from: files/vite.config.ts
+    to: web/vite.config.ts
+    render: false
+  - from: files/tsconfig.json
+    to: web/tsconfig.json
+    render: false
+  - from: files/src-main.tsx
+    to: web/src/main.tsx
+    render: false
+  - from: files/src-App.tsx
+    to: web/src/App.tsx
+    render: true
+  - from: files/generated-gitkeep
+    to: web/generated/.gitkeep
+    render: false

package/src/templates/web-vue/files/README.md ADDED Viewed

@@ -0,0 +1,3 @@
+# web/
+Vue frontend for **<%= it.options.projectName %>**.

package/src/templates/web-vue/files/generated-gitkeep ADDED Viewed

File without changes

package/src/templates/web-vue/files/index.html ADDED Viewed

@@ -0,0 +1,11 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title><%= it.options.projectName %></title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>

package/src/templates/web-vue/files/package.json ADDED Viewed

@@ -0,0 +1,9 @@
+{
+  "name": "<%= it.options.projectName %>-web",
+  "version": "0.1.0",
+  "private": true,
+  "type": "module",
+  "dependencies": {
+    "vue": "3.4.27"
+  }
+}

package/src/templates/web-vue/files/src-main.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { createApp, h } from 'vue';
+createApp({ render: () => h('h1', 'hello') }).mount('#app');

package/src/templates/web-vue/fragment.yaml ADDED Viewed

@@ -0,0 +1,21 @@
+name: web-vue
+version: 1.0.0
+appliesWhen:
+  frontend: vue
+priority: 30
+files:
+  - from: files/README.md
+    to: web/README.md
+    render: true
+  - from: files/package.json
+    to: web/package.json
+    render: true
+  - from: files/index.html
+    to: web/index.html
+    render: true
+  - from: files/src-main.ts
+    to: web/src/main.ts
+    render: false
+  - from: files/generated-gitkeep
+    to: web/generated/.gitkeep
+    render: false