typescript-style-review

$npx mdskill add GerritCodeReview/gerrit/typescript-style-review

Reviews TypeScript code against Google TS Style Guide

  • Identifies violations of the Google TypeScript Style Guide in TypeScript files.
  • Depends on the official Google TypeScript Style Guide for reference and enforcement.
  • Decides based on the presence and adherence to rules specified in the style guide.
  • Delivers results as comments directly within the code, suggesting fixes.

SKILL.md

.github/skills/typescript-style-reviewView on GitHub ↗
---
name: typescript-style-review
description: Reviews TypeScript code against the Google TS Style Guide.
---

# TypeScript Style Review Guide

## Executive Summary

This guide serves as the instruction set for reviewing TypeScript code. The
goal is to ensure that all TypeScript code adheres to the official Google
TypeScript Style Guide.

## Guidelines

You must review the TypeScript files in the changelist and ensure they comply
with the rules and best practices outlined in the official Google TypeScript
Style Guide.

### Reference
*   **Google TypeScript Style Guide**:
    https://google.github.io/styleguide/tsguide.html

## Review Instructions

When performing the review:
1.  Identify any violations of the Google TypeScript Style Guide.
2.  For each violation, provide a clear explanation of the problem, a
    suggestion for how to fix it (with a code snippet if appropriate), and a
    reference to the relevant section of the style guide.
3.  Format your comments using the following template:

### Problem
Clearly and succinctly describe the style guide violation.

### Suggestion
Provide a suggestion for improvement, including a code snippet.

### Reference
Provide the link to the relevant section in the Google TypeScript Style Guide
(e.g.,
`https://google.github.io/styleguide/tsguide.html#visibility-of-properties-accessed-from-templates`).

More from GerritCodeReview/gerrit