swiftbutler

Analyze, syntax-check, reindent, and distribute Swift source files using SwiftSyntax.

13|Updated May 29, 2025
One-click install
npx skills add https://github.com/Cocoanetics/SwiftButler --skill swiftbutler
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: swiftbutler
Source: https://github.com/Cocoanetics/SwiftButler/tree/main
Command: npx skills add https://github.com/Cocoanetics/SwiftButler --skill swiftbutler

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires SwiftSyntax, and includes scripts (resource) and references (resource) components.

What problem does it solve?

SwiftButler helps you efficiently analyze, check, reindent, and distribute Swift code. It simplifies large codebases, improves code quality, and speeds up development workflows.

Core Features & Use Cases

  • Analyze: Produce API overviews from Swift code, providing a compact representation of public APIs without delving into implementation details.
  • Check: Perform lightning-fast syntax checking with precise locations and fix-its.
  • Reindent: Normalize Swift indentation to ensure consistent code formatting.
  • Distribute: Split large generated files into smaller units for easier inspection and editing.
  • Use Case: Imagine you have a large Swift project with complex APIs. Use SwiftButler to generate API overviews, check for syntax errors, reindent code, and split large files into smaller units for easier review and refactoring.

Quick Start

Run the 'analyze' command on the 'Sources' directory to generate an API overview.

Frequently Asked Questions about swiftbutler

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

FAQPage Schema
How do I generate an API overview from Swift source code?

Generate a Swift API overview by analyzing your source code to extract public APIs without implementation details. This produces a compact representation of your codebase's interface for easier review and refactoring.

How do I perform Swift syntax checking and get fix-its?

Perform Swift syntax checking to validate your code and receive precise error locations along with fix-its. This lightning-fast process uses SwiftSyntax to ensure your code is syntactically correct before compilation.

What is the best way to normalize Swift indentation across a project?

The best way to normalize Swift indentation is by reindenting your source files to ensure consistent code formatting. This process standardizes indentation across the entire project, improving overall code quality and readability.

Do I need SwiftSyntax to check and analyze my Swift files?

Yes, you need SwiftSyntax to check and analyze your Swift files. SwiftSyntax is a required dependency for performing syntax validation, API analysis, code reindentation, and file distribution within the SwiftButler workflow.

Can I split large generated Swift files into smaller units?

Yes, you can split large generated Swift files into smaller units for easier inspection and editing. This distribution process organizes unwieldy files into manageable components, speeding up your development workflow.