@kitschpatrol/create-project 1.0.0

package/templates/cli/src/index.ts

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+
+import yargs from 'yargs'
+import { hideBin } from 'yargs/helpers'
+import { bin, version } from '../package.json'
+
+const cliCommandName = Object.keys(bin).at(0)!
+const yargsInstance = yargs(hideBin(process.argv))
+
+// Yes
+await yargsInstance
+	.scriptName(cliCommandName)
+	.usage('$0 [command]', `Run a ${cliCommandName} command.`)
+	.option('verbose', {
+		description: 'Run with verbose logging',
+		type: 'boolean',
+	})
+	.command(['$0', 'do-something'], 'Run the do-something command.', () => {
+		process.stdout.write('Did something!\n')
+	})
+	.command('do-something-else', 'Run the do-something-else command.', () => {
+		process.stdout.write('Did something else!\n')
+	})
+	.alias('h', 'help')
+	.version(version)
+	.alias('v', 'version')
+	.help()
+	.strict()
+	.wrap(process.stdout.isTTY ? Math.min(120, yargsInstance.terminalWidth()) : 0)
+	.parse()

package/templates/cli/tsconfig.json

@@ -0,0 +1,7 @@
+{
+	"extends": "@kitschpatrol/typescript-config",
+
+	// Includes project dot-files files for typescript-eslint integration
+	"include": ["**/*", "**/**.*"],
+	"exclude": ["**/dist/", "**/bin/"]
+}

package/templates/cli+library/.github/workflows/github-release.yml

@@ -0,0 +1,81 @@
+name: Create GitHub Release
+
+on:
+  push:
+    tags:
+      - 'v[0-9]*'
+
+jobs:
+  build:
+    name: Create Release
+    runs-on: ubuntu-latest
+    env:
+      ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN || secrets.GITHUB_TOKEN }}
+      IS_VALID_COMMIT: false
+      TAG_NAME: ''
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Log Token Type
+        run: |
+          if [ ${{ env.ACCESS_TOKEN }} == ${{ secrets.GITHUB_TOKEN }} ]; then
+            echo "🗝️ Authenticated with GitHub Token"
+          else
+            echo "🔑 Authenticated with Personal Access token"
+          fi
+
+      - name: Validate Tag and Branch
+        id: validation
+        run: |
+          TAG=$(git tag --contains HEAD | grep '^v[0-9]' | head -n 1)
+          echo "🏷️ Tag for commit is: $TAG"
+          BRANCH=$(git branch -r --contains tags/${GITHUB_REF_NAME} | grep 'origin/main' | xargs)
+          if [[ -z "$BRANCH" ]]; then
+            echo "🚨 Tag is not on main branch"
+          else
+            echo "🕊️ Current branch is: $BRANCH"
+          fi
+          if [[ -z "$TAG" || -z "$BRANCH" ]]; then
+            echo "IS_VALID_COMMIT=false" >> "$GITHUB_ENV"
+            echo "TAG_NAME=''" >> "$GITHUB_ENV"
+          else
+            echo "IS_VALID_COMMIT=true" >> "$GITHUB_ENV"
+            echo "TAG_NAME=$TAG" >> "$GITHUB_ENV"
+          fi
+
+      - name: Release Notes
+        if: env.IS_VALID_COMMIT == 'true'
+        id: release-notes
+        uses: kitschpatrol/github-action-release-changelog@v2
+
+      - name: Release
+        if: env.IS_VALID_COMMIT == 'true'
+        id: release
+        uses: kitschpatrol/github-action-release@v2
+        with:
+          token: ${{ env.ACCESS_TOKEN }}
+          draft: false
+          prerelease: false
+          name: ${{ env.TAG_NAME }}
+          tag_name: ${{ env.TAG_NAME }}
+          body: |
+            ${{ steps.release-notes.outputs.changelog }}
+          files: |
+            readme.md
+            README.md
+            LICENSE
+            license.txt
+            CHANGELOG
+            CHANGELOG.md
+            changelog.md
+
+      - name: Log Release Details
+        if: env.IS_VALID_COMMIT == 'true'
+        run: |
+          echo "📦 Successfully released: ${{ env.TAG_NAME }}"
+          echo "🔗 Release URL: ${{ steps.release.outputs.url }}"
+          echo "🪪 Release ID: ${{ steps.release.outputs.id }}"

package/templates/cli+library/.github/workflows/set-github-metadata.yml

@@ -0,0 +1,21 @@
+name: Set GitHub Metadata
+on:
+  push:
+    branches: [main]
+  workflow_dispatch: {}
+
+jobs:
+  build:
+    name: Set GitHub Metadata
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Sync Package info to GitHub
+        uses: kitschpatrol/github-action-repo-sync@v3
+        with:
+          TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}

package/templates/cli+library/.prettierignore

@@ -0,0 +1,8 @@
+# Prettier Ignore
+# Also respects .gitignore
+
+# @kitschpatrol/prettier-config boilerplate
+pnpm-lock.yaml
+package-lock.json
+
+# Customizations

package/templates/cli+library/.remarkrc.js

@@ -0,0 +1,6 @@
+import { remarkConfig } from '@kitschpatrol/remark-config'
+
+export default remarkConfig({
+	// Useful if the repository is not yet pushed to a remote.
+	rules: [['remarkValidateLinks', { repository: false }]],
+})

package/templates/cli+library/.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+	"recommendations": [
+		"dbaeumer.vscode-eslint",
+		"esbenp.prettier-vscode",
+		"streetsidesoftware.code-spell-checker",
+		"unifiedjs.vscode-mdx"
+	]
+}

package/templates/cli+library/.vscode/settings.json

@@ -0,0 +1,68 @@
+{
+	"explorer.fileNesting.enabled": true,
+	"explorer.fileNesting.expand": false,
+	"explorer.fileNesting.patterns": {
+		"*.js": "*.ts.map, *.js.map, *.d.ts, *.d.ts.map, *.d.js.map",
+		"*.ts": "*.ts.map, *.d.ts, *.d.ts.map",
+		".env": ".env.*",
+		"package.json": ".*ignore, .*rc, .*.js, .*.mjs, .*.cjs, .*.ts, .*.mts, .*.cts, .*.json, .*.jsonc, .*.json5, .*.yml, .*.yaml, *config.js, *config.mjs, *config.cjs, *config.ts, *config.mts, *config.cts, *config.json, *config.jsonc, *config.json5, *config.yml, *config.yaml, pnpm*, workspace*, yarn*, lerna.json, netlify.toml, package-lock.json, turbo.json, vercel.json, wrangler.toml, yarn.lock",
+		"readme.md": "authors*, backers*, changelog*, citation*, code_of_conduct*, contributing*, contributors*, copying*, credits*, governance*, history*, license*, maintainers*, release_notes*, security*, sponsors*"
+	},
+	"typescript.enablePromptUseWorkspaceTsdk": true,
+	"typescript.tsdk": "node_modules/typescript/lib",
+	"editor.codeActionsOnSave": {
+		"source.fixAll": "explicit",
+		"source.organizeImports": "never"
+	},
+	"eslint.enable": true,
+	"eslint.runtime": "node",
+	"eslint.validate": [
+		"astro",
+		"html",
+		"javascript",
+		"javascriptreact",
+		"json",
+		"json5",
+		"jsonc",
+		"markdown",
+		"mdx",
+		"svelte",
+		"toml",
+		"typescript",
+		"typescriptreact",
+		"xml",
+		"yaml"
+	],
+	"eslint.useFlatConfig": true,
+	"cSpell.enabled": true,
+	"cSpell.workspaceRootPath": ".",
+	"[astro]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
+	},
+	"[gitignore]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
+	},
+	"[ruby]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
+	},
+	"[shellscript]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
+	},
+	"[svelte]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
+	},
+	"editor.defaultFormatter": "esbenp.prettier-vscode",
+	"editor.formatOnSave": true,
+	"prettier.documentSelectors": [
+		"**/.eslintignore",
+		"**/.node-version",
+		"**/.npmrc",
+		"**/.prettierignore",
+		"**/*.astro",
+		"**/*.rb",
+		"**/*.svelte"
+	],
+	"prettier.enable": true,
+	"stylelint.enable": true,
+	"stylelint.validate": ["css", "html", "svelte", "astro"]
+}

package/templates/cli+library/cspell.config.js

@@ -0,0 +1,3 @@
+import { cspellConfig } from '@kitschpatrol/cspell-config'
+
+export default cspellConfig()

package/templates/cli+library/eslint.config.ts

@@ -0,0 +1,5 @@
+import { eslintConfig } from '@kitschpatrol/eslint-config'
+
+export default eslintConfig({
+	type: 'lib',
+})

package/templates/cli+library/knip.config.ts

@@ -0,0 +1,3 @@
+import { knipConfig } from '@kitschpatrol/knip-config'
+
+export default knipConfig()

package/templates/cli+library/license.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 {{author-name}}
+
+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.

package/templates/cli+library/mdat.config.ts

@@ -0,0 +1,3 @@
+import { mdatConfig } from '@kitschpatrol/mdat-config'
+
+export default mdatConfig()

package/templates/cli+library/package.json

@@ -0,0 +1,62 @@
+{
+	"name": "{{github-repository}}",
+	"version": "0.0.0",
+	"description": "A {{type}} project.",
+	"keywords": [
+		"cli",
+		"npm-package"
+	],
+	"homepage": "https://github.com/{{github-owner}}/{{github-repository}}",
+	"bugs": "https://github.com/{{github-owner}}/{{github-repository}}/issues",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/{{github-owner}}/{{github-repository}}.git"
+	},
+	"license": "MIT",
+	"author": {
+		"name": "{{author-name}}",
+		"email": "{{author-email}}",
+		"url": "{{author-url}}"
+	},
+	"type": "module",
+	"exports": {
+		".": {
+			"import": "./dist/lib/index.js",
+			"types": "./dist/lib/index.d.ts"
+		}
+	},
+	"main": "./dist/lib/index.js",
+	"module": "./dist/lib/index.js",
+	"bin": {
+		"{{cli-command-name}}": "dist/bin/cli.js"
+	},
+	"files": [
+		"dist/*"
+	],
+	"scripts": {
+		"build": "tsdown",
+		"clean": "git rm -f pnpm-lock.yaml ; git clean -fdX",
+		"fix": "ksc fix",
+		"lint": "ksc lint",
+		"release": "bumpp --commit 'Release: %s' && pnpm run build && pnpm publish --otp $({{npm-otp-command}})",
+		"test": "echo \"Error: no test specified\" && exit 1"
+	},
+	"dependencies": {
+		"@types/node": "^20.19.21",
+		"@types/yargs": "^17.0.33",
+		"yargs": "^17.7.2"
+	},
+	"devDependencies": {
+		"@kitschpatrol/shared-config": "^5.7.2",
+		"bumpp": "^10.3.1",
+		"tsdown": "^0.15.7",
+		"typescript": "~5.9.3"
+	},
+	"packageManager": "pnpm@10.18.3",
+	"engines": {
+		"node": ">=20.19.0"
+	},
+	"publishConfig": {
+		"access": "public"
+	}
+}

package/templates/cli+library/prettier.config.js

@@ -0,0 +1,3 @@
+import { prettierConfig } from '@kitschpatrol/prettier-config'
+
+export default prettierConfig()

package/templates/cli+library/readme.md

@@ -0,0 +1,53 @@
+<!--+ Warning: Content inside HTML comment blocks was generated by mdat and may be overwritten. +-->
+
+<!-- title -->
+
+<!-- badges -->
+
+<!-- short-description -->
+
+## Overview
+
+## Getting started
+
+### Dependencies
+
+### Installation
+
+## Usage
+
+### Library
+
+#### API
+
+#### Examples
+
+### CLI
+
+<!-- cli-help -->
+
+#### Commands
+
+#### Examples
+
+## Background
+
+### Motivation
+
+### Implementation notes
+
+### Similar projects
+
+## The future
+
+## Maintainers
+
+_List maintainer(s) for a repository, along with one way of contacting them (e.g. GitHub link or email)._
+
+## Acknowledgments
+
+_State anyone or anything that significantly helped with the development of your project. State public contact hyper-links if applicable._
+
+<!-- contributing -->
+
+<!-- license -->

package/templates/cli+library/src/bin/cli.ts

@@ -0,0 +1,42 @@
+#!/usr/bin/env node
+
+import yargs from 'yargs'
+import { hideBin } from 'yargs/helpers'
+import { version, bin } from '../../package.json'
+
+import { doSomething, doSomethingElse } from '../lib'
+
+const cliCommandName = Object.keys(bin).at(0)!
+const yargsInstance = yargs(hideBin(process.argv))
+
+// yes
+await yargsInstance
+	.scriptName(cliCommandName)
+	.usage('$0 [command]', `Run a ${cliCommandName} command.`)
+	.option('verbose', {
+		description: 'Run with verbose logging',
+		type: 'boolean',
+	})
+	.command(
+		['$0', 'do-something'],
+		'Run the do-something command.',
+		() => {},
+		async () => {
+			process.stdout.write(doSomething())
+		},
+	)
+	.command(
+		'do-something-else',
+		'Run the do-something-else command.',
+		() => {},
+		async () => {
+			process.stdout.write(doSomethingElse())
+		},
+	)
+	.alias('h', 'help')
+	.version(version)
+	.alias('v', 'version')
+	.help()
+	.strict()
+	.wrap(process.stdout.isTTY ? Math.min(120, yargsInstance.terminalWidth()) : 0)
+	.parse()

package/templates/cli+library/src/lib/index.ts

@@ -0,0 +1,13 @@
+/**
+ * Do something.
+ */
+export function doSomething(): string {
+	return 'Something happened'
+}
+
+/**
+ * Do something else.
+ */
+export function doSomethingElse(): string {
+	return 'Something else happened'
+}

package/templates/cli+library/tsconfig.build.json

@@ -0,0 +1,8 @@
+{
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"declarationMap": true
+	},
+	"include": ["**/*", "**/**.*"],
+	"exclude": ["**/dist/", "**/bin/"]
+}

package/templates/cli+library/tsconfig.json

@@ -0,0 +1,7 @@
+{
+	"extends": "@kitschpatrol/typescript-config",
+
+	// Includes project dot-files files for typescript-eslint integration
+	"include": ["**/*", "**/**.*"],
+	"exclude": ["**/dist/", "**/bin/"]
+}

package/templates/cli+library/tsdown.config.ts

@@ -0,0 +1,17 @@
+import { defineConfig } from 'tsdown'
+
+export default defineConfig([
+	{
+		dts: false,
+		entry: 'src/bin/cli.ts',
+		outDir: 'dist/bin',
+		platform: 'node',
+	},
+	{
+		entry: 'src/lib/index.ts',
+		minify: true,
+		outDir: 'dist/lib',
+		platform: 'neutral',
+		tsconfig: 'tsconfig.build.json',
+	},
+])

package/templates/library/.github/workflows/github-release.yml

@@ -0,0 +1,81 @@
+name: Create GitHub Release
+
+on:
+  push:
+    tags:
+      - 'v[0-9]*'
+
+jobs:
+  build:
+    name: Create Release
+    runs-on: ubuntu-latest
+    env:
+      ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN || secrets.GITHUB_TOKEN }}
+      IS_VALID_COMMIT: false
+      TAG_NAME: ''
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Log Token Type
+        run: |
+          if [ ${{ env.ACCESS_TOKEN }} == ${{ secrets.GITHUB_TOKEN }} ]; then
+            echo "🗝️ Authenticated with GitHub Token"
+          else
+            echo "🔑 Authenticated with Personal Access token"
+          fi
+
+      - name: Validate Tag and Branch
+        id: validation
+        run: |
+          TAG=$(git tag --contains HEAD | grep '^v[0-9]' | head -n 1)
+          echo "🏷️ Tag for commit is: $TAG"
+          BRANCH=$(git branch -r --contains tags/${GITHUB_REF_NAME} | grep 'origin/main' | xargs)
+          if [[ -z "$BRANCH" ]]; then
+            echo "🚨 Tag is not on main branch"
+          else
+            echo "🕊️ Current branch is: $BRANCH"
+          fi
+          if [[ -z "$TAG" || -z "$BRANCH" ]]; then
+            echo "IS_VALID_COMMIT=false" >> "$GITHUB_ENV"
+            echo "TAG_NAME=''" >> "$GITHUB_ENV"
+          else
+            echo "IS_VALID_COMMIT=true" >> "$GITHUB_ENV"
+            echo "TAG_NAME=$TAG" >> "$GITHUB_ENV"
+          fi
+
+      - name: Release Notes
+        if: env.IS_VALID_COMMIT == 'true'
+        id: release-notes
+        uses: kitschpatrol/github-action-release-changelog@v2
+
+      - name: Release
+        if: env.IS_VALID_COMMIT == 'true'
+        id: release
+        uses: kitschpatrol/github-action-release@v2
+        with:
+          token: ${{ env.ACCESS_TOKEN }}
+          draft: false
+          prerelease: false
+          name: ${{ env.TAG_NAME }}
+          tag_name: ${{ env.TAG_NAME }}
+          body: |
+            ${{ steps.release-notes.outputs.changelog }}
+          files: |
+            readme.md
+            README.md
+            LICENSE
+            license.txt
+            CHANGELOG
+            CHANGELOG.md
+            changelog.md
+
+      - name: Log Release Details
+        if: env.IS_VALID_COMMIT == 'true'
+        run: |
+          echo "📦 Successfully released: ${{ env.TAG_NAME }}"
+          echo "🔗 Release URL: ${{ steps.release.outputs.url }}"
+          echo "🪪 Release ID: ${{ steps.release.outputs.id }}"

package/templates/library/.github/workflows/set-github-metadata.yml

@@ -0,0 +1,21 @@
+name: Set GitHub Metadata
+on:
+  push:
+    branches: [main]
+  workflow_dispatch: {}
+
+jobs:
+  build:
+    name: Set GitHub Metadata
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Sync Package info to GitHub
+        uses: kitschpatrol/github-action-repo-sync@v3
+        with:
+          TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}

package/templates/library/.prettierignore

@@ -0,0 +1,8 @@
+# Prettier Ignore
+# Also respects .gitignore
+
+# @kitschpatrol/prettier-config boilerplate
+pnpm-lock.yaml
+package-lock.json
+
+# Customizations

package/templates/library/.remarkrc.js

@@ -0,0 +1,6 @@
+import { remarkConfig } from '@kitschpatrol/remark-config'
+
+export default remarkConfig({
+	// Useful if the repository is not yet pushed to a remote.
+	rules: [['remarkValidateLinks', { repository: false }]],
+})

package/templates/library/.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+	"recommendations": [
+		"dbaeumer.vscode-eslint",
+		"esbenp.prettier-vscode",
+		"streetsidesoftware.code-spell-checker",
+		"unifiedjs.vscode-mdx"
+	]
+}