ffmt 0.2.7__tar.gz → 0.3.0__tar.gz

{ffmt-0.2.7 → ffmt-0.3.0}/.github/workflows/ci.yml

@@ -12,6 +12,9 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy, rustfmt
+      - run: cargo fmt --check
       - run: cargo test
       - run: cargo clippy -- -D warnings
 
@@ -163,6 +166,26 @@ jobs:
           JOBS=${{ matrix.target == 'cpu' && '$(nproc)' || '2' }}
           ./mfc.sh build -j $JOBS $GPU_FLAG
 
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install docs dependencies
+        run: pip install mkdocs-material
+
+      - name: Build documentation
+        run: mkdocs build --strict
+
+      - name: Lint Markdown
+        uses: DavidAnson/markdownlint-cli2-action@v19
+        with:
+          globs: "docs/**/*.md,README.md"
+
   build-wheels:
     name: Build wheels (${{ matrix.os }})
     runs-on: ${{ matrix.os }}

{ffmt-0.2.7 → ffmt-0.3.0}/.gitignore

@@ -1,3 +1,4 @@
 /target/
 .ffmt_cache/
 Cargo.lock
+site/

ffmt-0.3.0/.markdownlint.json

@@ -0,0 +1,7 @@
+{
+  "MD013": false,
+  "MD033": false,
+  "MD046": false,
+  "MD024": false,
+  "MD040": false
+}

ffmt-0.3.0/.readthedocs.yml

@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+python:
+  install:
+    - requirements: docs/requirements.txt

{ffmt-0.2.7 → ffmt-0.3.0}/Cargo.lock

@@ -156,7 +156,7 @@ checksum = "877a4ace8713b0bcf2a4e7eec82529c029f1d0619886d18145fea96c3ffe5c0f"
 
 [[package]]
 name = "ffmt"
-version = "0.2.7"
+version = "0.3.0"
 dependencies = [
  "clap",
  "ignore",

{ffmt-0.2.7 → ffmt-0.3.0}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ffmt"
-version = "0.2.7"
+version = "0.3.0"
 edition = "2021"
 description = "A fast, configurable Fortran formatter with Fypp, Doxygen, and OpenACC/OpenMP support"
 license = "MIT"

ffmt-0.3.0/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: ffmt
+Version: 0.3.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Fortran
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Software Development :: Quality Assurance
+License-File: LICENSE
+Summary: A fast, configurable Fortran formatter with Fypp, Doxygen, and OpenACC/OpenMP support
+Keywords: fortran,formatter,linter,code-quality
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+# ffmt
+
+[![PyPI](https://img.shields.io/pypi/v/ffmt.svg)](https://pypi.org/project/ffmt/)
+[![CI](https://github.com/sbryngelson/ffmt/actions/workflows/ci.yml/badge.svg)](https://github.com/sbryngelson/ffmt/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-ffmt-blue?logo=github)](https://github.com/marketplace/actions/ffmt-fortran-formatter)
+[![Docs](https://readthedocs.org/projects/ffmt-fortran/badge/?version=latest)](https://ffmt-fortran.readthedocs.io)
+
+A fast, configurable Fortran formatter with support for Fypp, Doxygen, and OpenACC/OpenMP directives. Written in Rust. Installable via `pip`.
+
+**[Documentation](https://ffmt-fortran.readthedocs.io)** | **[Configuration](https://ffmt-fortran.readthedocs.io/en/latest/configuration/)** | **[Changelog](https://github.com/sbryngelson/ffmt/releases)**
+
+## Installation
+
+```bash
+pip install ffmt
+```
+
+Or via Cargo:
+
+```bash
+cargo install ffmt
+```
+
+## Quick start
+
+```bash
+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
+```
+
+## Features
+
+- **Code** -- indentation, whitespace normalization, keyword casing, named ends, line wrapping, operator modernization (`.eq.` -> `==`), double-colon enforcement, trailing semicolon removal
+- **Comments** -- rewrapping, inline spacing (S102), `!<` alignment, `!&`/`& !` cleanup, format suppression (`! ffmt off/on`)
+- **Structure** -- blank line management around openers/closers/`#ifdef`, declaration `::` alignment, declaration/use compaction
+- **Preprocessor** -- Fypp (`#:if`, `$:`, `@:`), C preprocessor (`#ifdef`), OpenACC (`!$acc`), OpenMP (`!$omp`)
+- **Opt-in** -- multi-statement splitting, assignment alignment, `&` column alignment, use-statement reformatting
+
+Most options accept `true`, `false`, or `"preserve"`. See the [configuration reference](https://ffmt-fortran.readthedocs.io/en/latest/configuration/) for all options.
+
+## Configuration
+
+Create `ffmt.toml` or add `[tool.ffmt]` to `pyproject.toml`:
+
+```toml
+indent-width = 4
+line-length = 132
+keyword-case = "lower"
+modernize-operators = true
+enforce-double-colon = true
+
+[whitespace]
+relational = true
+multdiv = false
+```
+
+## CI
+
+```yaml
+# GitHub Actions
+- uses: sbryngelson/ffmt@latest
+  with:
+    args: "--check src/"
+```
+
+```yaml
+# pre-commit
+repos:
+  - repo: https://github.com/sbryngelson/ffmt
+    rev: v0.2.8
+    hooks:
+      - id: ffmt
+```
+
+## Other Fortran formatters
+
+| Formatter | Language | Status | Notes |
+|-----------|----------|--------|-------|
+| [fprettify](https://github.com/fortran-lang/fprettify) | Python | Unmaintained | Free-form only. Fypp support. |
+| [findent](https://github.com/wvermin/findent) | C | Active | Indentation and fixed/free conversion. |
+| [Codee Formatter](https://www.codee.com) | Proprietary | Active | Commercial. Tree-sitter based. |
+| [LFortran fmt](https://lfortran.org) | Rust | In development | AST-based. |
+| [Fortitude](https://github.com/PlasmaFAIR/fortitude) | Rust | Active | Linter with auto-fix. |
+
+## License
+
+MIT
+

ffmt-0.3.0/README.md

@@ -0,0 +1,91 @@
+# ffmt
+
+[![PyPI](https://img.shields.io/pypi/v/ffmt.svg)](https://pypi.org/project/ffmt/)
+[![CI](https://github.com/sbryngelson/ffmt/actions/workflows/ci.yml/badge.svg)](https://github.com/sbryngelson/ffmt/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-ffmt-blue?logo=github)](https://github.com/marketplace/actions/ffmt-fortran-formatter)
+[![Docs](https://readthedocs.org/projects/ffmt-fortran/badge/?version=latest)](https://ffmt-fortran.readthedocs.io)
+
+A fast, configurable Fortran formatter with support for Fypp, Doxygen, and OpenACC/OpenMP directives. Written in Rust. Installable via `pip`.
+
+**[Documentation](https://ffmt-fortran.readthedocs.io)** | **[Configuration](https://ffmt-fortran.readthedocs.io/en/latest/configuration/)** | **[Changelog](https://github.com/sbryngelson/ffmt/releases)**
+
+## Installation
+
+```bash
+pip install ffmt
+```
+
+Or via Cargo:
+
+```bash
+cargo install ffmt
+```
+
+## Quick start
+
+```bash
+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
+```
+
+## Features
+
+- **Code** -- indentation, whitespace normalization, keyword casing, named ends, line wrapping, operator modernization (`.eq.` -> `==`), double-colon enforcement, trailing semicolon removal
+- **Comments** -- rewrapping, inline spacing (S102), `!<` alignment, `!&`/`& !` cleanup, format suppression (`! ffmt off/on`)
+- **Structure** -- blank line management around openers/closers/`#ifdef`, declaration `::` alignment, declaration/use compaction
+- **Preprocessor** -- Fypp (`#:if`, `$:`, `@:`), C preprocessor (`#ifdef`), OpenACC (`!$acc`), OpenMP (`!$omp`)
+- **Opt-in** -- multi-statement splitting, assignment alignment, `&` column alignment, use-statement reformatting
+
+Most options accept `true`, `false`, or `"preserve"`. See the [configuration reference](https://ffmt-fortran.readthedocs.io/en/latest/configuration/) for all options.
+
+## Configuration
+
+Create `ffmt.toml` or add `[tool.ffmt]` to `pyproject.toml`:
+
+```toml
+indent-width = 4
+line-length = 132
+keyword-case = "lower"
+modernize-operators = true
+enforce-double-colon = true
+
+[whitespace]
+relational = true
+multdiv = false
+```
+
+## CI
+
+```yaml
+# GitHub Actions
+- uses: sbryngelson/ffmt@latest
+  with:
+    args: "--check src/"
+```
+
+```yaml
+# pre-commit
+repos:
+  - repo: https://github.com/sbryngelson/ffmt
+    rev: v0.2.8
+    hooks:
+      - id: ffmt
+```
+
+## Other Fortran formatters
+
+| Formatter | Language | Status | Notes |
+|-----------|----------|--------|-------|
+| [fprettify](https://github.com/fortran-lang/fprettify) | Python | Unmaintained | Free-form only. Fypp support. |
+| [findent](https://github.com/wvermin/findent) | C | Active | Indentation and fixed/free conversion. |
+| [Codee Formatter](https://www.codee.com) | Proprietary | Active | Commercial. Tree-sitter based. |
+| [LFortran fmt](https://lfortran.org) | Rust | In development | AST-based. |
+| [Fortitude](https://github.com/PlasmaFAIR/fortitude) | Rust | Active | Linter with auto-fix. |
+
+## License
+
+MIT

ffmt-0.3.0/docs/ci.md

@@ -0,0 +1,50 @@
+# CI Integration
+
+## GitHub Actions
+
+```yaml
+- uses: sbryngelson/ffmt@latest
+  with:
+    args: "--check src/"
+```
+
+## pre-commit
+
+```yaml
+repos:
+  - repo: https://github.com/sbryngelson/ffmt
+    rev: v0.2.8
+    hooks:
+      - id: ffmt
+```
+
+To auto-update to the latest version:
+
+```bash
+pre-commit autoupdate
+```
+
+Or use [pre-commit.ci](https://pre-commit.ci/) to update hooks automatically via pull requests.
+
+## GitLab CI
+
+```yaml
+format:
+  image: python:3.12
+  script:
+    - pip install ffmt
+    - ffmt --check src/
+```
+
+## Generic CI
+
+```bash
+pip install ffmt
+ffmt --check src/
+```
+
+The `--check` flag exits with code 1 if any files would be changed, making it suitable for CI gates. Use `--diff` to see what would change:
+
+```bash
+ffmt --diff src/
+```