Skip to content

file_ends_with

Byte-level prefix / suffix check. Works on any bytes (binary safe, unlike file_header).

Check-only: a fix would risk silently duplicating a near-matching prefix. Pair with file_prepend / file_append explicitly if you want auto-repair.

Binary files are checked too. Unlike the text rules, which skip binary-looking files, these two read the raw bytes of every file in scope, so they can assert a file signature on images or archives. Scope paths to the files you mean: a text prefix on **/* also fails every binary file, and a paired file_prepend / file_append refuses to edit a binary file, so those findings stay unfixed.

When to use it: when the exact bytes matter more than the text. Typical prefixes are a shebang on scripts (prefix: "#!" on **/*.sh), a file signature or magic number, and a fixed licence or generated-file banner. Typical suffixes are a generator's closing sentinel, so a hand-edited or truncated output fails, and a mandatory trailer line.

Byte-for-byte means newlines too: a suffix ending in \n requires the file's final newline, and one without it fails on a file that has one. An empty file fails any non-empty prefix or suffix. For a pattern rather than fixed bytes, use file_header / file_footer, which match a regex against the first or last lines; for "ends with a newline" alone, final_newline is the dedicated check.

OptionTypeRequiredDefaultDescription
suffixstringyesRequired suffix, matched byte-for-byte.

Plus the common paths, level, id, when, and expect_matches fields. This table is generated from the JSON Schema; option types and defaults are authoritative.

Generated files missing their sentinel line

Section titled "Generated files missing their sentinel line"

The rule fires on this repository:

  • build/
  • build/ok.generated.md✓
  • build/stripped.generated.md

    ✗ error gen-sentinel

    file does not end with the required suffix

  • build/wrong_tail.generated.md

    ✗ error gen-sentinel

    file does not end with the required suffix

build/ok.generated.md
# hi
<!-- generated by alint -->
build/stripped.generated.md
# hi
build/wrong_tail.generated.md
# hi
<!-- generated by somebody else -->

With this .alint.yml:

version: 1
rules:
- id: gen-sentinel
kind: file_ends_with
paths: "build/**/*.generated.md"
suffix: "<!-- generated by alint -->\n"
level: error

alint check reports:

Terminal window
--- build/stripped.generated.md ------------------------------------------------
x error gen-sentinel
file does not end with the required suffix
--- build/wrong_tail.generated.md ----------------------------------------------
x error gen-sentinel
file does not end with the required suffix
Summary (2 violations):
x 2 errors
0 passing * 1 failing

Every generated file ends with the sentinel

Section titled "Every generated file ends with the sentinel"

This repository is compliant:

  • build/
  • build/a.generated.md✓
  • build/b.generated.md✓
build/a.generated.md
# hi
<!-- generated by alint -->
build/b.generated.md
# world
<!-- generated by alint -->

With this .alint.yml:

version: 1
rules:
- id: gen-sentinel
kind: file_ends_with
paths: "build/**/*.generated.md"
suffix: "<!-- generated by alint -->\n"
level: error

alint check reports:

Terminal window
v All 1 rule(s) passed.