Back to list
crmagz

formatting-standards

by crmagz

A comprehensive AWS Cloud Development Kit (CDK) library providing infrastructure-as-code constructs and utilities for AWS applications

6🍴 0📅 Jan 20, 2026

SKILL.md


name: formatting-standards description: Formatting and linting standards using GTS, ESLint, and Prettier. Use when writing or formatting TypeScript code in this project.

Formatting Standards

Tools

This repository uses:

  • ESLint for code quality (extends GTS)
  • Prettier for formatting (extends GTS)
  • GTS (Google TypeScript Style) for TypeScript style

Configuration Files

  • .eslintrc.json - ESLint configuration (extends GTS)
  • .prettierrc.js - Prettier configuration (extends GTS)
  • .eslintignore - Files to ignore for linting
  • .prettierignore - Files to ignore for formatting

Formatting Rules

Based on GTS and project configuration:

  • Indentation: 4 spaces (not tabs)
  • Line Width: 160 characters
  • Import Spacing: Spaces around braces: { Item } not {Item}
  • Function Signatures: Multi-line when they exceed print width
  • Arrow Functions: Parentheses around single parameters: (x) => not x =>
  • Quotes: Single quotes (from GTS)
  • Semicolons: Required (from GTS)
  • Trailing Commas: ES5 style (from GTS)

Running Formatting

# Format all files
npm run format

# Check formatting without writing
npm run format:check

# Format and fix linting issues
npm run format:fix

VS Code Integration

Format on save is configured in .vscode/settings.json:

  • Prettier is the default formatter
  • ESLint auto-fix on save
  • Format on save enabled for TypeScript, JavaScript, JSON

Before Committing

Always run:

npm run format:fix

This ensures:

  • Code is formatted according to GTS/Prettier rules
  • Linting issues are automatically fixed
  • Consistent code style across the repository

Score

Total Score

70/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

+10
説明文

100文字以上の説明がある

+10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新がある

0/10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

0/5

Reviews

💬

Reviews coming soon