Iron Tools

A monorepo of specialized CLI tools for managing course materials by dynamically updating index.yaml files.

Table of Contents

• Iron Tools
  • Table of Contents
  • Overview
  • Features
  • Packages
  • Installation
  • Quick Start
  • Usage
    • Calendar Synchronization
    • Holiday Management
  • Development
    • Prerequisites
    • Setup
    • Scripts
    • Testing
    • Linting
  • Project Structure
  • Contributing
    • Development Guidelines
  • Error Handling
  • License

Overview

Iron Tools is a comprehensive monorepo containing specialized CLI tools designed for Ironhack course editors to efficiently manage course schedules. The tools automate the process of updating index.yaml files with synchronized dates and holiday insertions while maintaining proper course structure and numbering.

Features

• Unified CLI Interface: Single command-line tool for all operations
• Calendar Synchronization: Automatically insert dates into course schedules
• Holiday Management: Insert holidays and redistribute content across weeks
• Backup Creation: Automatic backup files to prevent data loss
• Sequential Consistency: Maintains proper week and day numbering
• Detailed Logging: Comprehensive progress tracking and error reporting
• Monorepo Architecture: Organized, maintainable codebase with shared utilities

Packages

| Package | Description | Version | | -------------------- | ------------------------------ | ------- | | @iron-tools/cli | Unified command-line interface | 1.0.0 | | @iron-tools/calendar | Calendar synchronization tool | 1.0.0 | | @iron-tools/holiday | Holiday insertion tool | 1.0.0 |

Installation

Install the unified CLI globally using npm:

npm install -g @iron-tools/cli
iron-tools --version

Quick Start

1. Navigate to your course directory containing index.yaml
2. Synchronize calendar dates:

   iron-tools @calendar -d 7 -m 4 -y 2025 -f index.yaml

3. Insert a holiday:

   iron-tools @holiday -w 2 -d 5 -f index.yaml

Usage

Calendar Synchronization

Insert synchronized dates starting from a specific date:

iron-tools @calendar -d <day> -m <month> -y <year> -f <file>

Reset all inserted dates:

iron-tools @calendar --reset -f <file>

Holiday Management

Insert a holiday on a specific week and day:

iron-tools @holiday -w <week> -d <day> -f <file>

Development

Prerequisites

• Node.js >= 16.0.0
• npm >= 8.0.0

Setup

1. Clone the repository:

   git clone https://github.com/omardieh/iron-tools.git
   cd iron-tools

2. Install dependencies:

   npm install

3. Build all packages:

   npm run build

Scripts

| Script | Description | | -------------------------- | -------------------------------- | | npm start | Run the CLI tool | | npm test | Run all tests | | npm run test:unit | Run unit tests only | | npm run test:integration | Run integration tests only | | npm run test:coverage | Run tests with coverage report | | npm run test:watch | Run tests in watch mode | | npm run lint | Lint all packages | | npm run lint:fix | Fix linting issues | | npm run clean | Clean node_modules and coverage | | npm run clean:install | Clean and reinstall dependencies | | npm run build | Lint and test all packages | | npm run release | Build and publish all packages |

Testing

Run the test suite:

# All tests
npm test

# Unit tests only
npm run test:unit

# Integration tests only
npm run test:integration

# With coverage
npm run test:coverage

# Watch mode
npm run test:watch

Linting

Maintain code quality:

# Check for linting issues
npm run lint

# Fix linting issues automatically
npm run lint:fix

Project Structure

iron-tools/
├── packages/
│   ├── cli/                 # Unified CLI interface
│   ├── calendar/            # Calendar synchronization tool
│   └── holiday/             # Holiday insertion tool
├── .gitignore
├── .npmignore
├── jest.config.js
├── package.json
└── README.md

Each package contains:

• lib/ - Source code and utilities

• bin/ - Executable CLI scripts

• __tests__/ - Test files

• README.md

• Package-specific documentation

package.json

• Package configuration

Contributing

1. Fork the repository
2. Create a feature branch:

   git checkout -b feature/your-feature-name

3. Make your changes and add tests
4. Run the test suite:

   npm run build

5. Commit your changes:

   git commit -m "Add your feature description"

6. Push to your branch:

   git push origin feature/your-feature-name

7. Open a pull request

Development Guidelines

• Follow existing code style and conventions
• Add tests for new functionality
• Update documentation as needed
• Ensure all tests pass before submitting
• Use conventional commit messages

Error Handling

Iron Tools provides comprehensive error handling with detailed messages for common issues:

• Invalid file paths or formats
• Missing required arguments
• File parsing errors
• Invalid date or week/day numbers
• Permission issues when creating backups

All tools create automatic backups before making changes to prevent data loss.

License

This project is licensed under the MIT License. See the LICENSE file for details.

⚠️ This is a private proprietary package. Not intended for public use or redistribution.