Skip to content

is_doc_file() incorrectly treats extensionless files as documentation #489

Description

@ajianaz

Problem

is_doc_file() in security_scanner.rs uses rsplit(.).next() to extract the file extension. For a filename with no dot (e.g., org, tex, md), rsplit(.).next() returns the whole string — so is_doc_file("org") returns true.

Impact

Input Expected Actual
is_doc_file("README.md") true true ✅
is_doc_file("src/org") false true ❌ (Go package dir)
is_doc_file("tex") false true ❌ (binary named tex)
is_doc_file("CHANGELOG") false false ✅

Low real-world probability but logically incorrect.

Fix

Check that the path contains a . before extracting extension:

fn is_doc_file(path: &str) -> bool {
    let ext = match path.rsplit('.').next() {
        Some(e) if e.len() < path.len() => e,  // Has a dot
        _ => return false,                      // No dot, no extension
    };
    matches!(ext, "md" | "markdown" | "txt" | ...)
}

Related

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions