Initial commit

.github/workflows/release.yml

@@ -0,0 +1,86 @@
+name: Release on version change
+
+on:
+  push:
+    paths:
+      - 'package.json'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '18'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build the project
+        run: npm run build
+
+      - name: Get package name and version
+        id: package_info
+        run: |
+          name=$(jq -r '.name' < package.json)
+          version=$(jq -r '.version' < package.json)
+          echo "name=$name" >> $GITHUB_OUTPUT
+          echo "version=$version" >> $GITHUB_OUTPUT
+
+      - name: Check if version is prerelease
+        id: prerelease_check
+        run: |
+          if [[ "${{ steps.package_info.outputs.version }}" == *"-"* ]]; then
+            echo "prerelease=true" >> $GITHUB_OUTPUT
+          else
+            echo "prerelease=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Prepare files for zipping
+        run: |
+          mkdir -p ${{ steps.package_info.outputs.name }}  # {name} 폴더 생성
+          cp -r dist/preserve/* ${{ steps.package_info.outputs.name }}/  # 소스코드를 {name} 폴더로 이동
+
+      - name: Zip {name} folder
+        run: |
+          zip -r ${{ steps.package_info.outputs.name }}-${{ steps.package_info.outputs.version }}.zip ${{ steps.package_info.outputs.name }}
+
+      - name: Rename index.js to {name}.js
+        run: mv dist/all/index.js dist/all/${{ steps.package_info.outputs.name }}.js
+
+      - name: Create GitHub Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # GitHub Token 설정
+        with:
+          tag_name: v${{ steps.package_info.outputs.version }}  # 릴리즈 태그
+          release_name: v${{ steps.package_info.outputs.version }}  # 릴리즈 이름
+          body: |
+            Automated release for version ${{ steps.package_info.outputs.version }}.
+          draft: false
+          prerelease: ${{ steps.prerelease_check.outputs.prerelease }}  # prerelease 값 동적 설정
+
+      - name: Upload {name}.js to release
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # GitHub Token 설정
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: dist/all/${{ steps.package_info.outputs.name }}.js
+          asset_name: ${{ steps.package_info.outputs.name }}.js
+          asset_content_type: application/javascript
+
+      - name: Upload {name}-{version}.zip to release
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # GitHub Token 설정
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ${{ steps.package_info.outputs.name }}-${{ steps.package_info.outputs.version }}.zip
+          asset_name: ${{ steps.package_info.outputs.name }}-${{ steps.package_info.outputs.version }}.zip
+          asset_content_type: application/zip

.gitignore

@@ -0,0 +1,131 @@
+### Node template
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+

.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "tsx",
+            "type": "node",
+            "request": "launch",
+            "program": "${file}",
+            "runtimeExecutable": "tsx",
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen",
+            "skipFiles": [
+                "<node_internals>/**",
+                "${workspaceFolder}/node_modules/**"
+            ]
+        }
+    ]
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Hyunseung Ryu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,25 @@
+# 🧩 typescript-module
+
+TypeScript를 사용한 모듈을 쉽게 만들기 위한 템플릿 레포지토리.  
+
+- Bot App: [`메신저봇R`](https://github.com/MessengerBotTeam/msgbot-old-release/releases/tag/0.7.36a) (0.7.36a 버전 이상)
+- CI/CD: [`GitHub Actions`](https://github.com/features/actions)
+- Module Bundler: [`Rollup`](https://rollupjs.org/)
+- Test: [`Vitest`](https://vitest.dev/)
+- Execute: [`TSX`](https://tsx.is/)
+- Runtime: [`Node.js`](https://nodejs.org/en)
+
+## 📜 features
+- `npm run build:all-in-one`: `src` 폴더의 모든 소스를 하나의 `.js`, `.d.ts` 파일로 만들어 `dist/all`에 빌드
+- `npm run build:no-all-in-one`: `src` 폴더의 각 파일들을 파일 구조를 유지한 채 `.js`, `.d.ts` 파일로 변환해 `dist/preserve`에 빌드
+- `package.json`에 `version` 키가 변경된 채로 푸쉬하면 자동으로 해당 버전으로 릴리즈 생성. (`v1.0.0-alpha` 처럼 쓰면 prerelease로 설정됨)
+
+> [!NOTE]
+> `package.json` 에서 `directories` 키를 수정하여 빌드 타겟 변경 가능
+
+## ✅ prepare
+1. 레포지토리 설정에서 `GitHub Actions` 가 적절한 권한을 가지고 있는지 확인하세요.
+    - `Settings > Actions > General` 로 이동합니다.
+    - `Workflow permissions` 에서 `Read and write permissions` 를 선택하고 저장합니다.
+2. `package.json` 파일을 열어 `name`, `version`, `description`, `author`, `license` 등의 필드를 적절히 수정합니다.
+3. `npm install` 명령어를 실행하여 의존성 패키지를 설치합니다.