@kitschpatrol/create-project

Kitschpatrol's TypeScript project templates.

Overview

This repository contains very basic starter templates for TypeScript projects integrating @kitschpatrol/shared-config.

The lint tools and rules that come along with @kitschpatrol/shared-config are opinionated and draconian, and won't be to everyone's taste.

The templates use tsdown for building TypeScript libraries and Node-based CLI tools, and Vite for web projects. Bingo is used for the project templating system itself.

Getting started

Dependencies

Node.js 20.19.0 or higher and pnpm are required. The generated electron and unplugin templates require Node.js 22.18.0 or higher.

Usage

Create a new project

pnpm create @kitschpatrol/project@latest

CLI options

Bingo template options:

  --directory (string): What local directory path to run under
      npx @kitschpatrol/create-project --directory my-fancy-project

  --help (string): Prints help text.
      npx @kitschpatrol/create-project --help

  --mode ("setup" | "transition"): Which mode to run in.
      npx @kitschpatrol/create-project --mode setup
      npx @kitschpatrol/create-project --mode transition

  --offline (boolean): Whether to run in an "offline" mode that skips network requests.
      npx @kitschpatrol/create-project --offline

  --version (boolean): Prints package versions.
      npx @kitschpatrol/create-project --version

Create Kitschpatrol 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 repository.
  --github-repository (string): The name of the repository / package.
  --npm-auth-command (string): A shell command that sets the NPM_AUTH_TOKEN env variable with a granular token for publishing to npm.

Development Notes

./dist/index.js --directory ~/Desktop/test

Maintainers

kitschpatrol

Acknowledgments

Thanks to Josh Goldberg for creating the Bingo template system.

Contributing

Issues are welcome and appreciated.

Please open an issue to discuss changes before submitting a pull request. Unsolicited PRs (especially AI-generated ones) are unlikely to be merged.

This repository uses @kitschpatrol/shared-config (via its ksc CLI) for linting and formatting, plus MDAT for readme placeholder expansion.

License

MIT © Eric Mika