README.md

TypeScript Kata Starter

A collection of coding katas following the learning path from Agile Technical Practices Distilled.

Status

Note: This repository contains code intended for refactoring practice. The initial metrics are expected to improve as you work through the katas.

Getting Started

Testing

# Run all tests
yarn test

# Run with coverage
yarn test:ci

# Run mutation tests
yarn mutants

# Watch mode
yarn watch

Individual Kata Tests

yarn fizz     # FizzBuzz
yarn leap     # Leap Year
yarn fib      # Fibonacci
yarn stack    # Stack Kata
yarn roman    # Roman Numerals
yarn prime    # Prime Factors
yarn tic      # Tic Tac Toe
yarn yahtzee  # Yahtzee
yarn mars     # Mars Rover
yarn tennis   # Tennis
yarn rose     # Gilded Rose
yarn golf     # All Refactoring Golf Tests
yarn smelly   # Smelly Tic Tac Toe
yarn copier   # Character Copier
yarn tac      # Tic Tac Toe (Alternative)
yarn esa      # ESA Mars Rover
yarn katacombs # Katacombs

# Refactoring Golf Individual Holes
yarn golf1    # Golf Hole 1
yarn golf2    # Golf Hole 2
yarn golf3    # Golf Hole 3
yarn golf4    # Golf Hole 4
yarn golf5    # Golf Hole 5
yarn golf6    # Golf Hole 6
yarn golf7    # Golf Hole 7
yarn golf8    # Golf Hole 8
yarn golf9    # Golf Hole 9
yarn golf10   # Golf Hole 10
yarn golf11   # Golf Hole 11
yarn golf12   # Golf Hole 12

Development

# Build project
yarn ci

# Lint code
yarn lint

Project Tools

Code Quality

• ESLint - Linting with TypeScript support
• Prettier - Code formatting
• Type Coverage - TypeScript type analysis

Testing & Quality

• Jest - Test framework
• Fast-Check - Property-based testing
• Stryker - Mutation testing

CI/CD

• Commit Lint - Conventional commit messages
• Husky - Git hooks
• GitHub Actions - Automated workflows
• Sonar Cloud - Code analysis
• CodeScene - Code health metrics