Initial commit

.eslintignore

@@ -0,0 +1,6 @@
+# modules
+node_modules/
+
+# build
+dist/
+tsconfig.tsbuildinfo

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+* @brckd
+CHANGELOG.md @brckd @semantic-release-bot

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/merge.yml

@@ -0,0 +1,21 @@
+name: merge
+on: pull_request
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - id: metadata
+        uses: dependabot/fetch-metadata@v1
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - if: ${{ steps.metadata.outputs.update-type == 'version-update:semver-patch' }}
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,28 @@
+name: release
+
+on:
+  push:
+    branches: main
+
+permissions:
+  contents: write
+  issues: read
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+          token: ${{ secrets.NPM_TOKEN }}
+      - run: npm ci
+      - run: npm i -D @semantic-release/changelog @semantic-release/git
+      - run: npm run build --if-present
+      - run: npm run format --if-present
+      - run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,9 @@
+# modules
+node_modules/
+
+# build
+dist/
+tsconfig.tsbuildinfo
+
+# variables
+.npmrc

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

.npmignore

@@ -0,0 +1,15 @@
+# modules
+node_modules/
+
+# build
+src/
+pack/
+tsconfig.tsbuildinfo
+
+# config
+.github/
+.vscode/
+.husky/
+.*ignore
+.*rc
+tsconfig.json

.prettierignore

@@ -0,0 +1,6 @@
+# modules
+node_modules/
+
+# build
+dist/
+tsconfig.tsbuildinfo

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "bierner.github-markdown-preview",
+    "esbenp.prettier-vscode",
+    "dbaeumer.vscode-eslint"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  },
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
+  "files.eol": "\n"
+}

LICENSE.md

@@ -0,0 +1,24 @@
+# The MIT License (MIT)
+
+Copyright © `2023` `Bricked`
+
+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,59 @@
+# @bricked/ts-template
+
+[![license](https://custom-icon-badges.demolab.com/github/license/brckd/ts-template?logo=law)](LICENSE.md)
+[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
+[![version](https://img.shields.io/npm/v/@bricked/ts-template?color=crimson&logo=npm)](https://www.npmjs.com/package/@bricked/ts-template)
+
+A template for TypeScript projects.
+
+> [!Warning]
+> This project has been archived because I tend to use [Bun](bun.sh)'s builtin tools nowadays.
+
+## ToDo
+
+- [ ] [Create](https://github.com/brckd/ts-template/generate) a new repository from this template
+- [ ] Find & replace `ts-template` with the name of the new repository
+- [ ] Find & replace the description with a proper one
+- [ ] Optionally make the [installation guide](#installation) install as `devDependency`
+
+```sh
+npm install --save-dev @bricked/ts-template
+yarn add --dev @bricked/ts-template
+pnpm add --dev @bricked/ts-template
+```
+
+- [ ] Add `NPM_TOKEN` as a [new repository secret](https://github.com/brckd/ts-template/settings/secrets/actions/new)
+- [ ] Remove `"dryRun": true` from the [`package.json`](./package.json)
+- [ ] Remove this section
+
+## Installation
+
+[Node.js](https://nodejs.org/) 16.14.0 or newer is required.
+
+```sh
+npm install @bricked/ts-template
+yarn add @bricked/ts-template
+pnpm add @bricked/ts-template
+```
+
+## Usage
+
+`ts-template` can be used as a template for TypeScript projects.
+
+## Building
+
+### Building Publicly
+
+Pulls to the repository will automatically be built with [semantic-release](https://github.com/semantic-release/npm).
+The built package can be found on [npm](https://www.npmjs.com/package/@bricked/ts-template?activeTab=code) or in the
+[latest github release](https://github.com/brckd/ts-template/releases/latest).
+
+### Building Locally
+
+The package can also be built locally using the `build` script.
+
+```sh
+npm run build
+yarn run build
+pnpm run build
+```