@wneng/create-keel 0.3.0 → 0.3.3

package/src/templates/root-files/files/CODEOWNERS

@@ -0,0 +1,40 @@
+# CODEOWNERS — review routing for <%= it.options.projectName %>
+#
+# Format: path-pattern  @owner1 @owner2
+# - Match order matters: later rules override earlier ones.
+# - Replace placeholder owners (`@TBD`) with real Git accounts before
+#   the first PR. CI rejects merging when CODEOWNERS still contains @TBD.
+#
+# References:
+# - AGENTS.md §3.1 (PR review obligations)
+# - docs/governance/git-workflow.md (PR template + CODEOWNERS rules)
+
+# Default owner for everything not matched below.
+*                                       @TBD
+
+# Architecture and contracts: high-impact paths require named reviewers.
+/AGENTS.md                              @TBD
+/contracts/                             @TBD
+/docs/02-系统方案与架构/                @TBD
+/docs/governance/                       @TBD
+
+# Per-execution-environment routing (placeholders; adjust per team).
+/server/                                @TBD
+/web/                                   @TBD
+<% if (it.options.mobile !== 'none') { %>/mobile/                                @TBD
+<% } %><% if (it.options.miniapp !== 'none') { %>/miniapp/                               @TBD
+<% } %><% if (it.options.agent !== 'none') { %>/agent/                                 @TBD
+<% } %>
+
+# Operations & deployment.
+/ops/                                   @TBD
+/deploy/                                @TBD
+
+# CI configuration.
+<% if (it.options.ci === 'github') { %>/.github/                               @TBD
+<% } else if (it.options.ci === 'gitee') { %>/.gitee/                                @TBD
+<% } %>
+
+# Tooling.
+/tools/                                 @TBD
+/scripts/                               @TBD

package/src/templates/root-files/fragment.yaml

@@ -18,3 +18,6 @@ files:
   - from: files/.editorconfig
     to: .editorconfig
     render: false
+  - from: files/CODEOWNERS
+    to: CODEOWNERS
+    render: true

package/src/templates/server-go/files/_golangci.yml

@@ -0,0 +1,41 @@
+# golangci-lint config for <%= it.options.projectName %>-server.
+# Source of truth referenced by docs/03-工程规范与研发基础设施/coding-style-go.md.
+# CI runs `golangci-lint run` and aborts on errors.
+
+run:
+  timeout: 3m
+  tests: true
+
+linters:
+  disable-all: true
+  enable:
+    - errcheck
+    - gosimple
+    - govet
+    - ineffassign
+    - staticcheck
+    - unused
+    - revive
+    - gofmt
+    - goimports
+    - misspell
+    - unconvert
+    - nakedret
+
+linters-settings:
+  revive:
+    rules:
+      - name: package-comments
+      - name: exported
+        arguments: ['checkPrivateReceivers', 'sayRepetitiveInsteadOfStutters']
+  goimports:
+    local-prefixes: example.com
+
+issues:
+  exclude-use-default: false
+  max-issues-per-linter: 0
+  max-same-issues: 0
+  exclude-rules:
+    - path: _test\.go
+      linters:
+        - errcheck

package/src/templates/server-go/fragment.yaml

@@ -1,5 +1,5 @@
 name: server-go
-version: 1.0.0
+version: 1.1.0
 appliesWhen:
   backend: go
 priority: 30
@@ -13,6 +13,9 @@ files:
   - from: files/main.go
     to: server/cmd/server/main.go
     render: false
+  - from: files/_golangci.yml
+    to: server/.golangci.yml
+    render: true
   - from: files/generated-gitkeep
     to: server/generated/.gitkeep
     render: false

package/src/templates/server-java/files/checkstyle.xml

@@ -0,0 +1,62 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC
+    "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+    "https://checkstyle.org/dtds/configuration_1_3.dtd">
+<!--
+  Checkstyle config for <%= it.options.projectName %>-server.
+  Source of truth referenced by:
+    docs/03-工程规范与研发基础设施/coding-style-java.md
+
+  Tweak rules with care. CI runs `mvn verify` which invokes
+  `maven-checkstyle-plugin` and aborts on errors.
+-->
+<module name="Checker">
+  <property name="charset" value="UTF-8"/>
+  <property name="severity" value="error"/>
+  <property name="fileExtensions" value="java, properties, xml"/>
+
+  <module name="FileTabCharacter">
+    <property name="eachLine" value="true"/>
+  </module>
+
+  <module name="LineLength">
+    <property name="max" value="120"/>
+    <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
+  </module>
+
+  <module name="TreeWalker">
+    <!-- Imports -->
+    <module name="AvoidStarImport"/>
+    <module name="UnusedImports"/>
+
+    <!-- Naming -->
+    <module name="PackageName">
+      <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
+    </module>
+    <module name="TypeName"/>
+    <module name="MethodName"/>
+    <module name="LocalVariableName"/>
+    <module name="ConstantName"/>
+
+    <!-- Whitespace / blocks -->
+    <module name="EmptyBlock"/>
+    <module name="LeftCurly"/>
+    <module name="RightCurly"/>
+    <module name="NeedBraces"/>
+
+    <!-- JavaDoc on public types and methods -->
+    <module name="MissingJavadocType">
+      <property name="scope" value="public"/>
+    </module>
+    <module name="JavadocMethod">
+      <property name="accessModifiers" value="public"/>
+    </module>
+
+    <!-- Misc -->
+    <module name="ModifierOrder"/>
+    <module name="RedundantModifier"/>
+    <module name="MissingSwitchDefault"/>
+    <module name="EqualsHashCode"/>
+    <module name="StringLiteralEquality"/>
+  </module>
+</module>

package/src/templates/server-java/files/pom.xml

@@ -92,6 +92,63 @@
                 <groupId>org.springframework.boot</groupId>
                 <artifactId>spring-boot-maven-plugin</artifactId>
             </plugin>
+
+            <!--
+                Checkstyle: enforces naming, structure, JavaDoc rules from
+                docs/03-工程规范与研发基础设施/coding-style-java.md.
+                Aborts the build on violations during `mvn verify`.
+            -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-checkstyle-plugin</artifactId>
+                <version>3.5.0</version>
+                <configuration>
+                    <configLocation>checkstyle.xml</configLocation>
+                    <consoleOutput>true</consoleOutput>
+                    <failsOnError>true</failsOnError>
+                    <linkXRef>false</linkXRef>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>verify-checkstyle</id>
+                        <phase>verify</phase>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+
+            <!--
+                Spotless: format checker (Google Java Format AOSP style).
+                `mvn spotless:check` is wired into verify; run
+                `mvn spotless:apply` locally to auto-format.
+            -->
+            <plugin>
+                <groupId>com.diffplug.spotless</groupId>
+                <artifactId>spotless-maven-plugin</artifactId>
+                <version>2.43.0</version>
+                <configuration>
+                    <java>
+                        <googleJavaFormat>
+                            <version>1.22.0</version>
+                            <style>AOSP</style>
+                        </googleJavaFormat>
+                        <removeUnusedImports/>
+                        <trimTrailingWhitespace/>
+                        <endWithNewline/>
+                    </java>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>verify-spotless</id>
+                        <phase>verify</phase>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 </project>

package/src/templates/server-java/fragment.yaml

@@ -1,5 +1,5 @@
 name: server-java
-version: 1.1.0
+version: 1.2.0
 appliesWhen:
   backend: java
 priority: 30
@@ -19,6 +19,9 @@ files:
   - from: files/application-test.yaml
     to: server/src/test/resources/application-test.yaml
     render: false
+  - from: files/checkstyle.xml
+    to: server/checkstyle.xml
+    render: true
   - from: files/generated-gitkeep
     to: server/generated/.gitkeep
     render: false

package/src/templates/server-node/files/_eslintrc.cjs

@@ -0,0 +1,20 @@
+/**
+ * ESLint configuration for the Node + TypeScript server.
+ *
+ * Source of truth referenced by:
+ *   docs/03-工程规范与研发基础设施/coding-style-typescript.md
+ */
+module.exports = {
+  root: true,
+  env: { node: true, es2022: true },
+  parser: '@typescript-eslint/parser',
+  parserOptions: { ecmaVersion: 2022, sourceType: 'module' },
+  plugins: ['@typescript-eslint'],
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+  rules: {
+    '@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
+    '@typescript-eslint/no-explicit-any': 'warn',
+    '@typescript-eslint/consistent-type-imports': 'warn',
+  },
+  ignorePatterns: ['dist', 'node_modules', 'generated'],
+};

package/src/templates/server-node/files/_prettierrc

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc",
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "bracketSpacing": true,
+  "arrowParens": "always",
+  "endOfLine": "lf"
+}

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

@@ -4,6 +4,19 @@
   "private": true,
   "type": "module",
   "scripts": {
-    "start": "node src/index.js"
+    "start": "node src/index.js",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --ext .ts",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "format:check": "prettier --check \"src/**/*.ts\"",
+    "test": "echo \"add tests with vitest or jest\" && exit 0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.10",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
+    "eslint": "^8.57.0",
+    "prettier": "^3.3.3",
+    "typescript": "^5.5.4"
   }
 }

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

@@ -1,5 +1,5 @@
 name: server-node
-version: 1.0.0
+version: 1.1.0
 appliesWhen:
   backend: node
 priority: 30
@@ -13,6 +13,12 @@ files:
   - from: files/src-index.ts
     to: server/src/index.ts
     render: false
+  - from: files/_eslintrc.cjs
+    to: server/.eslintrc.cjs
+    render: false
+  - from: files/_prettierrc
+    to: server/.prettierrc
+    render: false
   - from: files/generated-gitkeep
     to: server/generated/.gitkeep
     render: false

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

@@ -3,3 +3,47 @@ name = "<%= it.options.projectName %>-server"
 version = "0.1.0"
 requires-python = ">=3.11"
 dependencies = []
+
+[project.optional-dependencies]
+dev = [
+  "ruff>=0.6.8",
+  "mypy>=1.11.0",
+  "pytest>=8.3.0",
+  "pip-audit>=2.7.0",
+]
+
+# ruff: linter + formatter (single-tool replacement for black + isort + flake8).
+# Source of truth referenced by docs/03-工程规范与研发基础设施/coding-style-python.md.
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+extend-exclude = ["generated", ".venv"]
+
+[tool.ruff.lint]
+select = [
+  "E",   # pycodestyle errors
+  "F",   # pyflakes
+  "W",   # pycodestyle warnings
+  "I",   # isort
+  "B",   # flake8-bugbear
+  "UP",  # pyupgrade
+  "N",   # pep8-naming
+]
+ignore = []
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "lf"
+
+# mypy: strict-ish type checking. Adjust per module if a 3rd-party
+# library has poor stubs.
+[tool.mypy]
+python_version = "3.11"
+strict_optional = true
+disallow_untyped_defs = true
+warn_unused_ignores = true
+exclude = ["generated", ".venv"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

package/src/templates/web-react/files/_eslintrc.cjs

@@ -0,0 +1,34 @@
+/**
+ * ESLint configuration for the React + TypeScript web app.
+ *
+ * Source of truth referenced by:
+ *   docs/03-工程规范与研发基础设施/coding-style-typescript.md
+ *
+ * Adjust rules with care; CI runs `eslint .` and aborts on errors.
+ */
+module.exports = {
+  root: true,
+  env: { browser: true, es2022: true },
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 2022,
+    sourceType: 'module',
+    ecmaFeatures: { jsx: true },
+  },
+  plugins: ['@typescript-eslint', 'react', 'react-hooks'],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:react/recommended',
+    'plugin:react-hooks/recommended',
+  ],
+  settings: { react: { version: 'detect' } },
+  rules: {
+    'react/react-in-jsx-scope': 'off',
+    'react/prop-types': 'off',
+    '@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
+    '@typescript-eslint/no-explicit-any': 'warn',
+    '@typescript-eslint/consistent-type-imports': 'warn',
+  },
+  ignorePatterns: ['dist', 'node_modules', 'generated'],
+};

package/src/templates/web-react/files/_prettierrc

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc",
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "bracketSpacing": true,
+  "arrowParens": "always",
+  "endOfLine": "lf"
+}

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

@@ -6,7 +6,11 @@
   "scripts": {
     "dev": "vite",
     "build": "tsc -b && vite build",
-    "preview": "vite preview"
+    "preview": "vite preview",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint . --ext .ts,.tsx",
+    "format": "prettier --write \"src/**/*.{ts,tsx,css,json}\"",
+    "format:check": "prettier --check \"src/**/*.{ts,tsx,css,json}\""
   },
   "dependencies": {
     "antd": "^5.21.0",
@@ -18,7 +22,13 @@
   "devDependencies": {
     "@types/react": "^18.3.10",
     "@types/react-dom": "^18.3.0",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
     "@vitejs/plugin-react": "^4.3.1",
+    "eslint": "^8.57.0",
+    "eslint-plugin-react": "^7.36.1",
+    "eslint-plugin-react-hooks": "^4.6.2",
+    "prettier": "^3.3.3",
     "typescript": "^5.6.2",
     "vite": "^5.4.8"
   }

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

@@ -1,5 +1,5 @@
 name: web-react
-version: 1.1.0
+version: 1.2.0
 appliesWhen:
   frontend: react
 priority: 30
@@ -25,6 +25,12 @@ files:
   - from: files/src-App.tsx
     to: web/src/App.tsx
     render: true
+  - from: files/_eslintrc.cjs
+    to: web/.eslintrc.cjs
+    render: false
+  - from: files/_prettierrc
+    to: web/.prettierrc
+    render: false
   - from: files/generated-gitkeep
     to: web/generated/.gitkeep
     render: false

package/src/templates/web-vue/files/_eslintrc.cjs

@@ -0,0 +1,28 @@
+/**
+ * ESLint configuration for the Vue + TypeScript web app.
+ *
+ * Source of truth referenced by:
+ *   docs/03-工程规范与研发基础设施/coding-style-typescript.md
+ */
+module.exports = {
+  root: true,
+  env: { browser: true, es2022: true, node: true },
+  parser: 'vue-eslint-parser',
+  parserOptions: {
+    parser: '@typescript-eslint/parser',
+    ecmaVersion: 2022,
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint'],
+  extends: [
+    'eslint:recommended',
+    'plugin:vue/vue3-recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+  rules: {
+    '@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
+    '@typescript-eslint/no-explicit-any': 'warn',
+    'vue/multi-word-component-names': 'off',
+  },
+  ignorePatterns: ['dist', 'node_modules', 'generated'],
+};

package/src/templates/web-vue/files/_prettierrc

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc",
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "bracketSpacing": true,
+  "arrowParens": "always",
+  "endOfLine": "lf"
+}

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

@@ -1,5 +1,5 @@
 name: web-vue
-version: 1.0.0
+version: 1.1.0
 appliesWhen:
   frontend: vue
 priority: 30
@@ -16,6 +16,12 @@ files:
   - from: files/src-main.ts
     to: web/src/main.ts
     render: false
+  - from: files/_eslintrc.cjs
+    to: web/.eslintrc.cjs
+    render: false
+  - from: files/_prettierrc
+    to: web/.prettierrc
+    render: false
   - from: files/generated-gitkeep
     to: web/generated/.gitkeep
     render: false