Bootstrap 4 to 5 Migration Tool

A command-line script that automates the upgrade process from Bootstrap 4 to Bootstrap 5 by replacing class names in HTML pages and templates.

Overview

This tool uses gulp with gulp-replace to systematically replace Bootstrap 4 class names with their Bootstrap 5 equivalents across your project's HTML files. It streamlines the migration process by handling the tedious task of updating class names throughout your codebase.

Project Structure

Instructions for GitHub Copilot

When working with this project, follow these guidelines:

1. **Code Standards**

- Format all code with Prettier before committing

- Lint JavaScript code using ESLint 8.57.1 configuration

- Write documentation and comments in US English

- Follow existing code style and patterns

2. **Dependency Management**

- Ensure all npm packages are up to date before running the script

- Use Node.js v18 or later

- Verify gulp and gulp-replace are properly installed

3. **Development Workflow**

- Test class name replacements on sample files before running on entire project

- Maintain backward compatibility where possible

- Document any new replacement patterns added

4. **Class Name Replacements**

- Focus on systematic replacement of Bootstrap 4 classes to Bootstrap 5 equivalents

- Handle edge cases where class names have similar prefixes

- Preserve custom classes and non-Bootstrap styling

5. **Testing**

- Validate HTML structure remains intact after replacements

- Check that replaced classes match Bootstrap 5 documentation

- Test on diverse HTML templates (pages, components, layouts)

Usage

When generating code or providing suggestions:

Common Migration Patterns

Constraints