Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/helgesverre/blade-heroicons-upgrader

Package to upgrade all icons in your project using blade-heroicons from v1.0.6 to v2.1.1.
https://github.com/helgesverre/blade-heroicons-upgrader

blade icons laravel svg upgrader

Last synced: 24 days ago
JSON representation

Package to upgrade all icons in your project using blade-heroicons from v1.0.6 to v2.1.1.

Awesome Lists containing this project

README

        

# Blade Heroicons Upgrader

[![Latest Version on Packagist](https://img.shields.io/packagist/v/helgesverre/blade-heroicons-upgrader.svg)](https://packagist.org/packages/helgesverre/blade-heroicons-upgrader)

## Storytime.

[Skip to installation](#installation)



















## What it does.

> This only supports [Blade Heroicons](https://github.com/blade-ui-kit/blade-heroicons).

🔧 Blade Heroicons Upgrader is a Laravel tool specifically designed for updating from Heroicons v1 to v2 in Blade files.
It simplifies the process of transitioning to the latest Blade Heroicons version, making it quick and effortless.

This tool replaces old icon names in your code, such as `@svg("clipboard-check")` and ``, and
updates them to their new v2 equivalents such as `@svg("clipboard-document-check")`
and ``.

It's built to prevent overlapping or incorrect updates, ensuring that icons are not mistakenly transformed into something
like ``.

## Installation

You can install the package via composer:

```bash
composer require --dev helgesverre/blade-heroicons-upgrader
```

## Usage

Run the command to upgrade your blade files:

```bash
php artisan blade-heroicons-upgrader:upgrade
```

You may also specify one or more files or directories to run replacements on:

```bash
php artisan blade-heroicons-upgrader:upgrade ./resources/views ./app/Composers/MenuComposer.php
```

You can also do a dry run to see how many replacements in which files will be done.

```bash
php artisan blade-heroicons-upgrader:upgrade --dry
```

## FAQ

**Q: Does it work for other icon sets?**
A: No, maybe in the future

**Q: My icon was replaced with the wrong one. What should I do?**
A: If you encounter any incorrect replacements, Please submit a pull
request with the correction. Your help in would be greatly appreciated!

**Q: Why did you build this?**
A: I had to do this process manually 4 times this year, and was tired of doing it.

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.