@kitschpatrol/create-project 1.1.3 → 1.2.1

package/templates/unplugin/.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/unplugin/.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/unplugin/.gitignore

@@ -0,0 +1,22 @@
+# Git Ignore
+# Also used by CSpell, Stylelint, and ESLint
+
+# @kitschpatrol/repo-config boilerplate
+.astro/
+.DS_Store
+.env
+.env.*
+!.env.example
+.eslint-config-inspector
+.svelte-kit/
+{tmp,temp}/
+**/*.min.js
+/scratch/
+bower_components/
+build/
+coverage/
+dist/
+node_modules/
+vendor/
+
+# Customizations

package/templates/unplugin/.npmrc

@@ -0,0 +1,4 @@
+publish-branch=main
+
+# Required for automated local publishing
+//registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}

package/templates/unplugin/.prettierignore

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

package/templates/unplugin/.remarkrc.js

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

package/templates/unplugin/.vscode/extensions.json

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

package/templates/unplugin/.vscode/settings.json

@@ -0,0 +1,68 @@
+{
+	"[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"
+	},
+	"cSpell.enabled": true,
+	"cSpell.workspaceRootPath": ".",
+	"editor.codeActionsOnSave": {
+		"source.fixAll": "explicit",
+		"source.organizeImports": "never"
+	},
+	"editor.defaultFormatter": "esbenp.prettier-vscode",
+	"editor.formatOnSave": true,
+	"eslint.enable": true,
+	"eslint.runtime": "node",
+	"eslint.useFlatConfig": true,
+	"eslint.validate": [
+		"astro",
+		"html",
+		"javascript",
+		"javascriptreact",
+		"json",
+		"json5",
+		"jsonc",
+		"markdown",
+		"mdx",
+		"svelte",
+		"toml",
+		"typescript",
+		"typescriptreact",
+		"xml",
+		"yaml"
+	],
+	"explorer.fileNesting.enabled": true,
+	"explorer.fileNesting.expand": false,
+	"explorer.fileNesting.patterns": {
+		".env": ".env.*, .template.env",
+		"*.js": "${basename}.ts.map, ${basename}.js.map, ${basename}.d.ts, ${basename}.d.ts.map, ${basename}.d.js.map",
+		"*.ts": "${basename}.ts.map, ${basename}.d.ts, ${basename}.d.ts.map",
+		"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*"
+	},
+	"prettier.documentSelectors": [
+		"**/.eslintignore",
+		"**/.node-version",
+		"**/.npmrc",
+		"**/.prettierignore",
+		"**/*.astro",
+		"**/*.rb",
+		"**/*.svelte"
+	],
+	"prettier.enable": true,
+	"stylelint.enable": true,
+	"stylelint.validate": ["css", "html", "svelte", "astro"],
+	"typescript.enablePromptUseWorkspaceTsdk": true,
+	"typescript.tsdk": "node_modules/typescript/lib"
+}

package/templates/unplugin/cspell.config.js

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

package/templates/unplugin/eslint.config.ts

@@ -0,0 +1,11 @@
+import { eslintConfig } from '@kitschpatrol/eslint-config'
+
+export default eslintConfig({
+	ignores: ['/tests/fixtures/**'],
+	ts: {
+		overrides: {
+			'ts/consistent-type-definitions': 'off',
+		},
+	},
+	type: 'lib',
+})

package/templates/unplugin/knip.config.ts

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

package/templates/unplugin/license.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) {{{year}}} {{{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/unplugin/mdat.config.ts

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

package/templates/unplugin/package.json

@@ -0,0 +1,82 @@
+{
+	"name": "{{{github-repository}}}",
+	"version": "0.0.0",
+	"description": "An unplugin project",
+	"keywords": [
+		"unplugin",
+		"vite",
+		"webpack",
+		"rspack",
+		"rollup",
+		"rolldown",
+		"esbuild",
+		"farm",
+		"transform",
+		"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": {
+		".": "./dist/index.js",
+		"./*": "./*",
+		"./api": "./dist/api.js",
+		"./esbuild": "./dist/esbuild.js",
+		"./farm": "./dist/farm.js",
+		"./rolldown": "./dist/rolldown.js",
+		"./rollup": "./dist/rollup.js",
+		"./rspack": "./dist/rspack.js",
+		"./vite": "./dist/vite.js",
+		"./webpack": "./dist/webpack.js"
+	},
+	"main": "./dist/index.js",
+	"module": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"typesVersions": {
+		"*": {
+			"*": [
+				"./dist/*",
+				"./*"
+			]
+		}
+	},
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "tsdown",
+		"clean": "git rm -f pnpm-lock.yaml ; git clean -fdX",
+		"dev": "tsdown --watch",
+		"fix": "ksc fix",
+		"lint": "ksc lint",
+		"release": "bumpp --commit 'Release: %s' && pnpm run build && NPM_AUTH_TOKEN=$(op read 'op://Personal/npm/token') && pnpm publish",
+		"test": "vitest"
+	},
+	"dependencies": {
+		"@types/node": "~22.16.5",
+		"unplugin": "^2.3.11",
+		"unplugin-utils": "^0.3.1"
+	},
+	"devDependencies": {
+		"@kitschpatrol/shared-config": "^5.10.0",
+		"@sxzz/test-utils": "^0.5.15",
+		"bumpp": "^10.3.2",
+		"tsdown": "^0.18.3",
+		"typescript": "~5.9.3",
+		"vitest": "^4.0.16"
+	},
+	"packageManager": "pnpm@10.26.2",
+	"engines": {
+		"node": ">=22.16.0"
+	}
+}

package/templates/unplugin/pnpm-workspace.yaml

@@ -0,0 +1,17 @@
+# Required by @kitschpatrol/shared-config
+
+onlyBuiltDependencies:
+  - esbuild
+  - unrs-resolver
+
+publicHoistPattern:
+  - '@kitschpatrol/repo-config'
+  - '@kitschpatrol/typescript-config'
+  - 'case-police'
+  - '*cspell*'
+  - '*eslint*'
+  - '*knip*'
+  - '*mdat*'
+  - '*prettier*'
+  - '*remark*'
+  - '*stylelint*'

package/templates/unplugin/prettier.config.js

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

package/templates/unplugin/readme.md

@@ -0,0 +1,27 @@
+<!--+ Warning: Content inside HTML comment blocks was generated by mdat and may be overwritten. +-->
+
+<!-- title -->
+
+<!-- badges -->
+
+<!-- short-description -->
+
+## Overview
+
+## Getting started
+
+### Dependencies
+
+### Deployment
+
+## 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/unplugin/src/api.ts

@@ -0,0 +1,2 @@
+// eslint-disable-next-line unicorn/require-module-specifiers
+export {}

package/templates/unplugin/src/core/options.ts

@@ -0,0 +1,28 @@
+import type { FilterPattern } from 'unplugin-utils'
+
+/**
+ * @public
+ */
+export interface Options {
+	enforce?: 'post' | 'pre' | undefined
+	exclude?: FilterPattern
+	include?: FilterPattern
+}
+
+type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U
+
+/**
+ * @public
+ */
+export type OptionsResolved = Overwrite<Required<Options>, Pick<Options, 'enforce'>>
+
+/**
+ * Resolve and normalize user options.
+ */
+export function resolveOptions(options: Options): OptionsResolved {
+	return {
+		enforce: 'enforce' in options ? options.enforce : 'pre',
+		exclude: options.exclude ?? [/node_modules/],
+		include: options.include ?? [/\.[cm]?[jt]sx?$/],
+	}
+}

package/templates/unplugin/src/esbuild.ts

@@ -0,0 +1,22 @@
+/**
+ * This entry file is for esbuild plugin.
+ * @module
+ */
+
+import { starter } from './index'
+
+// @case-police-ignore esbuild
+
+/**
+ * Esbuild plugin
+ * @example
+ * ```ts
+ * import { build } from 'esbuild'
+ * import starter from '{{{github-repository}}}/esbuild'
+ * 
+ * build({ plugins: [starter()] })
+```
+ */
+const { esbuild } = starter
+export default esbuild
+export { esbuild as 'module.exports' }

package/templates/unplugin/src/farm.ts

@@ -0,0 +1,22 @@
+/**
+ * This entry file is for Farm plugin.
+ * @module
+ */
+
+import { starter } from './index'
+
+/**
+ * Farm plugin
+ * @example
+ * ```ts
+ * // farm.config.js
+ * import starter from '{{{github-repository}}}/farm'
+ *
+ * export default {
+ *   plugins: [starter()],
+ * }
+ * ```
+ */
+const { farm } = starter
+export default farm
+export { farm as 'module.exports' }

package/templates/unplugin/src/index.ts

@@ -0,0 +1,27 @@
+import type { UnpluginInstance } from 'unplugin'
+import { createUnplugin } from 'unplugin'
+import { createFilter } from 'unplugin-utils'
+import type { Options } from './core/options'
+import { resolveOptions } from './core/options'
+
+/**
+ * A starter unplugin template.
+ */
+export const starter: UnpluginInstance<Options | undefined, false> = createUnplugin(
+	(rawOptions = {}) => {
+		const options = resolveOptions(rawOptions)
+		const filter = createFilter(options.include, options.exclude)
+
+		const name = '{{{github-repository}}}'
+		return {
+			enforce: options.enforce,
+			name,
+			transform(code, _id) {
+				return `// {{{github-repository}}} injected\n${code}`
+			},
+			transformInclude(id) {
+				return filter(id)
+			},
+		}
+	},
+)

package/templates/unplugin/src/rolldown.ts

@@ -0,0 +1,22 @@
+/**
+ * This entry file is for Rolldown plugin.
+ * @module
+ */
+
+import { starter } from './index'
+
+/**
+ * Rolldown plugin
+ * @example
+ * ```ts
+ * // rolldown.config.js
+ * import starter from '{{{github-repository}}}/rolldown'
+ *
+ * export default {
+ *   plugins: [starter()],
+ * }
+ * ```
+ */
+const { rolldown } = starter
+export default rolldown
+export { rolldown as 'module.exports' }

package/templates/unplugin/src/rollup.ts

@@ -0,0 +1,22 @@
+/**
+ * This entry file is for Rollup plugin.
+ * @module
+ */
+
+import { starter } from './index'
+
+/**
+ * Rollup plugin
+ * @example
+ * ```ts
+ * // rollup.config.js
+ * import starter from '{{{github-repository}}}/rollup'
+ *
+ * export default {
+ *   plugins: [starter()],
+ * }
+ * ```
+ */
+const { rollup } = starter
+export default rollup
+export { rollup as 'module.exports' }

package/templates/unplugin/src/rspack.ts

@@ -0,0 +1,22 @@
+/**
+ * This entry file is for Rspack plugin.
+ * @module
+ */
+
+import { starter } from './index'
+
+/**
+ * Rspack plugin
+ * @example
+ * ```js
+ * // rspack.config.js
+ * import starter from '{{{github-repository}}}/rspack'
+ *
+ * export default {
+ *   plugins: [starter()],
+ * }
+ * ```
+ */
+const { rspack } = starter
+export default rspack
+export { rspack as 'module.exports' }

package/templates/unplugin/src/vite.ts

@@ -0,0 +1,22 @@
+/**
+ * This entry file is for Vite plugin.
+ * @module
+ */
+
+import { starter } from './index'
+
+/**
+ * Vite plugin
+ * @example
+ * ```ts
+ * // vite.config.ts
+ * import starter from '{{{github-repository}}}/vite'
+ *
+ * export default defineConfig({
+ *   plugins: [starter()],
+ * })
+ * ```
+ */
+const { vite } = starter
+export default vite
+export { vite as 'module.exports' }

package/templates/unplugin/src/webpack.ts

@@ -0,0 +1,24 @@
+/**
+ * This entry file is for webpack plugin.
+ * @module
+ */
+
+import { starter } from './index'
+
+// @case-police-ignore webpack
+
+/**
+ * Webpack plugin
+ * @example
+ * ```js
+ * // webpack.config.js
+ * import starter from '{{{github-repository}}}/webpack'
+ *
+ * export default {
+ *   plugins: [starter()],
+ * }
+ * ```
+ */
+const { webpack } = starter
+export default webpack
+export { webpack as 'module.exports' }

package/templates/unplugin/stylelint.config.js

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

package/templates/unplugin/tests/__snapshots__/rollup.test.ts.snap

@@ -0,0 +1,10 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`rollup > basic.js 1`] = `
+"// basic.js
+// {{{github-repository}}} injected
+const someValue = 10;
+
+export { someValue };
+"
+`;

package/templates/unplugin/tests/fixtures/basic.js

@@ -0,0 +1 @@
+export const someValue = 10