@skarab/skaffold

The best way to scaffold a project as I would do it myself.

Features

• 📐 Setup the holy trinity: Prettier, ESLint, TypeScript with my shared configuration.
• 🤖 Setup GitHub Actions to run the trinity on push and pull_request.
• 🔎 Setup lint-staged and simple-git-hooks to run Prettier and ESLint on staged files.
• ✅ Setup Vitest and create a minimal example in the ./test directory.
• 📦 Setup semantic-release for automatic release on NPM via GitHub Actions (see Publishing).

Installation

pnpm add --global @skarab/skaffold

Example

skaffold my-amazing-project
cd ./my-amazing-project
pnpm install
pnpm update # optional

Usage

Usage: skaffold [options] [command]

The best way to scaffold a project as I would do it myself (Kappa).

Options:
  -v, --version            output the version number
  -h, --help               display help for command

Commands:
  create [options] [name]  create a new project
  help [command]           display help for command

Publishing

If you have selected the release feature when creating your project, please check the following points:

1. Make sure you add your NPM_TOKEN as a secret in your repo configuration.

2. Edit the .github/workflows/CI.yml file and uncomment the release job.

3. Edit the package.json and make your project public.

   {
     "private": false,
     "publishConfig": {
       "access": "public"
     }
   }

The next time you push on the main branch your package will be automatically published on NPM 🚀

My shared configurations

• @skarab/eslint-config
• @skarab/prettier-config
• @skarab/typescript-config