feat: add development infrastructure, automation hooks, and comprehensive documentation

[unclesp1d3r]

This pull request introduces several improvements to the project's automation, code quality, and documentation hooks, as well as adds detailed instructions for AI agents contributing to the codebase. The main changes include new and updated Kiro hooks for code quality, markdown formatting, Rust analysis, and documentation synchronization, along with the addition of a comprehensive Copilot instructions document to guide AI agents on development practices and architecture.

Automation & Code Quality Hooks

• Added new hooks for code quality checking (.kiro/hooks/code-quality-check.kiro.hook), markdown formatting (.kiro/hooks/markdown-format-fix.kiro.hook), and Rust code analysis (.kiro/hooks/rust-code-analyzer.kiro.hook), enabling automated validation and improvement of code and documentation on file changes or creation. [1] [2] [3]
• Updated the CI auto-fix hook to use more targeted just commands, refined trigger conditions, and clarified instructions for minimal, focused fixes based on actual CI failures.
• Improved the Rust performance analyzer hook to only analyze files changed in the current diff and clarified the analysis process, ensuring safe, measurable optimizations.

Documentation & Synchronization

• Enhanced the docs synchronization hook to cover a broader set of documentation and configuration files, updated prompts for accuracy, and emphasized verifying documentation against the actual codebase.
• Refined the LLMs.txt updater hook to require a full codebase scan after structure or documentation changes, ensuring the file accurately represents the current project state.

AI Agent Guidance

• Added a comprehensive Copilot instructions document (.github/copilot-instructions.md) detailing architecture, development practices, module structure, error handling, testing, and current implementation status, ensuring AI agents adhere to project standards and productivity patterns.

These changes collectively strengthen the project's automation, code quality enforcement, and documentation accuracy, while providing clear guidance for both human and AI contributors.

---

References:
[1] [2] [3] [4] [5] [6] [7] [8]

[coderabbitai]

Warning

Rate limit exceeded

@unclesp1d3r has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 5 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 50df667 and d24ccd6.

📒 Files selected for processing (42)

• .coderabbitai.yaml (1 hunks)
• .github/copilot-instructions.md (1 hunks)
• .github/workflows/ci.yml (1 hunks)
• .github/workflows/codeql.yml.bak (0 hunks)
• .kiro/hooks/ci-auto-fix.kiro.hook (1 hunks)
• .kiro/hooks/code-quality-check.kiro.hook (1 hunks)
• .kiro/hooks/docs-sync-hook.kiro.hook (1 hunks)
• .kiro/hooks/llms-txt-updater.kiro.hook (1 hunks)
• .kiro/hooks/markdown-format-fix.kiro.hook (1 hunks)
• .kiro/hooks/rust-code-analyzer.kiro.hook (1 hunks)
• .kiro/hooks/rust-perf-analyzer.kiro.hook (1 hunks)
• .kiro/hooks/rust-perf-optimizer.kiro.hook (1 hunks)
• .kiro/hooks/rust-quality-monitor.kiro.hook (2 hunks)
• .kiro/hooks/rust-security-analyzer.kiro.hook (2 hunks)
• .kiro/hooks/rust-security-hardening.kiro.hook (1 hunks)
• .kiro/hooks/update-llms-txt.kiro.hook (1 hunks)
• .kiro/specs/rust-libmagic-implementation/tasks.md (2 hunks)
• .pre-commit-config.yaml (3 hunks)
• CODE_OF_CONDUCT.md (1 hunks)
• Cargo.toml (1 hunks)
• README.md (5 hunks)
• codecov.yml (1 hunks)
• deny.toml (1 hunks)
• docs/src/SUMMARY.md (1 hunks)
• docs/src/architecture.md (2 hunks)
• docs/src/ast-structures.md (2 hunks)
• docs/src/cli-reference.md (1 hunks)
• docs/src/code-style.md (1 hunks)
• docs/src/compatibility.md (1 hunks)
• docs/src/development.md (1 hunks)
• docs/src/getting-started.md (1 hunks)
• docs/src/introduction.md (2 hunks)
• docs/src/io-performance.md (1 hunks)
• docs/src/magic-examples.md (1 hunks)
• docs/src/parser.md (1 hunks)
• docs/src/testing-guidelines.md (1 hunks)
• docs/src/testing.md (1 hunks)
• justfile (1 hunks)
• rust-toolchain.toml (1 hunks)
• rustfmt.toml (1 hunks)
• src/io/mod.rs (1 hunks)
• src/parser/grammar.rs (5 hunks)

Summary by CodeRabbit

• New Features

  • Added safe, memory-mapped file I/O with robust error reporting.
  • Expanded parser to handle more operators, values, and numeric/hex formats.

• Documentation

  • Reorganized docs into a multi-part guide with updated architecture, parser, and I/O sections.
  • Added CLI reference, compatibility matrix, magic file examples, and enhanced testing guidance.
  • README refreshed with current status, features, and metrics.

• Chores

  • Introduced Codecov, cargo-deny, rust-toolchain/rustfmt, Justfile, and enhanced pre-commit checks.
  • Added/updated automation hooks for quality, performance, security, and docs synchronization.

Walkthrough

Adds extensive docs and CI/tooling, many KiRo hooks, a cross-platform justfile, codecov and deny policies, rust toolchain/rustfmt configs, a new memory-mapped I/O public API (FileBuffer + IoError + safe accessors), and expanded parser grammar with public parse_operator and parse_value.

Changes

Cohort / File(s)	Change Summary
GitHub Copilot Docs .github/copilot-instructions.md	Added comprehensive Copilot/AI development guidance, architecture overview, patterns, and coding conventions.
KiRo Hooks — New & Updated .kiro/hooks/ci-auto-fix.kiro.hook, .kiro/hooks/code-quality-check.kiro.hook, .kiro/hooks/docs-sync-hook.kiro.hook, .kiro/hooks/llms-txt-updater.kiro.hook, .kiro/hooks/markdown-format-fix.kiro.hook, .kiro/hooks/rust-code-analyzer.kiro.hook, .kiro/hooks/rust-perf-analyzer.kiro.hook, .kiro/hooks/rust-perf-optimizer.kiro.hook, .kiro/hooks/rust-quality-monitor.kiro.hook, .kiro/hooks/rust-security-analyzer.kiro.hook, .kiro/hooks/rust-security-hardening.kiro.hook, .kiro/hooks/update-llms-txt.kiro.hook	Added multiple new hooks and updated several triggers/patterns and prompts; changes cover CI auto-fix, code quality, docs sync, markdown formatting, performance, security, and llms.txt automation.
Project Spec / Tasks .kiro/specs/rust-libmagic-implementation/tasks.md	Marked several parser and I/O tasks complete (parser components, buffer helpers, error handling).
Pre-commit & Tooling .pre-commit-config.yaml, codecov.yml, deny.toml, rust-toolchain.toml, rustfmt.toml, justfile	Added/updated pre-commit hooks (cargo-machete, cargo-sort, mdformat plugins), Codecov config, cargo-deny policy, pinned rust toolchain and rustfmt settings, and added a cross-platform justfile with many recipes.
Top-level README README.md	Reworked status, metrics, architecture, milestones, testing and usage guidance to reflect active development and completed components.
Docs TOC / Organization docs/src/SUMMARY.md	Reorganized docs into multi-part/chapter structure and updated navigation.
Docs — Architecture, Parser, I/O, AST docs/src/architecture.md, docs/src/parser.md, docs/src/io-performance.md, docs/src/ast-structures.md	Expanded architecture and implementation docs; annotated component statuses; added FileBuffer and safe-IO docs, examples, and API sketches; documented AST serialization/testing status.
Docs — Guides & Examples docs/src/cli-reference.md, docs/src/compatibility.md, docs/src/development.md, docs/src/testing.md, docs/src/magic-examples.md, docs/src/getting-started.md, docs/src/code-style.md, docs/src/testing-guidelines.md, docs/src/introduction.md	Added CLI reference, compatibility matrix, magic file examples, testing/development guidance; small formatting/import-order tweaks.
I/O Module (Public API) src/io/mod.rs	New public API: pub enum IoError { ... }, pub struct FileBuffer { ... }, FileBuffer::new, as_slice, path, len, is_empty, and safe access helpers safe_read_bytes, safe_read_byte, validate_buffer_access; bounds-checked, RAII-backed mmap handling and tests.
Parser Grammar (Public Parsers) src/parser/grammar.rs	Added public parsers parse_operator and parse_value plus supporting private parsers (quoted strings, escapes, hex byte sequences, numeric parsing with overflow checks); expanded tests.
Meta / Automation .coderabbitai.yaml, codecov.yml, deny.toml, justfile	Added AI/review automation config, CI coverage policy, dependency audit policy, and automation recipes.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant App as Application
  participant FB as FileBuffer
  participant OS as OS FS/Mmap

  App->>FB: FileBuffer::new(path)
  FB->>OS: stat/validate path & size
  alt valid & non-empty
    FB->>OS: mmap file
    OS-->>FB: Mmap handle
    FB-->>App: Ok(FileBuffer)
  else error
    FB-->>App: Err(IoError)
  end

  App->>FB: as_slice()
  FB-->>App: &[u8]

  App->>FB: safe_read_bytes(buf, offset, len)
  FB->>FB: validate_buffer_access(size, offset, len)
  alt in-bounds
    FB-->>App: Ok(&[u8])
  else out-of-bounds / overflow
    FB-->>App: Err(IoError::BufferOverrun|InvalidAccess)
  end

Loading

sequenceDiagram
  autonumber
  participant App as Application
  participant PG as parser::grammar
  participant AST as AST Types

  App->>PG: parse_operator(input)
  alt matches operators (==, !=, <>, &, =)
    PG-->>App: Ok(Operator)
  else
    PG-->>App: Err(nom::Err)
  end

  App->>PG: parse_value(input)
  alt quoted string
    PG->>AST: Value::String
  else hex bytes (\x.. or hex seq)
    PG->>AST: Value::Bytes
  else numeric (hex/dec)
    PG->>AST: Value::Int/Uint
  else invalid
    PG-->>App: Err(nom::Err)
  end
  PG-->>App: Ok(Value) or Err

Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60–90 minutes

Poem

I mapped a file with careful paws,
Checked every bound by bunny laws.
I parsed the ops and coaxed the bytes,
Hooks hum softly through the nights.
Carrots, tests, and linters bright—this warren ships, code snug and tight. 🥕🐇

Pre-merge checks and finishing touches and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title “feat: add development infrastructure, automation hooks, and comprehensive documentation” accurately captures the primary scope of the changeset by highlighting the addition of infrastructure, multiple automation hooks, and extensive documentation updates in a clear and concise manner.
Description Check	✅ Passed	The pull request description provides a focused summary of the changes, detailing the new and updated hooks, infrastructure enhancements, and Copilot instructions, which aligns closely with the actual modifications introduced in the diff.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[unclesp1d3r]

@coderabbitai configuration

[coderabbitai]

CodeRabbit configuration

language: en-US
tone_instructions: ''
early_access: true
enable_free_tier: true
reviews:
  profile: chill
  request_changes_workflow: true
  high_level_summary: true
  high_level_summary_placeholder: '@coderabbitai summary'
  high_level_summary_in_walkthrough: true
  auto_title_placeholder: '@coderabbitai'
  auto_title_instructions: ''
  review_status: true
  commit_status: true
  fail_commit_status: false
  collapse_walkthrough: false
  changed_files_summary: true
  sequence_diagrams: true
  estimate_code_review_effort: true
  assess_linked_issues: true
  related_issues: true
  related_prs: true
  suggested_labels: true
  auto_apply_labels: true
  suggested_reviewers: true
  auto_assign_reviewers: true
  in_progress_fortune: true
  poem: true
  labeling_instructions: []
  path_filters: []
  path_instructions: []
  abort_on_close: true
  disable_cache: false
  auto_review:
    enabled: true
    auto_incremental_review: true
    ignore_title_keywords: []
    labels: []
    drafts: false
    base_branches: []
    ignore_usernames: []
  finishing_touches:
    docstrings:
      enabled: true
    unit_tests:
      enabled: true
  pre_merge_checks:
    docstrings:
      mode: warning
      threshold: 80
    title:
      mode: warning
      requirements: ''
    description:
      mode: warning
    issue_assessment:
      mode: warning
    custom_checks: []
  tools:
    ast-grep:
      rule_dirs: []
      util_dirs: []
      essential_rules: true
      packages: []
    shellcheck:
      enabled: true
    ruff:
      enabled: true
    markdownlint:
      enabled: true
    github-checks:
      enabled: true
      timeout_ms: 90000
    languagetool:
      enabled: true
      enabled_rules: []
      disabled_rules: []
      enabled_categories: []
      disabled_categories: []
      enabled_only: false
      level: default
    biome:
      enabled: true
    hadolint:
      enabled: true
    swiftlint:
      enabled: true
    phpstan:
      enabled: true
      level: default
    phpmd:
      enabled: true
    phpcs:
      enabled: true
    golangci-lint:
      enabled: true
    yamllint:
      enabled: true
    gitleaks:
      enabled: true
    checkov:
      enabled: true
    detekt:
      enabled: true
    eslint:
      enabled: true
    flake8:
      enabled: true
    rubocop:
      enabled: true
    buf:
      enabled: true
    regal:
      enabled: true
    actionlint:
      enabled: true
    pmd:
      enabled: true
    cppcheck:
      enabled: true
    semgrep:
      enabled: true
    circleci:
      enabled: true
    clippy:
      enabled: true
    sqlfluff:
      enabled: true
    prismaLint:
      enabled: true
    pylint:
      enabled: true
    oxc:
      enabled: true
    shopifyThemeCheck:
      enabled: true
    luacheck:
      enabled: true
    brakeman:
      enabled: true
    dotenvLint:
      enabled: true
    htmlhint:
      enabled: true
    checkmake:
      enabled: true
    osvScanner:
      enabled: true
chat:
  art: true
  auto_reply: true
  integrations:
    jira:
      usage: auto
    linear:
      usage: auto
knowledge_base:
  opt_out: false
  web_search:
    enabled: true
  code_guidelines:
    enabled: true
    filePatterns: []
  learnings:
    scope: auto
  issues:
    scope: local
  jira:
    usage: auto
    project_keys: []
  linear:
    usage: auto
    team_keys: []
  pull_requests:
    scope: local
  mcp:
    usage: enabled
    disabled_servers: []
code_generation:
  docstrings:
    language: en-US
    path_instructions: []
  unit_tests:
    path_instructions: []

[unclesp1d3r]

@coderabbitai if you don't like the title of the PR, then go ahead and change it to something better.

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Fetch the current PR title
gh pr view 4 --json title --jq '.title'

Length of output: 28

---

🏁 Script executed:

#!/bin/bash
# Update the PR title to better reflect the comprehensive changes
gh pr edit 4 --title "feat: add development infrastructure, automation hooks, and comprehensive documentation"

Length of output: 50

---

@unclesp1d3r: I've updated the PR title from "feat: implement type parsing" to "feat: add development infrastructure, automation hooks, and comprehensive documentation" to better reflect the comprehensive scope of changes.

The previous title focused only on the type parsing implementation, but this PR actually includes much more:

• 11+ Kiro automation hooks (code quality, security, performance, CI/CD)
• Complete development infrastructure (justfile, toolchain configs, pre-commit hooks)
• Comprehensive Copilot instructions and documentation expansion
• Project configuration (codecov, deny.toml, rustfmt)

The new title captures the full breadth of the infrastructure and automation work you've added! 🐰

✨🐰✨
^^
/||
| |