Project Base

This project holds templates of the baseline configurations used for projects I maintain. It is based around copier which is used to template and copy the project contents into a new project when executed.

Supported tools

• commitlint - Linting for commit messages
• Dev Containers - Development environment in a container
• EditorConfig - IDE whitespace configuration
• lint-staged - Linting for project files
• MkDocs - Project documentation
• pre-commit - Git hooks
• Prettier - Code formatter
• Renovate - Dependency updater
• Taskfile - Project task runner

Docker image

This project includes a simple Docker container which may be used to execute copier without needing to install it on the machine. This container may be executed on the contents of the current working directory as follows:

docker container run -ti --rm -v $(pwd):/project jwbennet/copier:9.1.1 gh:jwbennet/project-base

You may substitute other copier templates by changing the name referenced above from gh:jwbennet/project-base (see copier's documentation on generating a project). This has primarily been tested on the Windows Subsystem for Linux where the default UID is 1000 which matches the user ID within the container. If your UID does not match you may need to change the owner of the files to your current user ID after the container is complete. Another alternative is to install copier directly on your machine which bypasses the complication of running inside the container.