Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zmoon/findent-pre-commit
Use findent as a pre-commit hook
https://github.com/zmoon/findent-pre-commit
fortran pre-commit pre-commit-hooks
Last synced: 25 days ago
JSON representation
Use findent as a pre-commit hook
- Host: GitHub
- URL: https://github.com/zmoon/findent-pre-commit
- Owner: zmoon
- License: unlicense
- Created: 2022-06-10T17:04:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T16:22:30.000Z (4 months ago)
- Last Synced: 2024-11-08T03:09:53.384Z (3 months ago)
- Topics: fortran, pre-commit, pre-commit-hooks
- Language: Python
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# findent-pre-commit
Use [findent](https://www.ratrabbit.nl/ratrabbit/findent/)
as a [pre-commit](https://pre-commit.com/) hook.
## Requirements
[pre-commit](https://pre-commit.com/#install), and:
* The `wfindent-conda` and `findent-conda` hooks require `conda` available on `PATH`
(or `mamba`, with `PRE_COMMIT_USE_MAMBA=1`).
* The `wfindent-system` hook requires `wfindent` available on `PATH`.
* The `findent-system` hook requires `findent` available on `PATH`.
## Usage
Add one of the hooks defined in [`.pre-commit-hooks.yaml`](./.pre-commit-hooks.yaml)
to your `.pre-commit-config.yaml` file.
For example:
```yaml
repos:
- repo: https://github.com/zmoon/findent-pre-commit
rev: main
hooks:
- id: wfindent-system
```
To control which files get formatted, set
```yaml
files:
```
to match them.
The current setting (`\.[fF](90|95|03|08)$`) matches free-form sources files
[according to GCC](https://gcc.gnu.org/onlinedocs/gfortran/GNU-Fortran-and-GCC.html).
To pass args to `findent`, use, for example:
```yaml
args: [--indent=4, -r0]
```
### Specify `findent` version
There are multiple ways to achieve this:
* for `findent-system`, use the `--findent-version-pin` arg, which will check the version before running
```yaml
args: [--findent-version-pin=4.3.3]
```
* for `findent-pypi`/`wfindent-pypi`, pin `findent-pypi` in `additional_dependencies`
```yaml
additional_dependencies: [findent-pypi==4.3.1]
```
- findent-pypi releases can be found [on GitHub](https://github.com/gnikit/findent-pypi/releases)
- releases since `4.2.6.post0` should work for Windows (in addition to Unix-like)
* for `findent-conda`/`wfindent-conda`, pin `findent` in `additional_dependencies`
```yaml
additional_dependencies: [findent==4.3.2]
```
- available versions can be found [on conda-forge](https://anaconda.org/conda-forge/findent/files)
* for `wfindent-system`, there is currently no way to ensure a certain `findent` version is being used
## Wrapper
To install the Python wrapper `findent-wrapper` with [`pipx`](https://pypa.github.io/pipx/):
```
pipx install https://github.com/zmoon/findent-pre-commit/archive/main.zip
```
Note that the `wfindent` tool distributed with findent and referenced above provides in-place editing
using shell scripting.
`findent-wrapper` adds a `--diff` option (and maybe more options in the future...).
## Another way
As an alternative to the `wfindent-system` hook defined in this repo, it is possible
to use a [local hook](https://pre-commit.com/#repository-local-hooks) setup.
```yaml
# .pre-commit-config.yaml
- repo: local
hooks:
- id: wfindent
name: Format Fortran code using findent
entry: wfindent
description: Uses system copy of wfindent available on PATH.
language: system
pass_filenames: true
files: \.[fF](90|95|03|08)$
types: [text]
require_serial: true
```
Note that `findent` cannot be used in this way, since it only reads from STDIN.