MfGames Project Setup Flake Options

This document describes all available configuration options for the mfgames-project-setup-flake module.

Options

mfgames.project.conform.enable

Enables using conform for linting Git commits.

Defaults to mfgames.project.enable.

• Type: bool
• Default: false

mfgames.project.conform.scopes

The scopes the project is limited to use, or null to allow all scopes.

• Type: nullOr(listOf(str))
• Default: null

mfgames.project.contributorCovenant.contact

The email address to contact for violations.

• Type: str
• Default: null

mfgames.project.contributorCovenant.enable

Enables writing out a contribuator covenant file.

• Type: bool
• Default: false

mfgames.project.developerCertificateOfOrigin.enable

Enables writing out a DCO.md file.

• Type: bool
• Default: false

mfgames.project.dotnet.csharpier

Enables using csharpier to format the file.

• Type: bool
• Default: false

mfgames.project.dotnet.enable

Enables writing out a DCO.md file.

• Type: bool
• Default: false

mfgames.project.dotnet.format

Enables using ‘dotnet format’ to format the file.

• Type: bool
• Default: false

mfgames.project.enable

Whether to enable MfGames Project Setup.

• Type: bool
• Default: false
• Example: true

mfgames.project.just.enable

Generates a missing top-level Justfile with common defaults and adds a src/just/mfgames-project-setup.just with rules based on other configuration settings. This is based on D. Moonfire's Project Layout setup.

Defaults to mfgames.project.enable.

• Type: bool
• Default: false

mfgames.project.just.generate

Generate the top-level Justfile if not present.

• Type: bool
• Default: true

mfgames.project.mfgames-conventional-commit.enable

Enable mfgames-conventional-commit integration.

Defaults to mfgames.project.enable.

• Type: bool
• Default: false

mfgames.project.mfgames-conventional-commit.package

The mfgames-conventional-commit package to use.

• Type: nullOr(str)
• Default: null

mfgames.project.prettier.enable

Enables using prettier to format files.

• Type: bool
• Default: false

mfgames.project.prettier.proseWrap

Sets the default for wrapping prose.

• Type: str
• Default: "preserve"

mfgames.project.project-uuid.enable

Generate a .config/project-uuid.txt if missing.

Defaults to mfgames.project.enable.

• Type: bool
• Default: false

mfgames.project.reuse.annotations

Additional annotations to add to the top-level REUSE.toml block. See the REUSE specification for more information.

• Type: listOf(submodule)
• Default: [ ]
• Example:

[
  {
    "SPDX-FileCopyrightText": "2026 Dylan Moonfire <contact@mfgames.com>",
    "SPDX-License-Identifier": "CC-BY-4.0",
    "path": [
      "README.md",
      "TASKS.md"
    ]
  },
  {
    "SPDX-FileCopyrightText": "2026 Dylan Moonfire <contact@mfgames.com>",
    "SPDX-License-Identifier": "MIT",
    "path": "src/**/*"
  }
]

mfgames.project.reuse.enable

Enables using REUSE for license management and checking.

Defaults to mfgames.project.enable.

• Type: bool
• Default: false

mfgames.project.reuse.ignore-dot-config

Annotate the REUSE description of everything in the .config/ directory as having no copyright (NONE) and public domain (CC0-1.0).

• Type: bool
• Default: true

mfgames.project.rust.enable

Enables writing out Rust support files.

• Type: bool
• Default: false

mfgames.project.shell.check

Runs shellcheck against all shell files.

Defaults to mfgames.project.shell.enable.

• Type: bool
• Default: false

mfgames.project.shell.enable

Enables formatting and checking shell files.

Defaults to mfgames.project.enable.

• Type: bool
• Default: false

mfgames.project.shell.excludes

Lists exclude match patterns, globbing including **, to check or format.

• Type: listOf(str)
• Default: [ ]

mfgames.project.shell.format

Formats shells according to shfmt.

Defaults to mfgames.project.shell.enable.

• Type: bool
• Default: false

mfgames.project.shell.includes

Lists include match patterns, globbing including **, to check or format.

• Type: listOf(str)
• Default: [ "*.sh" ]

mfgames.project.sql.enable

Enables formatting of SQL files.

• Type: bool
• Default: false

mfgames.project.sql.excludes

Lists exclude match patterns, globbing including **, to check or format.

• Type: listOf(str)
• Default: [ ]

mfgames.project.sql.format

Formats SQL scripts according to sql-formatter.

Defaults to mfgames.project.sql.enable.

• Type: bool
• Default: false

mfgames.project.sql.includes

Lists include match patterns, globbing including **, to check or format.

• Type: listOf(str)
• Default: [ "*.sql" ]

mfgames.project.sql.language

Sets the language for formatting the SQL.

• Type: str
• Default: "sql"