alef 0.23.46

Opinionated polyglot binding generator for Rust libraries
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

# Generated by alef scaffold. Customize as needed.
default_install_hook_types:
  - pre-commit
  - commit-msg
exclude: ^target/|\.alef/

repos:
  # Commit message linting
  - repo: https://github.com/Goldziher/gitfluff
    rev: {{ gitfluff }}
    hooks:
      - id: gitfluff-lint
        args: ["--write"]
        stages: [commit-msg]

  # Shared hooks bundle — file safety, Rust (cargo-*, rustdoc,
  # rust-max-lines), Markdown (rumdl), typos, and pyproject-fmt all live here.
  - repo: https://github.com/kreuzberg-dev/pre-commit-hooks
    rev: {{ shared_pre_commit_hooks }}
    hooks:
      # File safety
      - id: trailing-whitespace
      - id: end-of-file-fixer
      - id: check-merge-conflict
      - id: check-added-large-files
      - id: detect-private-key
      - id: check-json
      - id: check-yaml
        args: ["--allow-multiple-documents", "--unsafe"]
      - id: check-toml
      - id: check-case-conflict
      - id: check-executables-have-shebangs
      - id: check-shebang-scripts-are-executable
      - id: mixed-line-ending
      - id: typos
        args: ["--force-exclude"]

{% if has_python %}
      # Python project surface
      - id: pyproject-fmt

{% endif %}
      # Rust — cargo-clippy with -D warnings subsumes cargo check
      - id: cargo-fmt
        args: ["--all"]
      - id: cargo-clippy
        args:
          [
            "--fix",
            "--allow-dirty",
            "--allow-staged",
            "--workspace",
            "--all-features",
{{ clippy_excludes }}            "--all-targets",
            "--",
            "-D",
            "warnings",
          ]
      - id: cargo-sort
      - id: cargo-machete
      - id: cargo-deny
        args: ["check"]
      - id: rustdoc-lint
      # Enforces a 1,000-line ceiling on .rs files; tests/ paths and tests.rs
      # submodule files are excluded by default. Pass --include-tests to count
      # them as well.
      - id: rust-max-lines
        args: ["--max=1000"]

      # Markdown
      - id: rumdl-fmt

{% if include_shared_hooks %}
  # Optional per-repo extension repo (set scaffold.precommit.shared_hooks_repo
  # in alef.toml to point at a fork or a sibling hooks repo).
  - repo: {{ shared_hooks_repo }}
    rev: {{ shared_hooks_rev }}
    hooks:
      - id: shfmt
      - id: shellcheck
      - id: hadolint
      - id: textlint

{% endif %}
{% if include_alef_hooks %}
  # Alef: generate READMEs, verify bindings, sync versions
{% if alef_hooks_are_local %}
  - repo: local
    hooks:
      - id: alef-readme
        name: alef readme
        entry: alef readme
        language: system
        pass_filenames: false
      - id: alef-verify
        name: alef verify
        entry: alef verify --exit-code
        language: system
        pass_filenames: false
      - id: alef-sync-versions
        name: alef sync versions
        entry: alef sync-versions
        language: system
        pass_filenames: false
{% else %}
  - repo: {{ alef_hooks_repo }}
    rev: {{ alef_hooks_rev }}
    hooks:
      - id: alef-readme
      - id: alef-verify
      - id: alef-sync-versions
{% endif %}

{% endif %}