alint_rules/

file_starts_with.rs

//! `file_starts_with` — every file in scope must begin with the
//! configured prefix (byte-level).
//!
//! Useful for SPDX headers (when `file_header`'s line-oriented
//! matching is too loose), magic bytes on binary formats, or a
//! required "do not edit — generated" banner. Works on any byte
//! content, not just UTF-8.
//!
//! Check-only: the correct fix is to call `file_prepend` with
//! the same content, and having the rule do it implicitly would
//! silently duplicate the prefix on files that start with a
//! similar but non-matching string.

use std::path::Path;

use alint_core::{Context, Error, Level, PerFileRule, Result, Rule, RuleSpec, Scope, Violation};
use serde::Deserialize;

use crate::io::read_prefix_n;

#[derive(Debug, Deserialize)]
#[serde(deny_unknown_fields)]
struct Options {
    /// The required prefix. Matched byte-for-byte.
    prefix: String,
}

#[derive(Debug)]
pub struct FileStartsWithRule {
    id: String,
    level: Level,
    policy_url: Option<String>,
    message: Option<String>,
    scope: Scope,
    prefix: Vec<u8>,
}

impl Rule for FileStartsWithRule {
    alint_core::rule_common_impl!();

    fn evaluate(&self, ctx: &Context<'_>) -> Result<Vec<Violation>> {
        let mut violations = Vec::new();
        for entry in ctx.index.files() {
            if !self.scope.matches(&entry.path, ctx.index) {
                continue;
            }
            // Bounded read: only the first `prefix.len()` bytes
            // matter. When this rule runs solo (e.g. via `alint
            // fix --only ...` or test harnesses) we read just
            // those bytes, not the whole file. The dispatch-flip
            // path (`evaluate_file`) gets the full slice from
            // the engine and bounds-checks via `starts_with`.
            let full = ctx.root.join(&entry.path);
            let Ok(bytes) = read_prefix_n(&full, self.prefix.len()) else {
                continue;
            };
            violations.extend(self.evaluate_file(ctx, &entry.path, &bytes)?);
        }
        Ok(violations)
    }

    fn as_per_file(&self) -> Option<&dyn PerFileRule> {
        Some(self)
    }
}

impl PerFileRule for FileStartsWithRule {
    fn path_scope(&self) -> &Scope {
        &self.scope
    }

    fn evaluate_file(
        &self,
        _ctx: &Context<'_>,
        path: &Path,
        bytes: &[u8],
    ) -> Result<Vec<Violation>> {
        if bytes.starts_with(&self.prefix) {
            return Ok(Vec::new());
        }
        let msg = self
            .message
            .clone()
            .unwrap_or_else(|| "file does not start with the required prefix".to_string());
        Ok(vec![
            Violation::new(msg)
                .with_path(std::sync::Arc::<Path>::from(path))
                .with_location(1, 1),
        ])
    }

    fn max_bytes_needed(&self) -> Option<usize> {
        Some(self.prefix.len())
    }
}

pub fn build(spec: &RuleSpec) -> Result<Box<dyn Rule>> {
    let _paths = spec
        .paths
        .as_ref()
        .ok_or_else(|| Error::rule_config(&spec.id, "file_starts_with requires a `paths` field"))?;
    let opts: Options = spec
        .deserialize_options()
        .map_err(|e| Error::rule_config(&spec.id, format!("invalid options: {e}")))?;
    if opts.prefix.is_empty() {
        // Pitfall #15 in `docs/development/CONFIG-AUTHORING.md`: an
        // empty prefix is sometimes reached for as a shorthand for
        // "file is non-empty". Point at the right tool for the job.
        return Err(Error::rule_config(
            &spec.id,
            "file_starts_with.prefix must not be empty.\n  \
             hint: for non-emptiness checks, use `file_min_lines: 1` or \
             `file_min_size: <bytes>` instead. file_starts_with is for \
             literal-prefix assertions like `prefix: \"#!/bin/bash\\n\"`.",
        ));
    }
    if spec.fix.is_some() {
        return Err(Error::rule_config(
            &spec.id,
            "file_starts_with has no fix op — pair with an explicit `file_prepend` rule if you \
             want auto-prepend (avoids silently duplicating near-matching prefixes).",
        ));
    }
    Ok(Box::new(FileStartsWithRule {
        id: spec.id.clone(),
        level: spec.level,
        policy_url: spec.policy_url.clone(),
        message: spec.message.clone(),
        scope: Scope::from_spec(spec)?,
        prefix: opts.prefix.into_bytes(),
    }))
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::test_support::{ctx, spec_yaml, tempdir_with_files};

    #[test]
    fn build_rejects_missing_paths_field() {
        let spec = spec_yaml(
            "id: t\n\
             kind: file_starts_with\n\
             prefix: \"#!/bin/sh\"\n\
             level: error\n",
        );
        assert!(build(&spec).is_err());
    }

    #[test]
    fn build_rejects_empty_prefix() {
        let spec = spec_yaml(
            "id: t\n\
             kind: file_starts_with\n\
             paths: \"**/*.sh\"\n\
             prefix: \"\"\n\
             level: error\n",
        );
        let err = build(&spec).unwrap_err().to_string();
        assert!(err.contains("empty"), "unexpected: {err}");
    }

    #[test]
    fn build_rejects_fix_block() {
        let spec = spec_yaml(
            "id: t\n\
             kind: file_starts_with\n\
             paths: \"**/*.sh\"\n\
             prefix: \"#!/bin/sh\\n\"\n\
             level: error\n\
             fix:\n  \
               file_prepend:\n    \
                 content: \"x\"\n",
        );
        assert!(build(&spec).is_err());
    }

    #[test]
    fn evaluate_passes_when_prefix_matches() {
        let spec = spec_yaml(
            "id: t\n\
             kind: file_starts_with\n\
             paths: \"**/*.sh\"\n\
             prefix: \"#!/bin/sh\"\n\
             level: error\n",
        );
        let rule = build(&spec).unwrap();
        let (tmp, idx) = tempdir_with_files(&[("script.sh", b"#!/bin/sh\necho hi\n")]);
        let v = rule.evaluate(&ctx(tmp.path(), &idx)).unwrap();
        assert!(v.is_empty(), "expected pass: {v:?}");
    }

    #[test]
    fn evaluate_fires_when_prefix_missing() {
        let spec = spec_yaml(
            "id: t\n\
             kind: file_starts_with\n\
             paths: \"**/*.sh\"\n\
             prefix: \"#!/bin/sh\"\n\
             level: error\n",
        );
        let rule = build(&spec).unwrap();
        let (tmp, idx) = tempdir_with_files(&[("script.sh", b"echo hi\n")]);
        let v = rule.evaluate(&ctx(tmp.path(), &idx)).unwrap();
        assert_eq!(v.len(), 1);
    }
}