code-style

Enforce consistent TypeScript coding standards across a codebase.

8|Updated Mar 28, 2024
One-click install
npx skills add https://github.com/joncrangle/.dotfiles --skill code-style-joncrangle
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-style
Source: https://github.com/joncrangle/.dotfiles/tree/main/dot_config/opencode/skills/code-style
Command: npx skills add https://github.com/joncrangle/.dotfiles --skill code-style-joncrangle

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Inconsistent coding styles across a TypeScript codebase cause maintenance headaches, poor onboarding, and scattered patterns.

Core Features & Use Cases

  • Discovery Phase: enforce a mandatory discovery workflow to identify patterns and interfaces to align across the project.
  • Coding Standards: establish strict TypeScript usage, avoid any, require explicit interfaces, and enforce robust error handling.
  • Verification & Tooling: provide guidelines for tests, linting, and tooling like bun and list_files to ensure repeatable quality checks.

Quick Start

Run a style audit to align the team's TypeScript coding practices.

Frequently Asked Questions about code-style

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

FAQPage Schema
How do I enforce consistent TypeScript coding standards across a team?

Run a style audit to enforce strict TypeScript coding standards, applying rules to avoid any types, require explicit interfaces, and ensure robust error handling. This process aligns team practices and improves codebase maintainability.

What's the best way to establish a discovery workflow for TypeScript coding patterns?

Establish a mandatory discovery phase to identify existing patterns and interfaces to align across the project. This prevents scattered patterns and maintenance headaches before enforcing strict TypeScript coding standards.

How do I avoid using any and require explicit interfaces in a TypeScript codebase?

Apply strict coding standards during development and code reviews to avoid using any and require explicit interfaces in a TypeScript codebase. This ensures clear interface definitions and maintainable code across teams.

Can I use bun and linting tools to verify TypeScript coding standards?

Yes, you can use tooling like bun and linting to verify TypeScript coding standards. These tools provide guidelines for tests and repeatable quality checks, ensuring that strict typing and robust error handling are maintained.

How do I run a style audit to align TypeScript coding practices?

Run a style audit to align TypeScript coding practices by applying defined coding standards, verification steps, and tooling guidance. This audit evaluates strict typing, interface clarity, and robust error handling across the codebase.