@kitschpatrol/create-project 1.0.3 → 1.1.0

package/templates/cli/src/index.ts

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 
+import { log, setDefaultLogOptions } from 'lognow'
 import yargs from 'yargs'
 import { hideBin } from 'yargs/helpers'
 import { bin, version } from '../package.json'
@@ -12,15 +13,36 @@ await yargsInstance
 	.scriptName(cliCommandName)
 	.usage('$0 [command]', `Run a ${cliCommandName} command.`)
 	.option('verbose', {
+		default: false,
 		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')
+	.middleware((argv) => {
+		// Set log level globally based on verbose flag
+		setDefaultLogOptions({ verbose: argv.verbose })
 	})
+	.command(
+		['$0', 'do-something'],
+		'Run the do-something command.',
+		() => {
+			// Options go here
+		},
+		() => {
+			log.debug('Running command...')
+			process.stdout.write('Did something!\n')
+		},
+	)
+	.command(
+		'do-something-else',
+		'Run the do-something-else command.',
+		() => {
+			// Options go here
+		},
+		() => {
+			log.debug('Running command...')
+			process.stdout.write('Did something else!\n')
+		},
+	)
 	.alias('h', 'help')
 	.version(version)
 	.alias('v', 'version')

package/templates/cli+library/.npmrc

@@ -11,3 +11,6 @@ public-hoist-pattern[]=*mdat*
 public-hoist-pattern[]=*prettier*
 public-hoist-pattern[]=*remark*
 public-hoist-pattern[]=*stylelint*
+
+# Required for automated local publishing
+//registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}

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

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

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

@@ -2,8 +2,8 @@
 	"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",
+		"*.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",
 		".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*"

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

@@ -1,3 +1,8 @@
 import { mdatConfig } from '@kitschpatrol/mdat-config'
+import cliHelpPlugin from 'mdat-plugin-cli-help'
 
-export default mdatConfig()
+export default mdatConfig({
+	rules: {
+		...cliHelpPlugin,
+	},
+})

package/templates/cli+library/package.json

@@ -21,8 +21,8 @@
 	"type": "module",
 	"exports": {
 		".": {
-			"import": "./dist/lib/index.js",
-			"types": "./dist/lib/index.d.ts"
+			"types": "./dist/lib/index.d.ts",
+			"import": "./dist/lib/index.js"
 		}
 	},
 	"main": "./dist/lib/index.js",
@@ -38,21 +38,23 @@
 		"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}})",
+		"release": "bumpp --commit 'Release: %s' && pnpm run build && NPM_AUTH_TOKEN=$({{npm-auth-command}}) && pnpm publish",
 		"test": "echo \"Error: no test specified\" && exit 1"
 	},
 	"dependencies": {
-		"@types/node": "^20.19.21",
-		"@types/yargs": "^17.0.33",
+		"@types/node": "^20.19.24",
+		"@types/yargs": "^17.0.34",
+		"lognow": "^0.2.1",
 		"yargs": "^17.7.2"
 	},
 	"devDependencies": {
-		"@kitschpatrol/shared-config": "^5.7.2",
+		"@kitschpatrol/shared-config": "^5.8.0",
 		"bumpp": "^10.3.1",
-		"tsdown": "^0.15.7",
+		"mdat-plugin-cli-help": "^1.0.1",
+		"tsdown": "^0.15.12",
 		"typescript": "~5.9.3"
 	},
-	"packageManager": "pnpm@10.18.3",
+	"packageManager": "pnpm@10.20.0",
 	"engines": {
 		"node": ">=20.19.0"
 	},

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

@@ -3,8 +3,10 @@
 import yargs from 'yargs'
 import { hideBin } from 'yargs/helpers'
 import { version, bin } from '../../package.json'
+import { log, setDefaultLogOptions } from 'lognow'
+import { doSomething, doSomethingElse, setLogger } from '../lib'
 
-import { doSomething, doSomethingElse } from '../lib'
+setLogger(log)
 
 const cliCommandName = Object.keys(bin).at(0)!
 const yargsInstance = yargs(hideBin(process.argv))
@@ -17,20 +19,30 @@ await yargsInstance
 		description: 'Run with verbose logging',
 		type: 'boolean',
 	})
+	.middleware((argv) => {
+		// Set log level globally based on verbose flag
+		setDefaultLogOptions({ verbose: argv.verbose })
+	})
 	.command(
 		['$0', 'do-something'],
 		'Run the do-something command.',
-		() => {},
-		async () => {
-			process.stdout.write(doSomething())
+		() => {
+			// Options go here
+		},
+		() => {
+			log.debug('Running command...')
+			process.stdout.write(doSomething() + '\n')
 		},
 	)
 	.command(
 		'do-something-else',
 		'Run the do-something-else command.',
-		() => {},
-		async () => {
-			process.stdout.write(doSomethingElse())
+		() => {
+			// Options go here
+		},
+		() => {
+			log.debug('Running command...')
+			process.stdout.write(doSomethingElse() + '\n')
 		},
 	)
 	.alias('h', 'help')

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

@@ -1,7 +1,10 @@
+import { log } from './log'
+
 /**
  * Do something.
  */
 export function doSomething(): string {
+	log.info('Doing something...')
 	return 'Something happened'
 }
 
@@ -9,5 +12,8 @@ export function doSomething(): string {
  * Do something else.
  */
 export function doSomethingElse(): string {
+	log.info('Doing something else...')
 	return 'Something else happened'
 }
+
+export { setLogger } from './log'

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

@@ -0,0 +1,16 @@
+import type { ILogBasic, ILogLayer } from 'lognow'
+import { createLogger, injectionHelper } from 'lognow'
+
+/**
+ * The default logger instance for the library.
+ */
+export let log = createLogger()
+
+/**
+ * Set the logger instance for the module.
+ * Export this for library consumers to inject their own logger.
+ * @param logger - Accepts either a LogLayer instance or a Console- or Stream-like log target
+ */
+export function setLogger(logger?: ILogBasic | ILogLayer) {
+	log = injectionHelper(logger)
+}

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

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

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

@@ -0,0 +1,24 @@
+# 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
+dist-electron/
+release/

package/templates/electron/.npmrc

@@ -0,0 +1,16 @@
+publish-branch=main
+
+# Required for using @kitschpatrol/shared-config and the ksc command with pnpm
+public-hoist-pattern[]=@kitschpatrol/repo-config
+public-hoist-pattern[]=@kitschpatrol/typescript-config
+public-hoist-pattern[]=case-police
+public-hoist-pattern[]=*cspell*
+public-hoist-pattern[]=*eslint*
+public-hoist-pattern[]=*knip*
+public-hoist-pattern[]=*mdat*
+public-hoist-pattern[]=*prettier*
+public-hoist-pattern[]=*remark*
+public-hoist-pattern[]=*stylelint*
+
+# Required for automated local publishing
+//registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}

package/templates/electron/.prettierignore

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

package/templates/electron/.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/electron/.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/electron/.vscode/settings.json

@@ -0,0 +1,68 @@
+{
+	"explorer.fileNesting.enabled": true,
+	"explorer.fileNesting.expand": false,
+	"explorer.fileNesting.patterns": {
+		"*.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",
+		".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/electron/cspell.config.js

@@ -0,0 +1,5 @@
+import { cspellConfig } from '@kitschpatrol/cspell-config'
+
+export default cspellConfig({
+	words: ['asar', 'nsis'],
+})

package/templates/electron/electron/electron-env.d.ts

@@ -0,0 +1,29 @@
+/* eslint-disable ts/consistent-type-definitions */
+/* eslint-disable ts/naming-convention */
+
+declare namespace NodeJS {
+	interface ProcessEnv {
+		/**
+		 * The built directory structure
+		 *
+		 * ```tree
+		 * ├─┬ dist
+		 * │ ├─┬ electron
+		 * │ │ ├── main.js
+		 * │ │ └── preload.js
+		 * │ ├── index.html
+		 * │ ├── ...other-static-files-from-public
+		 * │
+		 * ```
+		 */
+		DIST: string
+		/** /dist/ or /public/ */
+		VITE_PUBLIC: string
+	}
+}
+
+// Used in Renderer process, expose in `preload.ts`
+interface Window {
+	// eslint-disable-next-line ts/consistent-type-imports
+	ipcRenderer: import('electron').IpcRenderer
+}

package/templates/electron/electron/main.ts

@@ -0,0 +1,50 @@
+import { app, BrowserWindow } from 'electron'
+import { log } from 'lognow/electron'
+import path from 'node:path'
+
+process.env.ELECTRON_DISABLE_SECURITY_WARNINGS = 'true'
+process.env.DIST = path.join(import.meta.dirname, '../dist')
+process.env.VITE_PUBLIC = app.isPackaged
+	? process.env.DIST
+	: path.join(process.env.DIST, '../public')
+
+if (!app.requestSingleInstanceLock()) {
+	app.quit()
+	process.exit(0)
+}
+
+let win: BrowserWindow | undefined
+
+async function createWindow() {
+	win = new BrowserWindow({
+		icon: path.join(process.env.VITE_PUBLIC, 'logo.svg'),
+		webPreferences: {
+			preload: path.join(import.meta.dirname, './preload.mjs'),
+		},
+	})
+
+	// Test active push message to Renderer-process.
+	win.webContents.on('did-finish-load', () => {
+		win?.webContents.send('main-process-message', new Date().toLocaleString())
+	})
+
+	if (process.env.VITE_DEV_SERVER_URL) {
+		await win.loadURL(process.env.VITE_DEV_SERVER_URL)
+		win.webContents.openDevTools()
+	} else {
+		//
+		// win.loadFile('dist/index.html')
+		await win.loadFile(path.join(process.env.DIST, 'index.html'))
+	}
+
+	log.info('Hello from Main!')
+}
+
+app.on('window-all-closed', () => {
+	app.quit()
+	win = undefined
+})
+
+app.on('ready', () => {
+	void createWindow()
+})