typescript

Enforce TypeScript conventions and branded types for Graph Explorer code.

476|102|Updated Oct 26, 2022
One-click install
npx skills add https://github.com/aws/graph-explorer --skill typescript-aws
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: typescript
Source: https://github.com/aws/graph-explorer/tree/main/.kiro/skills/typescript
Command: npx skills add https://github.com/aws/graph-explorer --skill typescript-aws

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill enforces consistent and safe TypeScript coding standards across the project, preventing type errors and promoting maintainable code.

Core Features & Use Cases

  • Type Safety: Utilizes branded types to prevent accidental mixing of similar identifiers.
  • Coding Conventions: Enforces specific function syntax and naming conventions.
  • Use Case: Ensure all vertex and edge identifiers are correctly typed and distinct, preventing runtime errors caused by using a string where a specific VertexId is expected.

Quick Start

Apply the typescript skill to ensure the current code adheres to all defined conventions.

Frequently Asked Questions about typescript

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

FAQPage Schema
How do I enforce TypeScript coding conventions across my project?

You can enforce TypeScript coding standards by applying rules that mandate specific function syntax preferences, naming conventions, and explicit type aliases to prevent type errors and promote maintainable code.

What are branded types in TypeScript and when do I need them?

Branded types in TypeScript prevent accidental mixing of similar identifiers by requiring explicit type aliases for distinct values like vertex and edge identifiers, ensuring type safety and preventing runtime errors.

How do I prevent accidental string usage where a specific identifier is expected?

Prevent accidental string usage by enforcing branded types and explicit type aliases for identifiers, ensuring that values like a specific VertexId are structurally distinct and preventing type mismatches at compile time.

Does this TypeScript convention enforcement work for graph data structures?

Yes, the TypeScript convention enforcement is designed for graph data structures, specifically ensuring vertex and edge identifiers are correctly typed and distinct to prevent runtime errors in graph explorer projects.

What TypeScript function style preferences should I follow for maintainability?

For maintainability, follow TypeScript function style preferences that enforce specific function syntax and naming conventions, alongside explicit type aliases, to standardize code quality and prevent type errors.