@axyl-tcb/create-template 1.0.21 → 1.0.23

package/bin/index.js

@@ -80,7 +80,10 @@ async function resolveIncludeTests() {
     console.log('    cp .env.example .env        # 연결 정보 입력 — README 참고');
     console.log('    npm run deploy:build');
     console.log('');
-    console.log('  ※ npm audit 의 high 경고는 @cloudbase SDK 의 알려진 전이 취약점입니다.');
-    console.log('     정상이며 SECURITY.md 에 설명돼 있습니다 — `npm audit fix --force` 는 실행하지 마세요.');
-    console.log('');
+    // 최소 구성은 @cloudbase/node-sdk 를 포함하지 않아 audit 가 깨끗하므로 안내 불필요
+    if (includeTests) {
+        console.log('  ※ npm audit 의 high 경고는 @cloudbase SDK 의 알려진 전이 취약점입니다.');
+        console.log('     정상이며 SECURITY.md 에 설명돼 있습니다 — `npm audit fix --force` 는 실행하지 마세요.');
+        console.log('');
+    }
 })();

package/lib/scaffold.js

@@ -20,7 +20,9 @@ function validateProjectName(name) {
     return null;
 }
 
-const COPY_EXCLUDE = new Set(['node_modules', 'dist', '.git', '.npmignore']);
+// README.minimal.md 는 최소(N) 구성 전용 README 소스 — 생성 프로젝트에 그대로 복사하지 않고
+// scaffold() 가 최소 모드일 때만 README.md 로 사용한다.
+const COPY_EXCLUDE = new Set(['node_modules', 'dist', '.git', '.npmignore', 'README.minimal.md']);
 
 /**
  * 디렉토리를 재귀적으로 복사한다.
@@ -118,6 +120,12 @@ function scaffold(projectName, targetDir, templateDir, options = {}) {
     // 테스트 미포함 선택 시 최소 구성으로 정리
     if (options.includeTests === false) {
         pruneTestArtifacts(targetDir);
+        // 풀 README(예제·테스트 중심)는 최소 구성과 맞지 않으므로 전용 README 로 교체.
+        // 모듈 가이드(MYSQL/STORAGE/DOCDB/SECURITY.md)는 확장 시 참고용으로 그대로 유지된다.
+        const minReadme = path.join(templateDir, 'README.minimal.md');
+        if (fs.existsSync(minReadme)) {
+            fs.copyFileSync(minReadme, path.join(targetDir, 'README.md'));
+        }
     }
 
     // package.json name 업데이트

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axyl-tcb/create-template",
-  "version": "1.0.21",
+  "version": "1.0.23",
   "description": "Axyl TCB Cloud Function 프로젝트 스캐폴딩 CLI (npm create @axyl-tcb/template)",
   "bin": {
     "create-template": "bin/index.js"

package/template/README.minimal.md

@@ -0,0 +1,65 @@
+# <project-name>
+
+TCB(Tencent CloudBase) Cloud Function 프로젝트 — **최소 구성**입니다.
+`@axyl-tcb/middleware` 기반 기본 핸들러(`src/functions/basic/index.ts`) 하나로 시작합니다.
+
+## 빠른 시작
+
+```bash
+npm install
+npm run build      # src/functions 의 핸들러를 dist 로 번들
+```
+
+> 예제(MySQL·Storage·Document DB)와 테스트까지 포함한 풀 구성이 필요하면
+> `npm create @axyl-tcb/template` 실행 시 **테스트 포함(Y)** 을 선택해 다시 생성하세요.
+
+## 구조
+
+```
+<project-name>/
+├── src/functions/basic/index.ts   # 기본 AxylHandler (items 조회 예시)
+├── scripts/build.js · deploy.js
+├── cloudbaserc.json               # TCB 배포 설정 + 환경변수 키
+└── .env.example
+```
+
+## 핸들러 작성
+
+```ts
+import { createAxylHandler, type AxylBaseHandler, type AxylHttpEvent } from '@axyl-tcb/middleware';
+import { pool } from '@axyl-tcb/middleware/db';   // MySQL 사용 시
+
+interface ResDto { ok: true }
+
+const baseHandler: AxylBaseHandler<AxylHttpEvent, ResDto> = async (event, context) => {
+    // context.playerId / context.aud.gameIndex 는 검증 완료된 신뢰값
+    return { ok: true };
+};
+
+export const main = createAxylHandler(baseHandler);
+```
+
+새 함수는 `src/functions/<name>.ts` 로 추가하고 `cloudbaserc.json` 에 등록하면 됩니다(`npm run build` 가 자동 인식).
+
+## 모듈 가이드
+
+| 모듈 | 사용법 | 비고 |
+| --- | --- | --- |
+| MySQL | [MYSQL.md](./MYSQL.md) | `mysql2` 포함됨 — 바로 사용 가능 |
+| Cloud Storage | [STORAGE.md](./STORAGE.md) | `npm i @cloudbase/node-sdk` 후 `@axyl-tcb/middleware/storage` 사용 |
+| Document DB | [DOCDB.md](./DOCDB.md) | `npm i @cloudbase/node-sdk` 후 `@axyl-tcb/middleware/docdb` 사용 |
+
+> Storage/Document DB 예제는 `src/functions/storage/` · `src/functions/docdb/` 경로를 쓰므로, 최소 구성에 추가할 때는 해당 디렉토리를 새로 만들면 됩니다(`npm run build` 가 자동 인식).
+
+> 최소 구성은 `@cloudbase/node-sdk` 를 포함하지 않아 `npm audit` 가 깨끗합니다. Storage/Document DB 를 추가하면 `@cloudbase/node-sdk` 의 알려진 전이 취약점(high)이 함께 들어옵니다 — 불가피하며 [SECURITY.md](./SECURITY.md) 에 설명돼 있습니다.
+
+## 배포
+
+TCB(CloudBase) CLI 설치·로그인 후 배포합니다. 배포 대상 환경은 `cloudbaserc.json` 의 `envId` 로 지정됩니다.
+
+```bash
+npm i -g @cloudbase/cli   # tcb 명령 설치
+tcb login                 # 최초 1회 인증
+cp .env.example .env       # DB/TCB 연결 정보 입력
+npm run deploy:build       # 빌드 + 배포
+```