@kitschpatrol/create-project 1.0.0

package/eslint.config.ts

@@ -0,0 +1,19 @@
+import { eslintConfig } from '@kitschpatrol/eslint-config'
+
+export default eslintConfig(
+	{
+		// Enable as needed:
+		// astro: true,
+		// react: true,
+		// svelte: true,
+		type: 'lib',
+	},
+	{
+		basePath: 'templates/cli',
+		files: ['package.json'],
+		rules: {
+			'json-package/valid-author': 'off',
+			'json-package/valid-name': 'off',
+		},
+	},
+)

package/knip.config.ts

@@ -0,0 +1,5 @@
+import { knipConfig } from '@kitschpatrol/knip-config'
+
+export default knipConfig({
+	ignore: ['templates/**/*'],
+})

package/license.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Eric Mika
+
+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/mdat.config.ts

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

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@kitschpatrol/create-project",
+  "version": "1.0.0",
+  "description": "Kitschpatrol's TypeScript project templates.",
+  "keywords": [
+    "cli",
+    "template",
+    "bingo"
+  ],
+  "homepage": "https://github.com/kitschpatrol/create-project",
+  "bugs": "https://github.com/kitschpatrol/create-project/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kitschpatrol/create-project.git"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Eric Mika",
+    "email": "eric@ericmika.com",
+    "url": "https://ericmika.com"
+  },
+  "type": "module",
+  "bin": "dist/index.js",
+  "dependencies": {
+    "bingo": "^0.5.16",
+    "bingo-fs": "^0.5.5",
+    "bingo-handlebars": "^0.1.0"
+  },
+  "devDependencies": {
+    "@kitschpatrol/shared-config": "^5.7.2",
+    "bumpp": "^10.3.1",
+    "tsdown": "^0.15.7",
+    "typescript": "~5.9.3",
+    "zod": "^3.25.76"
+  },
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "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 $(op read 'op://Personal/Npmjs/one-time password?attribute=otp')"
+  }
+}

package/pnpm-workspace.yaml

@@ -0,0 +1,7 @@
+packages:
+  - templates/*
+
+onlyBuiltDependencies:
+  - esbuild
+  - puppeteer
+  - unrs-resolver

package/prettier.config.js

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

package/readme.md

@@ -0,0 +1,98 @@
+<!--+ Warning: Content inside HTML comment blocks was generated by mdat and may be overwritten. +-->
+
+<!-- title -->
+
+# @kitschpatrol/create-project
+
+<!-- /title -->
+
+<!-- badges -->
+
+[![NPM Package @kitschpatrol/create-project](https://img.shields.io/npm/v/@kitschpatrol/create-project.svg)](https://npmjs.com/package/@kitschpatrol/create-project)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+<!-- /badges -->
+
+<!-- short-description -->
+
+**Kitschpatrol's TypeScript project templates.**
+
+<!-- /short-description -->
+
+## Overview
+
+This repository contains very basic starter templates for TypeScript projects integrating [@kitschpatrol/shared-config](https://github.com/kitschpatrol/shared-config).
+
+The lint tools and rules that come along with [@kitschpatrol/shared-config](https://github.com/kitschpatrol/shared-config) are quite opinionated and draconian, and won't be to everyone's taste.
+
+The templates use [tsdown](https://tsdown.dev/) for building TypeScript libraries and Node-based CLI tools, and [Vite](https://vite.dev/) for web projects. [Bingo](https://www.create.bingo/) is used for the project templating system itself.
+
+## Getting started
+
+### Dependencies
+
+[Node.js](https://nodejs.org/) 20.19.0 or higher and [pnpm](https://pnpm.io/) are required.
+
+## Usage
+
+### Create a new project
+
+```sh
+pnpm create @kitschpatrol/project
+```
+
+### CLI options
+
+```txt
+Bingo template options:
+
+  --directory (string): What local directory path to run under
+      npx new-project --directory my-fancy-project
+
+  --help (string): Prints help text.
+      npx new-project --help
+
+  --mode ("setup" | "transition"): Which mode to run in.
+      npx new-project --mode setup
+      npx new-project --mode transition
+
+  --offline (boolean): Whether to run in an "offline" mode that skips network requests.
+      npx new-project --offline
+
+  --version (boolean): Prints package versions.
+      npx new-project --version
+
+Kitschpatrol Create Project options:
+
+  --type (enum): The type of project to create.
+  --author-name (string): The name of the author.
+  --author-email (string): The email of the author.
+  --author-url (string): The URL of the author.
+  --cli-command-name (string): CLI command name (if applicable).
+  --github-owner (string): The owner of the future repository.
+  --github-repository (string): The name of the future repository / package.
+```
+
+## Maintainers
+
+[@kitschpatrol](https://github.com/kitschpatrol)
+
+## Acknowledgments
+
+Thanks to [Josh Goldberg](https://www.joshuakgoldberg.com/) for creating the [Bingo](https://www.create.bingo/) template system.
+
+<!-- contributing -->
+
+## Contributing
+
+[Issues](https://github.com/kitschpatrol/create-project/issues) and pull requests are welcome.
+
+<!-- /contributing -->
+
+<!-- license -->
+
+## License
+
+[MIT](license.txt) © Eric Mika
+
+<!-- /license -->

package/src/index.ts

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+
+import { runTemplateCLI } from 'bingo'
+import template from './template'
+
+process.exitCode = await runTemplateCLI(template, {
+	name: 'new-project',
+	version: '0.0.0',
+})

package/src/template.ts

@@ -0,0 +1,72 @@
+/* eslint-disable node/no-unsupported-features/node-builtins */
+
+import { createTemplate } from 'bingo'
+import { intakeDirectory } from 'bingo-fs'
+import { handlebars } from 'bingo-handlebars'
+import path from 'node:path'
+import { z } from 'zod'
+
+export default createTemplate({
+	about: {
+		name: 'Kitschpatrol Create Project',
+		// Show template origin in GitHub... don't want this right now
+		// repository: {
+		// 	owner: 'kitschpatrol',
+		// 	repository: 'https://github.com/kitschpatrol/create-project',
+		// },
+	},
+	options: {
+		/* eslint-disable perfectionist/sort-objects */
+		type: z
+			.enum(['minimal', 'web', 'cli', 'library', 'cli+library'])
+			.default('minimal')
+			.describe('The type of project to create'),
+		'author-name': z.string().default('Eric Mika').describe('The name of the author'),
+		'author-email': z.string().default('eric@ericmika.com').describe('The email of the author'),
+		'author-url': z.string().default('https://ericmika.com').describe('The URL of the author'),
+		'cli-command-name': z
+			.string()
+			.default('new-project')
+			.describe('CLI command name (if applicable)'),
+		// "Future" prefix prevents Bingo from creating a GitHub repository
+		// Pending resolution of https://github.com/bingo-js/bingo/issues/365
+		'github-owner': z
+			.string()
+			.default('kitschpatrol')
+			.describe('The owner of the future repository'),
+		'github-repository': z
+			.string()
+			.default(`new-project`)
+			.describe('The name of the future repository / package'),
+		'npm-otp-command': z
+			.string()
+			.default("op read 'op://Personal/Npmjs/one-time password?attribute=otp'")
+			.describe('A shell command that returns your one-time password for publishing to npm'),
+		/* eslint-enable perfectionist/sort-objects */
+	},
+	async produce(params) {
+		const { options } = params
+
+		return {
+			files: {
+				...(await intakeDirectory(path.join(import.meta.dirname, `../templates/${options.type}`), {
+					exclude: /node_modules|pnpm-lock\.yaml/,
+				})),
+				'license.txt': await handlebars(
+					path.join(import.meta.dirname, `../templates/${options.type}/license.txt`),
+					options,
+				),
+				'package.json': await handlebars(
+					path.join(import.meta.dirname, `../templates/${options.type}/package.json`),
+					options,
+				),
+			},
+			scripts: [
+				{
+					commands: ['pnpm install', 'pnpm run build', 'pnpm run fix'],
+					phase: 0,
+				},
+			],
+		}
+	},
+})

package/stylelint.config.js

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

package/templates/cli/.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/.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/.prettierignore

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

package/templates/cli/.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/.vscode/extensions.json

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

package/templates/cli/.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/cspell.config.js

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

package/templates/cli/eslint.config.ts

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

package/templates/cli/knip.config.ts

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

package/templates/cli/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/mdat.config.ts

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

package/templates/cli/package.json

@@ -0,0 +1,54 @@
+{
+	"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/{{futureGitHubOwner}}/{{github-repository}}.git"
+	},
+	"license": "MIT",
+	"author": {
+		"name": "{{author-name}}",
+		"email": "{{author-email}}",
+		"url": "{{author-url}}"
+	},
+	"type": "module",
+	"bin": {
+		"{{cli-command-name}}": "dist/index.js"
+	},
+	"files": [
+		"dist/*"
+	],
+	"scripts": {
+		"build": "tsdown --dts false",
+		"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/prettier.config.js

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

package/templates/cli/readme.md

@@ -0,0 +1,45 @@
+<!--+ Warning: Content inside HTML comment blocks was generated by mdat and may be overwritten. +-->
+
+<!-- title -->
+
+<!-- badges -->
+
+<!-- short-description -->
+
+## Overview
+
+## Getting started
+
+### Dependencies
+
+### Installation
+
+## Usage
+
+### CLI
+
+<!-- cli-help -->
+
+### 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 -->