# @massimo-cassandro/create-favicons

> Favicon files builder

Latest version **1.5.4** (published 2026-06-02) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @massimo-cassandro/create-favicons
pnpm add @massimo-cassandro/create-favicons
yarn add @massimo-cassandro/create-favicons
bun add @massimo-cassandro/create-favicons
```

Provides the command `create-favicons`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.5.4 |
| Published | 2026-06-02 |
| First published | 2024-02-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | >= 18.0.0 |
| Dependencies | 3 |
| Unpacked size | 23.5 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Massimo Cassandro |
| Maintainers | massimo-cassandro |

## Links

- npm: https://www.npmjs.com/package/@massimo-cassandro/create-favicons
- Repository: https://github.com/massimo-cassandro/create-favicons.git#main
- Homepage: https://github.com/massimo-cassandro/create-favicons/tree/main#readme
- Issues: https://github.com/massimo-cassandro/create-favicons/issues
- npm.io page: https://npm.io/package/@massimo-cassandro/create-favicons

## Dependencies (3)

- [svgo](https://npm.io/package/svgo.md) ^4.0.1
- [sharp](https://npm.io/package/sharp.md) ^0.34.5
- [sharp-ico](https://npm.io/package/sharp-ico.md) ^0.1.5

## Recent versions

- 1.5.4 (latest) — 2026-06-02
- 1.5.3 — 2026-03-16
- 1.5.2 — 2026-01-28
- 1.5.1 — 2026-01-27
- 1.5.0 — 2026-01-26
- 1.4.1 — 2025-08-03
- 1.4.0 — 2025-04-30
- 1.3.7 — 2025-04-14
- 1.3.6 — 2024-08-25
- 1.3.5 — 2024-08-07
- 1.3.4 — 2024-03-20
- 1.3.3 — 2024-03-10
- 1.3.2 — 2024-03-10
- 1.3.1 — 2024-03-02
- 1.3.0 — 2024-03-02
- … 2 more at https://npm.io/package/@massimo-cassandro/create-favicons/versions

## README

# Create favicons

Crea i file favicons come descritto in [How to Favicon in 2024](https://evilmartians.com/chronicles/how-to-favicon-in-2021-six-files-that-fit-most-needs).

I file da elaborare devono essere in formato SVG, mentre quelli generati sono in formato SVG (favicon), PNG (apple-touch-icon e altri file per android), e ICO (altro favicon per compatibilità con i browser meno recenti). Vengono inoltre genrati i file `manifest.webmanifest` e uno snippet html, opzionale, con i tag `link` per l'inserimento degli elementi generati.

Le immagini sono generate con [Sharp](https://sharp.pixelplumbing.com/), [SVGO](https://github.com/svg/svgo) e [sharp-ico](https://github.com/ssnangua/sharp-ico).

## Installazione

```bash
npm i -D @massimo-cassandro/create-favicons
```


## Creazione template file di config (vedi più avanti)

```bash
npx create-favicons init
```


## Utilizzo

```bash
npx create-favicons [--dir=./path/to/dir]
```

Lo script agisce normalmente nella directory corrente, ma, utilizzando il parametro opzionale `--dir`, 
è possibile specificare una directory alternativa (percorso relativo alla dir di esecuzione). 

Lo script in prima battuta cerca nella dir di lavoro il file `create-favicons-cfg.mjs` che contiene un oggetto
con tutti i parametri necessari (vedi di seguito).

In sua assenza, cerca il file `favicon-src.svg` da utilizzare come sorgente per tutte le immagini, e assumendo i valori di default (vedi dopo) per tutti gli altri parametri. 

Tra gli altri, è possibile spcificare il parametro `small_src_img` nel caso sia necessario specificare un'immagine ottimizzata per le piccole dimensioni (32px).

Il formato migliore per i file sorgenti è SVG, o in alternativa PNG.

In assenza di entrambi i file viene restituito un errore.

I parametri di default sono elencati in dettaglio nel file `src/create-favicons/src/default-params.mjs`, 
e possono essere personalizzati nel file di configurazione, che deve avere questa forma: 

```javascript
// file create-favicons-cfg.mjs
const params = [{ /* ... */ }];

export default params;
```

`params` può essere un oggetto o un array. In quest'ultimo caso, ogni elemento dell'array corrisponde ad un diverso set di favicons.

Per creare un file di cfg di esempio **nella directory corrente** (con tutti i valori di default e la loro descrizione), 
utilizzare il comando:

```bash
npx create-favicons init
```

## Utilizzo da remoto

I comandi possono essere eseguiti anche senza installare preventivamente il package:

```
npx --package=@massimo-cassandro/dev-utilities create-favicons init
npx --package=@massimo-cassandro/dev-utilities create-favicons [--dir=...]

```

## Esecuzione

Lo script produce le varie immagini png ed svg, il file `manifest.webmanifest` e uno snippet html (o nel linguaggio indicato nel parametro `snippet_language`).
Tutte le immagini vengono ottimizzate con [SVGO](https://github.com/svg/svgo) e [imagemin](https://github.com/imagemin/imagemin).

Tutti file vengono salvati nella dir indicata in `output_dir` (default: directory corrente).

Opzionalmente il file snippet può essere salvato in una directory differente (`snippet_path`) o si può decidere di non crearlo, 
impostando il valore `snippet_name` a `null`.

Nel file di configurazione è anche possibile impostare il parametro `webmanifest_extra`, che permette di aggiungere voci aggiuntive al file *manifest*.
Per ulteriori info: <https://developer.mozilla.org/en-US/docs/Web/Manifest>

File generati:

```html
<link rel="icon" href="/favicon.ico" sizes="any"> <!-- 32×32 + 16x16 -->
<link rel="icon" href="/icon.svg" type="image/svg+xml">
<link rel="apple-touch-icon" href="/apple-touch-icon.png"> <!-- 180×180 -->
<link rel="manifest" href="/manifest.webmanifest">
```

```javascript
// manifest.webmanifest
{
  "icons": [
    { "src": "/icon-192.png", "type": "image/png", "sizes": "192x192" },
    { "src": "/icon-512.png", "type": "image/png", "sizes": "512x512" }
  ]
}
```

Vedi anche esempio in <https://github.com/massimo-cassandro/dev-utilities/tree/main/test/test/create-favicons-test>.

---
_Source: https://npm.io/package/@massimo-cassandro/create-favicons · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
