Initial commit

.github/workflows/ci.yml

@@ -0,0 +1,57 @@
+name: Main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  pull-requests: write
+  contents: read
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build-test:
+    name: 📚 Main
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - run: corepack enable
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+          cache: pnpm
+
+      - name: 📦 Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: 🚀 Build
+        run: pnpm build
+
+      - name: 👀 Lint
+        run: pnpm lint
+
+      # - name: 🧪 Test
+      #   run: pnpm test
+      #   env:
+      #     VITE_TEST_DB_URL: ${{ secrets.VITE_TEST_DB_URL }}
+
+      - name: 🧪 Test with coverage
+        run: pnpm coverage
+
+      - name: 📝 Upload coverage
+        if: always()
+        uses: davelosert/vitest-coverage-report-action@v2

.github/workflows/release.yml

@@ -0,0 +1,26 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+
+      - run: npx changelogithub
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1,6 @@
+*.log
+.DS_Store
+node_modules
+dist
+package-lock.json
+.env

.npmrc

@@ -0,0 +1,2 @@
+shamefully-hoist=true
+git-checks=false

.nvmrc

@@ -0,0 +1 @@
+v20

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  // Enable the ESlint flat config support
+  "eslint.experimental.useFlatConfig": true
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 productdevbook - Open Source
+
+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,50 @@
+# Typescript Bundle Template
+
+![Typescript Bundle Template](https://github.com/productdevbookcom/assets/blob/main/ts-bundle-template.jpg?raw=true)
+
+This is a template for creating a Typescript bundle. It is based on the [Typescript](https://www.typescriptlang.org/) compiler with the [Tsup](https://github.com/egoist/tsup) bundler.
+
+## Features
+
+- [x] [Typescript](https://www.typescriptlang.org/)
+- [x] [Tsup](https://github.com/egoist/tsup)
+- [x] [ESLint](https://eslint.org/) with [Antfu's ESLint Config](https://github.com/antfu/eslint-config)
+- [x] [Bumpp](https://github.com/antfu/bumpp) github changelog generator
+- [x] [Vitest](https://vitest.dev/)
+- [x] [Pnpm](https://pnpm.io/)
+- [x] [GitHub Actions]()
+- [x] [NPM Local Registry]()
+- [x] [Renovate]()
+
+## Usage
+
+1. To use this template, click the "Use this template" button above.
+2. Clone the repository to your local machine.
+3. Run `pnpm install` to install the dependencies.
+4. Run `pnpm build` to build the bundle.
+5. Run `pnpm start` to start the bundle.
+6. Run `pnpm lint` to lint the code. (You can also run `pnpm lint:fix` to fix the linting errors.)
+7. Run `pnpm test` to run the tests. (You can also run `pnpm test:watch` to run the tests in watch mode.)
+8. Run `pnpm release` to bump the version. Terminal will ask you to select the version type. And then it will automatically commit and push the changes. GitHub Actions will automatically publish git tags. NPM local registry will automatically publish the package.
+
+## Configuration
+
+### Renovate
+
+[Setup Github App](https://github.com/apps/renovate) for Renovate.
+
+### TS Config Base
+
+(tsconfig.json)[https://github.com/tsconfig/bases/tree/main/bases] is used as the base config for the Typescript compiler.
+
+## Sponsors
+
+<p align="center">
+  <a href="https://cdn.jsdelivr.net/gh/oku-ui/static/sponsors/sponsors.svg">
+    <img alt="sponsors" src='https://cdn.jsdelivr.net/gh/oku-ui/static/sponsors/sponsors.svg'/>
+  </a>
+</p>
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).

eslint.config.js

@@ -0,0 +1,11 @@
+import antfu from '@antfu/eslint-config'
+
+export default antfu(
+  {},
+  {
+    ignores: [
+      'dist',
+      '.github',
+    ],
+  },
+)

package.json

@@ -0,0 +1,66 @@
+{
+  "name": "ts-bundle-template",
+  "type": "module",
+  "version": "0.0.0",
+  "packageManager": "pnpm@8.10.0",
+  "description": "add description",
+  "author": "add author",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/productdevbook",
+  "homepage": "https://github.com/productdevbookcom/ts-bundle-template",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/productdevbookcom/ts-bundle-template.git"
+  },
+  "bugs": "https://github.com/productdevbookcom/ts-bundle-template/issues",
+  "keywords": [
+    "add keywords"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "prepublishOnly": "pnpm run build",
+    "release": "pnpm build && bumpp --commit --push --tag && pnpm publish",
+    "lint": "eslint . && pnpm typecheck",
+    "lint:fix": "eslint . --fix",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest",
+    "test:watch": "vitest --watch",
+    "coverage": "vitest run --coverage"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "2.6.3",
+    "@vitest/coverage-v8": "^1.2.2",
+    "bumpp": "^9.3.0",
+    "eslint": "^8.56.0",
+    "lint-staged": "^15.2.0",
+    "simple-git-hooks": "^2.9.0",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3",
+    "vitest": "^1.2.2"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "pnpm lint-staged"
+  },
+  "lint-staged": {
+    "*": "pnpm eslint . --fix"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

playground/index.ts

@@ -0,0 +1,6 @@
+import { handler } from 'ts-bundle-template'
+
+handler('test', 'test', (err: any, result: any) => {
+  // eslint-disable-next-line no-console
+  console.log(err, result)
+})

playground/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "playground",
+  "version": "1.0.0",
+  "description": "",
+  "author": "",
+  "license": "ISC",
+  "keywords": [],
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "devDependencies": {
+    "ts-bundle-template": "workspace:^"
+  }
+}