@alleyinteractive/scaffolder

Scaffolder

This action aids to quickly scaffold templates for a project. Any project can define templates that can be used to quickly scaffold a set of files with pre-defined values.

Usage

Run the package with npx:

npx @alleyinteractive/scaffolder@latest

# Run a specific feature template.
npx @alleyinteractive/scaffolder@latest <feature>

The following arguments are available:

  --root               The root directory of the project. Defaults to the current
                       working directory.
  --debug              Print debug information.
  --dry-run            Run the command without making any changes.
  -h, --help           Prints help information.

If the command is not run from the root of a project with a .scaffolder directory, Scaffolder will attempt to find a .scaffolder configuration in a parent directory. You can also pass the --root argument to specify the root directory of the project.

Documentation

1. Getting Started
2. Features
3. Expressions
4. Writing Stub Files
5. Configuration

Changelog

This project keeps a changelog.

Contributors

Thanks to all of the contributors to this project.

License

This project is licensed under the GNU Public License (GPL) version 2 or later.