ably-codebase-review

Audit the Ably CLI codebase for ably-new-command skill conformance using LSP and grep.

5|Updated Mar 24, 2025
One-click install
npx skills add https://github.com/ably/ably-cli --skill ably-codebase-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ably-codebase-review
Source: https://github.com/ably/ably-cli/tree/main/.claude/skills/ably-codebase-review
Command: npx skills add https://github.com/ably/ably-cli --skill ably-codebase-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Reviews the Ably CLI codebase to ensure full alignment with the conventions defined in the ably-new-command skill. It helps teams detect deviations, enforce consistency, and improve maintainability through structured checks.

Core Features & Use Cases

  • LSP-based structural analysis: resolve class hierarchies, base classes, and symbol definitions to verify correct patterns.
  • Grep/read textual checks: search for textual patterns that indicate guideline violations, including command structure, error handling, JSON guards, and test conventions.
  • Deviation reporting: aggregate findings with evidence, risk assessment, and actionable fixes to guide refactors.

Quick Start

Run the audit workflow to scan the codebase and report deviations from the command creation patterns.

Frequently Asked Questions about ably-codebase-review

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

FAQPage Schema
How do I audit a CLI codebase for command pattern conformance?

Audit a CLI codebase by applying LSP structural checks and grep textual searches across commands, base classes, JSON output, tests, and flags to verify pattern conformance and generate a deviation report with actionable fixes.

What does LSP-based code review check in a CLI codebase?

LSP-based code review resolves class hierarchies, base classes, and symbol definitions to verify correct structural patterns and command creation conventions within the codebase, ensuring architectural alignment.

Can I use grep to validate codebase quality assurance patterns?

Yes, grep and read operations validate textual patterns to detect guideline violations in command structure, error handling, JSON guards, and test conventions, complementing structural LSP checks for comprehensive quality assurance.

What is the best way to report codebase deviations and suggested fixes?

Aggregate structural and textual findings into a detailed report containing evidence, risk assessment, and actionable fixes to guide refactoring and enforce codebase consistency across all commands.

Do I need specific dependencies to run a codebase audit?

No external dependencies are required; the audit workflow leverages built-in LSP and grep operations to scan the codebase and identify deviations without needing additional component installations.