script-auditor

Audit repository helper scripts for coding and documentation compliance.

1|Updated May 21, 2020
One-click install
npx skills add https://github.com/ahandsel/debugging_log --skill script-auditor
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: script-auditor
Source: https://github.com/ahandsel/debugging_log/tree/main/skills/script-auditor
Command: npx skills add https://github.com/ahandsel/debugging_log --skill script-auditor

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This skill addresses the challenge of maintaining consistent quality, security, and documentation standards across a growing collection of helper scripts in a repository.

Core Features & Use Cases

  • Standardization: Automatically checks scripts for required documentation, including general notes, usage, output, and version history.
  • Policy Enforcement: Validates language choices by flagging banned technologies like Python and encouraging modern Node.js ES modules or zsh.
  • Quality Assurance: Verifies the presence of --help documentation and status emojis to ensure scripts are user-friendly and maintainable.
  • Use Case: Use this skill when adding a new utility to the repository to ensure it meets project guidelines, or run it as a periodic health check to identify and fix drift in existing tooling.

Quick Start

Run the script auditor to scan all helper scripts in the repository and generate a compliance report.

Frequently Asked Questions about script-auditor

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce script quality and documentation standards in a git repository?

You can enforce script quality by running an audit on tracked git files to check for required documentation, validate language choices, and verify the presence of help commands and status indicators.

What is the best way to check repository scripts for missing help documentation and structured notes?

The best way to check for missing documentation is to audit the scripts against a standard that requires general notes, usage instructions, output descriptions, and version history, generating a compliance report for the repository.

Do I need Node.js to run an automated script compliance audit?

Yes, you need Node.js version 24 or higher to execute the automated auditing logic against tracked git files and generate a compliance report for your helper scripts.

Can I use Python for repository helper scripts during a standards audit?

No, Python is flagged as a banned technology during the audit; the policy enforcement encourages using modern Node.js ES modules or zsh instead to maintain repository standards.

Why should I audit repository scripts for language choice and status emojis?

Auditing language choice and status emojis ensures scripts avoid banned technologies like Python, remain maintainable with modern Node.js or zsh, and provide user-friendly indicators for quick visual health checks.

When do I need to run a script standards audit?

You should run a script standards audit when adding a new utility to the repository to ensure it meets project guidelines, or periodically as a health check to identify and fix drift in existing tooling.