sd-api-name-review

Compare public API naming conventions across JavaScript/TypeScript libraries to industry standards.

2|2|Updated Jul 10, 2024

Search Tags:#typescript #consistency #naming-conventions #code-review #api-naming #library-audit #industry-standards

Ready to run

npx skills add https://github.com/kslhunter/simplysm --skill sd-api-name-review

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: sd-api-name-review
Source: https://github.com/kslhunter/simplysm/tree/main/.claude/skills/sd-api-name-review
Command: npx skills add https://github.com/kslhunter/simplysm --skill sd-api-name-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Reviewers of libraries and modules often struggle to ensure consistent public API naming across projects and align with industry-standard practices.

Core Features & Use Cases

Consistency auditing: compare function names, parameter names, option keys, enum values, and type names against common industry patterns.
Standardization recommendations: suggest unified naming conventions for teams to adopt.
Use case scenario: when evaluating a new library, generate a standardization report highlighting misalignments.

Quick Start

Provide a target library or module path to initiate an API naming review and generate a standardization report.

Frequently Asked Questions about sd-api-name-review

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

FAQPage Schema

How do I audit API naming conventions in a TypeScript library?▼

API naming consistency is achieved by extracting exported identifiers, parameter names, and options from a library, then comparing these public API surfaces against official documentation and industry standard patterns to generate a standardization report.

What is the best way to align public API names with industry standards during a code review?▼

Aligning public API names involves benchmarking function names, enum values, and type names against common industry patterns to provide standardization recommendations for teams to adopt during library design audits.

Can I use this API naming review for JavaScript modules or is it limited to TypeScript?▼

This API naming review applies to both JavaScript and TypeScript ecosystems, evaluating libraries or modules during review phases, design audits, or onboarding new contributors to ensure naming consistency.

How do I generate a standardization report for a new library's exported identifiers?▼

Generating a standardization report requires providing a target library or module path to initiate the API naming review, which extracts exported identifiers and highlights misalignments with industry standards.

What specific API surfaces are checked when performing a library naming audit?▼

A library naming audit checks function names, parameter names, option keys, enum values, and type names by using parallel research of official docs to benchmark these exported identifiers against industry naming conventions.

When do I need to run an API naming consistency audit for my codebase?▼

An API naming consistency audit is needed when evaluating a new library, conducting design audits, or onboarding new contributors to ensure public API surfaces align with industry-standard practices across projects.