Skip to content

CLAUDE.md

Latest commit

 

History

History
88 lines (67 loc) · 3.37 KB

CLAUDE.md

File metadata and controls

88 lines (67 loc) · 3.37 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Repository Overview

This is a comprehensive TypeScript tutorial repository written in Japanese. It contains educational materials for learning TypeScript from basics to advanced concepts, culminating in a practical TODO application project.

Note: This repository contains tutorial documentation only - there is no actual TypeScript code implementation yet. When asked to work with code, refer to the examples within the tutorial chapters.

Tutorial Structure

The tutorial consists of 7 chapters:

  1. chapter1_basics.md: TypeScript fundamentals and environment setup
  2. chapter2_functions_interfaces.md: Functions and interfaces
  3. chapter3_classes_oop.md: Classes and object-oriented programming
  4. chapter4_generics_advanced.md: Generics and advanced types
  5. chapter5_modules_namespaces.md: Modules and namespaces
  6. chapter6_async_programming.md: Asynchronous programming
  7. chapter7_practical_project.md: Practical project setup and best practices

Recommended Project Commands

When implementing a TypeScript project based on this tutorial, use these commands (from chapter7_practical_project.md):

# Development
npm run dev          # Start development server with webpack
npm run build        # Production build
npm run prebuild     # Clean, lint, and type-check before build

# Testing
npm test             # Run tests with Jest
npm run test:watch   # Run tests in watch mode

# Code Quality
npm run lint         # Check code with ESLint
npm run lint:fix     # Auto-fix linting issues
npm run type-check   # Type checking without emitting files

# Utilities
npm run clean        # Clean build directory

Project Structure Template

When creating a TypeScript project based on this tutorial, use this structure:

my-todo-app/
├── src/
│   ├── components/      # UI components
│   ├── models/         # Data models
│   ├── services/       # Business logic
│   ├── utils/          # Utility functions
│   ├── types/          # Type definitions
│   ├── config/         # Configuration files
│   └── index.ts        # Entry point
├── tests/              # Test files
├── dist/               # Build output
├── package.json
├── tsconfig.json
├── webpack.config.js
├── jest.config.js
├── .eslintrc.json
└── .prettierrc

Key Configuration Files

The tutorial provides detailed examples of essential configuration files in Chapter 7:

  • tsconfig.json: Comprehensive TypeScript compiler configuration with strict mode enabled
  • package.json: Scripts and dependencies for a complete TypeScript development environment
  • .eslintrc.json: ESLint configuration with TypeScript-specific rules
  • .prettierrc: Code formatting configuration

Development Environment Requirements

  • Node.js v14 or higher
  • TypeScript installed globally: npm install -g typescript
  • Visual Studio Code (recommended editor)

Working with Tutorial Content

  • All tutorial content is in Japanese
  • Code examples in the tutorial are meant to be educational and may need adaptation for production use
  • When implementing features, always refer to the relevant chapter for context and best practices
  • Chapter 7 contains the most practical, production-ready guidance