Avoid Inferable Annotations

What it does

This skill helps AI agents write more explicit and readable TypeScript code by avoiding the use of type inference where possible. It encourages developers to explicitly define types, leading to improved clarity and reduced potential for unexpected behavior. The skill promotes a style that prioritizes maintainability and reduces ambiguity in larger projects.

When to use it

• When refactoring existing JavaScript or TypeScript codebases to improve readability and reduce implicit type assumptions.
• During code reviews to enforce consistent typing practices within a team.
• When working on complex projects where explicit type annotations are crucial for maintainability and debugging.
• To onboard new developers to a project with specific TypeScript style guidelines.

Key capabilities

• Explicit Type Annotations: Promotes the use of : string, : number, etc., instead of relying solely on type inference.
• Code Readability: Encourages code that is easier to understand and reason about.
• Maintainability: Reduces ambiguity and simplifies future modifications.

Example prompts

• "Rewrite this TypeScript function to explicitly define all types."
• "Review this code snippet for opportunities to use explicit type annotations."
• "Suggest improvements to this code to make it more readable by avoiding implicit typing."

Tips & gotchas

This skill is most effective when used in conjunction with a linter or formatter configured to enforce the desired TypeScript style. While explicit types improve clarity, excessive verbosity can also hinder readability; balance is key.