Skip to main content

A fast, configurable Fortran formatter with Fypp, Doxygen, and OpenACC/OpenMP support

Project description

ffmt

PyPI CI License: MIT GitHub Marketplace

A fast, configurable Fortran formatter with support for Fypp, Doxygen, and OpenACC/OpenMP directives. Written in Rust. Installable via pip.

Installation

pip install ffmt

Or via Cargo:

cargo install ffmt

Usage

ffmt src/                        # format in-place
ffmt --check src/                # CI mode (exit 1 if changes needed)
ffmt --diff src/                 # show colored diff
ffmt -j 8 src/                   # parallel
cat file.fpp | ffmt -            # stdin/stdout
ffmt --range 10:50 file.fpp      # format only lines 10-50

What it does

  • Indentation -- scope-based indentation for all Fortran constructs
  • Whitespace -- consistent spacing around operators, commas, colons, parentheses
  • Keywords -- case normalization (IF -> if, ENDDO -> end do)
  • Continuation lines -- normalized with proportional re-indentation
  • Preprocessor -- Fypp (#:if, #:for), OpenACC (!$acc), OpenMP (!$omp) handled correctly

Configuration

Create ffmt.toml or add [tool.ffmt] to pyproject.toml. All options have sensible defaults -- most projects need no config file at all.

General

Option Default Description
indent-width 4 Number of spaces per indentation level.
line-length 132 Maximum line length. Code and comments are wrapped at this limit. Set to 1000 to disable wrapping.
keyword-case "lower" Case for Fortran keywords: "lower", "upper", or "preserve".
normalize-keywords true Split compound keywords like enddo into end do.
named-ends true Add procedure/module name to bare end statements (end subroutine -> end subroutine s_foo).
align-declarations true Vertically align :: in consecutive declaration blocks.
unicode-to-ascii true Replace Unicode Greek letters and math symbols with LaTeX equivalents in comments (σ -> \sigma).
rewrap-comments true Re-wrap long comments at line-length, splitting at word boundaries. Doxygen !> / !! blocks are joined and re-wrapped as units.
rewrap-code true Re-wrap long code lines at line-length using token-aware splitting (never breaks inside numbers or strings).
space-after-comment true Ensure a space after ! in regular comments (!comment -> ! comment). Does not affect !$acc, !<, !>, !!, or !&.
collapse-double-spaces true Collapse runs of multiple spaces to a single space in code (not in strings or comments).
keyword-paren-space true Add a space between control-flow keywords and ( (if( -> if (). Applies to if, call, allocate, select case, where, etc.
fypp-list-commas true Normalize comma spacing inside Fypp '[...]' list arguments.
indent-fypp true Indent Fypp preprocessor blocks (#:if, #:for, #:call).
indent-module true Indent the body of module and program blocks.

Whitespace

The [whitespace] section controls spacing around specific operators:

Option Default Description
relational true Space around ==, /=, <, <=, >, >=.
logical true Space around .and., .or., .not., .eqv., .neqv..
plusminus true Space around binary + and -.
multdiv false Space around * and /.
power false Space around **.
assignment true Space around = in assignments.
pointer true Space around =>.
concatenation true Space around // (string concatenation).
declaration true Space around :: in declarations.
comma true Space after ,.
slice-colon false Space around : in array slices.

Files

Option Default Description
extensions ["fpp", "f90", "F90", "f95", "f03", "F", "F95", "F03"] File extensions to format.
exclude [] Glob patterns to exclude.
respect-gitignore true Skip files listed in .gitignore.

Example

indent-width = 4
line-length = 132
keyword-case = "lower"
normalize-keywords = true

[whitespace]
relational = true
logical = true
plusminus = true
multdiv = false
power = false
assignment = true
declaration = true
comma = true

Preserved as-is

  • String literals and inline expressions (${...}$, @{...}@)
  • Comment contents and Doxygen alignment (!<, !>, !!)
  • Continuation line structure across #ifdef/#:if preprocessor blocks
  • #ifdef/#endif blocks (no indentation change)
  • Fypp/Python code inside $: and @: macro invocations

Editor integration

ffmt includes a built-in LSP server for real-time format-on-save:

ffmt --lsp

VS Code

{
    "fortran.formatting.formatter": "ffmt",
    "fortran.formatting.args": ["--stdin-filepath", "${file}", "-"]
}

Vim/Neovim

autocmd BufWritePost *.fpp,*.f90 silent !ffmt %
" Or: set formatprg=ffmt\ -

Neovim (LSP)

vim.lsp.start({
    name = "ffmt",
    cmd = { "ffmt", "--lsp" },
    root_dir = vim.fs.dirname(vim.fs.find({ "ffmt.toml", "pyproject.toml" }, { upward = true })[1]),
})

CI integration

GitHub Actions

- uses: sbryngelson/ffmt@latest
  with:
    args: "--check src/"

pre-commit

repos:
  - repo: https://github.com/sbryngelson/ffmt
    rev: v0.2.1
    hooks:
      - id: ffmt

To auto-update to the latest version, run:

pre-commit autoupdate

Or use pre-commit.ci to update hooks automatically via pull requests.

Other Fortran Formatters

Formatter Language Status Notes
fprettify Python Unmaintained (last release 2020) Free-form only. Fypp support. Requires multiple passes for convergence.
findent C Active Indentation and fixed/free conversion. No whitespace normalization.
Codee Formatter Proprietary Active Commercial. Tree-sitter based. Fixed and free-form.
LFortran fmt Rust In development AST-based. Part of the LFortran compiler project.
Fortitude Rust Active Linter with auto-fix, not a full formatter. Tree-sitter based.
f90-mode Emacs Lisp Active Emacs built-in. Indentation only.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ffmt-0.2.5.tar.gz (66.0 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

ffmt-0.2.5-py3-none-win_amd64.whl (1.5 MB view details)

Uploaded Python 3Windows x86-64

ffmt-0.2.5-py3-none-manylinux_2_34_x86_64.whl (1.8 MB view details)

Uploaded Python 3manylinux: glibc 2.34+ x86-64

ffmt-0.2.5-py3-none-macosx_11_0_arm64.whl (1.6 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

File details

Details for the file ffmt-0.2.5.tar.gz.

File metadata

  • Download URL: ffmt-0.2.5.tar.gz
  • Upload date:
  • Size: 66.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ffmt-0.2.5.tar.gz
Algorithm Hash digest
SHA256 65ea825e9fe157ac088fde89e2df368a08367d05ea927f900ffdd25093bc9e19
MD5 3f8ff8588f714e2c0222f0f591b99f53
BLAKE2b-256 645306099966e17fd68f87b960382826aedf4fab9eb79919ed81900ca8a20742

See more details on using hashes here.

Provenance

The following attestation bundles were made for ffmt-0.2.5.tar.gz:

Publisher: release.yml on sbryngelson/ffmt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ffmt-0.2.5-py3-none-win_amd64.whl.

File metadata

  • Download URL: ffmt-0.2.5-py3-none-win_amd64.whl
  • Upload date:
  • Size: 1.5 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ffmt-0.2.5-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 a2b59fc5be0f2632721f7d3181dc4afe9fc3428500528c75be4e612f4ab9d9a5
MD5 ffe9ee24d0b78b4271c9e24068fe2996
BLAKE2b-256 b549c2450f7d70e25f6beea719ae21c0aff007ff7a4329d30fb6201e5f579a98

See more details on using hashes here.

Provenance

The following attestation bundles were made for ffmt-0.2.5-py3-none-win_amd64.whl:

Publisher: release.yml on sbryngelson/ffmt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ffmt-0.2.5-py3-none-manylinux_2_34_x86_64.whl.

File metadata

  • Download URL: ffmt-0.2.5-py3-none-manylinux_2_34_x86_64.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: Python 3, manylinux: glibc 2.34+ x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ffmt-0.2.5-py3-none-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 abcd84242fed8b7404655ceaab00c7f825d3f1094591c0daa0e5374855839d36
MD5 87795391e245591ff7edf20dc1e10dab
BLAKE2b-256 cae38369e19ea1b9a0db9d3edb3ad6d2891d05d88dc7119ef06d113bfc8014e0

See more details on using hashes here.

Provenance

The following attestation bundles were made for ffmt-0.2.5-py3-none-manylinux_2_34_x86_64.whl:

Publisher: release.yml on sbryngelson/ffmt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ffmt-0.2.5-py3-none-macosx_11_0_arm64.whl.

File metadata

  • Download URL: ffmt-0.2.5-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 1.6 MB
  • Tags: Python 3, macOS 11.0+ ARM64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ffmt-0.2.5-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 084422bbfbe68a9ca772ab146014ce97fc23b0d46e36c556463f2e511acca988
MD5 f3cfd6f1ef5e4fc1db97fda3980ac603
BLAKE2b-256 45bfff4537236d8182494dcb2d715eb11d0b935cfff3a98960061e442118d56f

See more details on using hashes here.

Provenance

The following attestation bundles were made for ffmt-0.2.5-py3-none-macosx_11_0_arm64.whl:

Publisher: release.yml on sbryngelson/ffmt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page