cruft-spindle-project

Cruft template for a Twine Game configured for Spindle.

Spindle Project (Template)

Standard project configuration template for Twine Games build with Spindle.

Powered by Cookiecutter template engine, meant to be distributed with Cruft.

Usage

Besure to install cruft:

pip3 install cruft

Setup

In a new repository:

cruft create https://github.com/brisberg/cruft-spindle-project/

In an existing repository:

# Link the repo to the bare template
cruft link https://github.com/brisberg/cruft-spindle-project -c v0.0.0
# Update to desired release to apply all the changes
cruft update (-c v1.1.0)

Be sure to keep any project specific config changes.

Update

Check if there are updates upstream:

cruft check

Update to latest:

# Update to latest commit
cruft update
# Update to specific release tag
cruft update -c v1.1.0

Resolve merge conflicts, keeping project specific overrides and deletions.

Verify tests still pass before committing:

yarn test # TODO: Add default testing
# Tests pass
git add .
git commit

Tools

• Spindle - Opinionated Build Tool for Twine
• VSCode - Hackable IDE
• Yarn - Package Manager of choice for node modules
• ESLint - Pluggable lint for Javascript/TypeScript
• clang-format - Code Formatting library

CI

• GitHub Actions - CI Pipelines hosted by GitHub