dnd-mapp/project-template

Template repository for bootstrapping new dnd-mapp repositories, with shared tooling and CI pre-configured.

Prerequisites

• mise (recommended): manages the Node.js and pnpm versions this repo pins in package.json's devEngines field. Run mise install after installing it to pick up matching versions automatically.

Installation

Click Use this template on GitHub to create a new repository from this one. In the new repository, install dependencies and set up the Husky git hooks:

pnpm install

Then update package.json's name and description, and this README, to match the new repository.

Editor setup

Configure your editor to run Prettier on save, so files match this repo's .prettierrc.json without needing pnpm format before every commit.

• VS Code: install the recommended Prettier extension (VS Code prompts for it automatically via .vscode/extensions.json), then add to your settings.json:

  {
      "editor.defaultFormatter": "esbenp.prettier-vscode",
      "editor.formatOnSave": true
  }

• WebStorm: open Settings → Languages & Frameworks → JavaScript → Prettier, and check Run on save. WebStorm auto-detects the local prettier package and this repo's config.

Usage

pnpm format        # Format all files with Prettier
pnpm format-check  # Check formatting without writing changes
pnpm lint-md       # Lint Markdown files with markdownlint-cli2

Husky and lint-staged run Prettier and markdownlint on staged files before each commit. GitHub Actions runs the same checks on every pull request and on pushes to main (see .github/workflows/). It also validates commit messages against Conventional Commits via commitlint.

Contributing

See Creating a Pull Request for how to open a pull request in any dnd-mapp repository.

License

MIT