tool-creation-guidelines

Establish best practices for developer tools using AST parsers over regex.

1|Updated Apr 10, 2024
One-click install
npx skills add https://github.com/EvaLok/schema-org-json-ld --skill tool-creation-guidelines
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: tool-creation-guidelines
Source: https://github.com/EvaLok/schema-org-json-ld/tree/main/.claude/skills/tool-creation-guidelines
Command: npx skills add https://github.com/EvaLok/schema-org-json-ld --skill tool-creation-guidelines

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a comprehensive set of best practices and conventions for developing high-quality, reliable, and maintainable developer tools and scripts within the project.

Core Features & Use Cases

  • Tool-First Philosophy: Encourages building tools for repetitive tasks to improve efficiency.
  • AST Parsing: Mandates the use of Abstract Syntax Tree parsers over regex for code analysis to ensure robustness.
  • Rust Preference: Recommends Rust for non-AST tools due to its performance and standalone binary nature.
  • Quality Assurance: Outlines strict requirements for fail-safe design, adversarial testing, and thorough review checklists for tools.
  • Verification Anti-Pattern: Warns against verification tools that mask underlying issues by "fixing" them.
  • Use Case: When developing a new script to analyze code structure, follow these guidelines to ensure it's robust, maintainable, and adheres to project standards.

Quick Start

Consult these guidelines when planning or reviewing any new developer tool or script.

Frequently Asked Questions about tool-creation-guidelines

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

FAQPage Schema
Why use AST parsing instead of regex for code analysis?

AST parsing ensures robust code analysis by understanding structure, whereas regex pattern matching is brittle and fails on complex code. This guideline mandates AST parsers to guarantee reliable developer tool behavior.

What is the best way to build reliable developer tools and scripts?

The best way to build reliable developer tools is adopting a tool-first philosophy, using AST parsers for analysis, and applying fail-safe design with adversarial testing to ensure robustness and maintainability.

Why use Rust for building developer tools?

Rust is recommended for building non-AST developer tools because it delivers high performance and compiles to standalone binaries, simplifying deployment. This ensures tools run efficiently across different environments.

What is a verification anti-pattern in developer tool design?

A verification anti-pattern occurs when developer tools mask underlying issues by automatically fixing them. This guideline advises against such tools to prevent compensating for problems they should detect.

How do I ensure my script follows quality assurance measures?

Ensure your script follows quality assurance by implementing fail-safe design, conducting adversarial testing, and reviewing against thorough checklists. This verifies that tools maintain high standards and reliability.

When do I need a tool-first philosophy for repetitive tasks?

You need a tool-first philosophy for repetitive tasks to improve efficiency. Building dedicated developer tools for these actions ensures long-term maintainability and consistent execution across projects.