typescript-conventions

Enforce TypeScript best practices for strict typing and PR reviews.

Updated Aug 27, 2026

Search Tags:#typescript #documentation #code-quality #best-practices #lint #typing

Ready to run

npx skills add https://github.com/bkinsey808/songshare-effect --skill typescript-conventions

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: typescript-conventions
Source: https://github.com/bkinsey808/songshare-effect/tree/main/.github/skills/typescript-conventions
Command: npx skills add https://github.com/bkinsey808/songshare-effect --skill typescript-conventions

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill establishes a unified baseline for TypeScript coding standards to improve safety, readability, and maintainability across the codebase.

Core Features & Use Cases

Enforces strict typing by discouraging the use of any and promoting unknown when necessary.
Recommends preferring type over interface for object shapes and enforces explicit return types.
Documents code with JSDoc principles and ensures consistent typing guidance across modules.
Provides practical conventions for unions, ambient types, and parameter destructuring in function signatures.
Guides developers during authoring and PR reviews to uphold the repository’s TypeScript integrity.

Quick Start

Apply these conventions when authoring new TypeScript modules or reviewing PRs to ensure strict typing and clear documentation.

Frequently Asked Questions about typescript-conventions

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

FAQPage Schema

How do I enforce strict typing and avoid any in TypeScript modules?▼

Enforce strict typing by discouraging any and promoting unknown when necessary. Apply these conventions during module authoring and PR reviews to ensure consistent type safety across your codebase.

What is the best way to standardize TypeScript conventions for a codebase?▼

Standardize TypeScript conventions by preferring type over interface, enforcing explicit return types, and applying JSDoc principles to improve codebase readability and maintainability.

How do I document TypeScript code for consistent module authoring?▼

Document TypeScript code using JSDoc conventions and consistent frontmatter documentation to ensure clear typing guidance and consistent adoption across modules.

Does this TypeScript linting approach support PR reviews and type-checking validation?▼

Yes, this approach supports PR reviews by requiring linting and type-checking validation. It guides developers to uphold repository integrity through consistent typing and explicit return types during code reviews.

When should I use union types and ambient types in TypeScript?▼

Use union types and ambient types when defining complex structures for module authoring. This skill provides practical conventions for implementing them alongside parameter destructuring in function signatures.