@axyl-tcb/create-template

npm create @axyl-tcb/template 명령으로 Axyl TCB Cloud Function 프로젝트를 스캐폴딩하는 CLI 패키지입니다.

사용법

npm create @axyl-tcb/template <project-name>

공개 npm 패키지이므로 별도 레지스트리 설정이나 인증이 필요 없습니다.

실행하면 테스트 파일 포함 여부를 묻습니다.

테스트 파일(예제·테스트·DB 셋업)을 포함하시겠습니까? (Y/n)

| 선택 | 생성 내용 | |---|---| | Y (기본) | 테마별 예제 함수 + 테스트 + DB 셋업 함수(createTables/createCollections) + INVOKE.md 포함 | | N | basic/index.ts 기본 핸들러 + lib + 문서만. 예제·테스트·셋업·INVOKE.md 제외 |

스캐폴딩 후 의존성(npm install)은 자동 설치됩니다.

cd <project-name>
cp .env.example .env   # DB 연결 정보 입력
npm test               # (테스트 포함 시)

비대화형(CI) 또는 명시 지정용 플래그:

npm create @axyl-tcb/template <project-name> -- --tests       # 테스트 포함 강제
npm create @axyl-tcb/template <project-name> -- --no-tests    # 최소 구성
npm create @axyl-tcb/template <project-name> -- --no-install  # 자동 설치 생략

플래그 미지정 + 비대화형 환경에서는 테스트 포함(Y) 이 기본입니다.

패키지 구조

axyl-tcb-template/
├── bin/
│   └── index.js          # CLI 진입점
├── lib/
│   └── scaffold.js       # validateProjectName / scaffold / pruneTestArtifacts / installDependencies
├── template/             # 스캐폴딩 소스 (npm publish 에 포함)
│   ├── src/functions/    # basic / mysql / storage / docdb (테마별)
│   ├── src/lib/          # db · storage · docdb
│   ├── test/             # basic / mysql / storage / docdb / lib (테마별)
│   ├── scripts/deploy.js
│   ├── _gitignore        # scaffold 시 .gitignore 로 변환
│   ├── cloudbaserc.json · package.json · tsconfig.json · vitest.config.ts
│   └── README.md · MYSQL.md · STORAGE.md · DOCDB.md · INVOKE.md
└── test/
    ├── scaffold.test.js  # validateProjectName / copyDir / scaffold 단위 테스트
    └── cli.test.js       # bin/index.js 통합 테스트 (포함/미포함 스캐폴드)

개발 가이드

의존성 설치

npm install                  # CLI 테스트용 (vitest)
npm run template:install     # template/ 의존성 설치

테스트

npm test                     # CLI 단위 + 통합 테스트 (scaffold.test.js, cli.test.js)
npm run template:test        # template/ 핸들러 + db 테스트

template 소스 수정

template/ 안에서 직접 편집합니다.

npm run template:test        # 변경 내용 검증
npm run template:build       # esbuild 번들링 확인

배포

npm version patch            # 버전 업
npm publish                  # npmjs.com 공개 배포 (access public)

미들웨어(@axyl-tcb/middleware)와의 배포 순서, 버전 규칙, 인증 설정 등 전체 릴리스 절차는 PUBLISHING.md 를 참고하세요.

생성되는 프로젝트에 대한 안내

스캐폴딩된 프로젝트의 사용법은 생성된 디렉토리 안의 README.md 를 참고하세요.