@pixpilot/scaffoldfy-configs

A collection of reusable scaffoldfy templates for generating common project configuration files and setups.

Installation

npm install @pixpilot/scaffoldfy @pixpilot/scaffoldfy-configs

Available Templates

This package provides the following scaffoldfy templates:

codeql-private-repo

Replaces the CodeQL workflow with the pixpilot/codeql-scanner action for private repositories

Usage:

npx @pixpilot/scaffoldfy@latest --config https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/codeql-private-repo/scaffoldfy.json

feature-package-generator

Generate a feature package for a Stackforge workspace: db, services, trpc, types, client and ui entry points, a dashboard page and a PGlite test database. Extend it to add entry points, dependencies or files.

Usage:

npx @pixpilot/scaffoldfy@latest --config https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/feature-package-generator/scaffoldfy.json

github-action-release-app-token

Replaces the release workflow of a github-action-template clone with the GitHub App token variant (RELEASER_ID / RELEASER_PRIVATE_KEY) for pixpilot and ccpu repositories

Usage:

npx @pixpilot/scaffoldfy@latest --config https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/github-action-release-app-token/scaffoldfy.json

license-file

Generate a LICENSE file with common open-source licenses

Usage:

npx @pixpilot/scaffoldfy@latest --config https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/license-file/scaffoldfy.json

monorepo-generate-packages-section

Generates packages section in monorepo README by reading package.json files

Usage:

npx @pixpilot/scaffoldfy@latest --config https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/monorepo-generate-packages-section/scaffoldfy.json

pixpilot-changesets-release

Pixpilot workspace package generator template for pnpm + Turbo monorepo. Provides project info prompts and config tasks.

Usage:

npx @pixpilot/scaffoldfy@latest --config https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/pixpilot-changesets-release/scaffoldfy.json

pixpilot-copilot-instructions

GitHub Copilot instructions template for Pixpilot projects

Usage:

npx @pixpilot/scaffoldfy@latest --config https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/pixpilot-copilot-instructions/scaffoldfy.json

pixpilot-info

Project information prompts for pnpm-turbo-monorepo-template

Usage:

npx @pixpilot/scaffoldfy@latest --config https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/pixpilot-info/scaffoldfy.json

project-info

Project information prompts for pnpm-turbo-monorepo-template

Usage:

npx @pixpilot/scaffoldfy@latest --config https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/project-info/scaffoldfy.json

security-policy

Security policy template with configurable contact email

Usage:

npx @pixpilot/scaffoldfy@latest --config https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/security-policy/scaffoldfy.json

setup-guard

Removes a template's one-time setup gate: strips the guard script from package.json and the git hooks so a generated project stops nagging about an initializer it has already run. Extend this first, and add a delete task in your own config to remove the guard's folder once nothing else needs it.

Usage:

npx @pixpilot/scaffoldfy@latest --config https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/setup-guard/scaffoldfy.json

turbo-workspace-package-generator

Pixpilot workspace package generator template for pnpm + Turbo monorepo. Provides project info prompts and config tasks.

Usage:

npx @pixpilot/scaffoldfy@latest --config https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/turbo-workspace-package-generator/scaffoldfy.json

update-root-package-json

Update root package.json with repository information

Usage:

npx @pixpilot/scaffoldfy@latest --config https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/update-root-package-json/scaffoldfy.json

workspace-initializer

Initial setup for a pnpm + Turbo monorepo template, including project info, license, and initial package generation.

Usage:

npx @pixpilot/scaffoldfy@latest --config https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/workspace-initializer/scaffoldfy.json

workspace-package-generator

Generate a new package for a pnpm + Turbo monorepo workspace

Usage:

npx @pixpilot/scaffoldfy@latest --config https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/workspace-package-generator/scaffoldfy.json

workspace-package-generator/experiment

Generate a new package for a pnpm + Turbo monorepo workspace

Usage:

npx @pixpilot/scaffoldfy@latest --config https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/workspace-package-generator/experiment/scaffoldfy.json

Usage

After installing both @pixpilot/scaffoldfy and @pixpilot/scaffoldfy-configs, you can use any of the templates by referencing them in your scaffoldfy configuration.

Run the workspace package generator from the pnpm workspace root with pnpm on the PATH. After entering a package name, select an existing parent directory that matches pnpm-workspace.yaml. Existing package directories, excluded paths, and destinations that already exist are omitted. Empty groups are included; create a group directory first if it does not exist. Location discovery requires Node.js 22.5 or newer and ignores paths containing shell-sensitive characters.

Example: Using the license-file template

Create a scaffoldfy.json file in your project:

{
  "$schema": "https://unpkg.com/@pixpilot/scaffoldfy/schema",
  "extends": ["@pixpilot/scaffoldfy-configs/license-file"]
}

Then run:

npx @pixpilot/scaffoldfy

Combining multiple templates

{
  "$schema": "https://unpkg.com/@pixpilot/scaffoldfy/schema",
  "extends": [
    "@pixpilot/scaffoldfy-configs/project-info",
    "@pixpilot/scaffoldfy-configs/license-file",
    "@pixpilot/scaffoldfy-configs/pixpilot-changesets-release"
  ]
}

Contributing

This package contains scaffoldfy templates that can be used individually or combined. Each template is self-contained in its own directory with a scaffoldfy.json configuration file.

To add a new template:

1. Create a new directory under packages/scaffoldfy-configs/
2. Add a scaffoldfy.json file with your template configuration
3. Include any template files or assets your template needs

License

MIT