URL Switch

A powerful browser extension for bidirectional URL switching and redirection between related websites.

Features • Installation • Usage • Documentation • Contributing • License

🚀 Features

• Bidirectional URL Conversion: Seamlessly switch between related websites (e.g., github.com ↔ github.dev)
• Powerful Rule Management: Create, edit, and organize URL conversion rules
• Group Organization: Rules can be organized into logical groups (GitHub, StackOverflow, etc.)
• Flexible Control: Global extension toggle and per-rule group enabling/disabling
• Auto-redirect Mode: Automatically redirect to the target site based on your rules
• Import/Export: Easily backup and share your rule configurations
• Multilingual Support: Full interface available in English and Chinese (中文)

📥 Installation

From GitHub Releases

1. Go to the Releases page
2. Download the latest .zip file
3. Unzip the file to a local folder
4. Open Chrome and navigate to chrome://extensions
5. Enable "Developer mode" in the top-right corner
6. Click "Load unpacked" and select the unzipped folder

From Chrome Web Store (Coming Soon)

URL Switch will be available in the Chrome Web Store soon.

Manual Installation (Developer Mode)

1. Clone this repository

   git clone https://github.com/pyth0nb3st/URLSwitch.git
   cd URLSwitch

2. Install dependencies

   npm install

3. Build the extension

   npm run build

4. Load in Chrome

   • Open Chrome and navigate to chrome://extensions
   • Enable "Developer mode" in the top-right corner
   • Click "Load unpacked" and select the dist directory from this project

💡 Usage

Basic Usage

1. Navigate to any website
2. Click the URL Switch icon in your browser toolbar
3. Select from available redirects for the current page
4. Toggle "Auto Redirect" for automatic switching

Options Page

Access the options page by:

• Right-clicking the extension icon and selecting "Options"
• Clicking "Settings" in the extension popup

In the options page, you can:

• Create and manage rule groups
• Add, edit or delete URL conversion rules
• Configure global settings
• Import/export your rules

📚 Documentation

URL Pattern Format

URL Switch uses regular expressions for matching and transforming URLs:

• From Pattern: The regex pattern to match source URLs
• To Pattern: The transformation pattern with capture group references

Example:

• From Pattern: ^https?://github\.com/([^/]+/[^/]+)(?:/.*)?$
• To Pattern: https://github.dev/$1

This converts https://github.com/username/repo to https://github.dev/username/repo

Project Structure

• /src - Source code
  • /background - Background service worker
  • /content - Content scripts
  • /popup - Extension popup UI
  • /options - Options page UI
  • /hooks - React hooks
  • /utils - Utility functions
  • /_locales - Localization files
• /icons - Extension icons
• /.github/workflows - CI/CD configuration

🛠️ Development

Prerequisites

• Node.js 18+ and npm

Development Mode

Start the development server:

npm run dev

Building and Packaging

Build the extension:

npm run build

Package the extension as a zip file:

npm run package

Releasing New Versions

The project includes automated versioning and release scripts:

# For patch version (1.0.0 -> 1.0.1)
npm run release:patch

# For minor version (1.0.0 -> 1.1.0)
npm run release:minor

# For major version (1.0.0 -> 2.0.0)
npm run release:major

These commands will:

1. Update the version in manifest.json
2. Commit the changes
3. Create a git tag
4. Push to GitHub
5. Trigger the CI/CD pipeline to build and create a release

CI/CD Pipeline

This project uses GitHub Actions for continuous integration and delivery:

• Automatically builds the extension on pushes to main branch
• Creates releases with packaged .zip files when a new tag is pushed
• Generates release notes automatically

👥 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📄 License

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