🖼️ Image WebP Optimizer

Um script Node.js simples que converte automaticamente imagens .png, .jpg e .jpeg para o formato .webp e atualiza todas as referências a essas imagens no código-fonte do projeto.

📋 O que ele faz

1. Varre a pasta /public recursivamente em busca de imagens com extensão .png, .jpg ou .jpeg.
2. Converte cada imagem para .webp usando a biblioteca Sharp, com qualidade de 80%.
3. Deleta o arquivo original após a conversão bem-sucedida.
4. Varre a pasta /src recursivamente em busca de arquivos de código (.js, .jsx, .ts, .tsx, .css, .scss, .json).
5. Substitui todas as referências a .png, .jpg e .jpeg por .webp nesses arquivos.

🚀 Como usar

Pré-requisitos

• Node.js instalado
• Projeto com estrutura de pastas /public e /src

Instalação

Clone ou copie este repositório e instale as dependências:

npm install

Você pode também instalar o pacote globalmente para rodar em outros projetos na sua máquina:

npm install -g image-webp-optimizer

Seguido de:

npx image-webp-optimizer

dentro da raíz do projeto.

Execução

Navegue até a raiz do projeto que deseja otimizar e execute:

npx optimize-images

Ou, se preferir rodar diretamente pelo caminho do script:

node /caminho/para/image-optimizer/index.js

O script deve ser executado na raiz do projeto alvo (onde ficam as pastas /public e /src).

⚙️ Como funciona internamente

Projeto alvo/
├── public/          ← Imagens .png/.jpg/.jpeg são convertidas para .webp aqui
│   └── ...
└── src/             ← Referências a imagens nos arquivos de código são atualizadas aqui
    └── ...

• A conversão usa sharp com quality: 80, que oferece um bom equilíbrio entre qualidade visual e tamanho de arquivo.
• A substituição de referências usa uma expressão regular que detecta .png, .jpg e .jpeg seguidos de ", ', ` ou ? (para suportar query strings em URLs).

⚠️ Limitações

• Apenas /public e /src: O script só procura imagens dentro da pasta /public e referências dentro da pasta /src. Imagens ou referências fora dessas pastas não serão processadas.
• Extensões suportadas: Somente .png, .jpg e .jpeg. Outros formatos como .gif, .svg, .bmp, .tiff etc. são ignorados.
• Substituição por regex: A atualização de referências no código é feita via expressão regular simples. Referências dinâmicas (ex: strings montadas em tempo de execução com concatenação ou template literals complexos) podem não ser detectadas.
• Sem rollback automático: Uma vez que o script é executado, os arquivos originais são deletados permanentemente. Não há desfazer automático.
• Sem suporte a .webp existentes: O script não verifica se já existe um .webp correspondente antes de converter — ele sempre reconverte e sobrescreve.
• Arquivos de código verificados: Apenas arquivos .js, .jsx, .ts, .tsx, .css, .scss e .json são varridos para atualização de referências. Arquivos como .html, .md, .env etc. não são atualizados.

🛡️ Recomendação importante

⚠️ Faça uma cópia da pasta /public antes de executar o script!

Como o script deleta os arquivos originais após a conversão, se algo não sair como esperado (falha de conversão, imagem corrompida, etc.), você não terá como recuperar as imagens originais sem um backup.

# Exemplo: copiar a pasta public antes de rodar o script (Windows)
xcopy /E /I public public_backup

# Exemplo no Linux/macOS
cp -r public public_backup

📦 Dependências

| Pacote | Versão | Descrição | |--------|--------|-----------| | sharp | ^0.34.5 | Biblioteca de processamento de imagens de alta performance |

👤 Autor

Matheus Henrique

📄 Licença

ISC