In una frase
Generate React CLI è un programma che si usa dal terminale. Serve a creare in un solo comando i file di base di un componente React, cioè un pezzo riutilizzabile di pagina web.
Cos’è e a cosa serve
React è una tecnologia per costruire l’interfaccia dei siti web, utilizzando elementi chiamati componenti. Un componente è una parte dell’interfaccia, per esempio un pulsante, un’intestazione o un riquadro con un titolo.
Ogni componente ha di solito più file:
- Il codice va in un file
.js; - L’aspetto va in un foglio di stile;
- Un file di test, cioè un controllo automatico, verifica che il componente funzioni.
Creare questi file a mano è ripetitivo. Devi creare le cartelle, usare gli stessi nomi e collegare i file tra loro. Se sbagli a digitare un nome rompi il collegamento.
Generate React CLI fa questo lavoro al posto tuo. Lo lanci dalla cartella del progetto e scrivi il nome del componente. Il programma crea cartelle e file, sempre con la stessa struttura.
Al primo avvio il programma ti fa alcune domande sul progetto, per esempio se usi TypeScript. Le risposte finiscono nel file generate-react-cli.json, così non le ripeti ogni volta.
Il programma usa dei modelli, detti template: testi di partenza da cui crea i file. Puoi usare quelli incorporati oppure sostituirli con i tuoi. Puoi anche definire tipi di componenti diversi, per esempio le pagine.
Un esempio concreto
Creeremo una cartella vuota con un progetto di prova e generemo con un solo comando i componenti Header, Button e Card.
Può servirti se prepari l’interfaccia di un piccolo sito e non vuoi scrivere tre volte la stessa struttura di file. Alla fine avrai tre cartelle in src/components, ognuna con il componente, il foglio di stile e il test.
Cosa vedrai nel terminale (non va scritto: serve solo per confrontare):
import styles from './Button.module.css';
const Button = () => (
<div className={styles.Button} data-testid="Button">
Button Component
</div>
);
export default Button;
A chi serve (e a chi no)
Vale la pena provarlo se rientri in uno di questi profili:
- studente o principiante: vuoi vedere com’è fatto un componente React senza scrivere ogni file a mano.
- sviluppatore front-end: lavori alla parte visibile di un sito e crei spesso componenti simili tra loro.
- team con una convenzione: il tuo team vuole che tutti creino file e cartelle nello stesso modo.
- Non serve se il tuo progetto non usa React, perché il programma crea file per componenti React.
- Non serve se cerchi un programma che scriva il codice di una pagina intera: crea solo lo scheletro dei file.
Scheda del progetto
- Nome: generate-react-cli
- Repository: https://github.com/arminbro/generate-react-cli
- Versione: 11.0.6
- Licenza: MIT
Cosa ti serve per provarlo, e cosa NON serve
Ti servono tre cose: un terminale, Node.js e git.
Il progetto si scarica da https://github.com/arminbro/generate-react-cli, e il primo passo del percorso lo scarica con git.
Python non serve: il progetto è scritto in JavaScript, il linguaggio dei siti web, e gira con Node.js. Non servono chiavi né account. Ti serve solo una connessione internet.
Proviamolo passo per passo
Passo 1: installa il progetto
Cosa facciamo: scarichiamo il progetto e installiamo le sue dipendenze, cioè i programmi di supporto di cui ha bisogno.
Scrivi nel terminale, da una cartella a tua scelta:
git clone https://github.com/arminbro/generate-react-cli
cd generate-react-cli
git checkout 280e99a
npm install
cd ..
mkdir progetto-demo
cd progetto-demo
Cosa vedrai nel terminale:
Cloning into 'generate-react-cli'...
Note: switching to '280e99a'.
You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
Cosa vedrai: le prime righe dell’output sono in inglese. Cloning vuol dire che la copia è in corso. Il resto dell’output è normale. Lo snippet sopra mostra solo le prime righe: l’output reale è più lungo, ma le prime righe coincidono.
Come capire che è andato bene: non compaiono messaggi di errore e il terminale torna pronto a ricevere un nuovo comando.
Passo 2: svolgi l’esercizio
Cosa facciamo: creiamo una cartella di prova vuota, scriviamo le scelte del progetto nel file generate-react-cli.json e lanciamo il programma per i tre componenti.
Scrivi nel terminale, dalla cartella progetto-demo:
npm init -y
echo '{"usesTypeScript":false,"usesStyledComponents":false,"usesCssModule":true,"cssPreprocessor":"css","testLibrary":"Testing Library","component":{"default":{"path":"src/components","withLazy":false,"withStory":false,"withStyle":true,"withTest":true}}}' > generate-react-cli.json
node ../generate-react-cli/bin/generate-react.js component Header Button Card
ls -R src
cat src/components/Button/Button.js
Cosa vedrai nel terminale:
Wrote to /work/progetto-demo/package.json:
{
"name": "progetto-demo",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC"
}
✓ Created 3 files in src/components/Header
├── ✓ Header.js
├── ✓ Header.module.css
└── ✓ Header.test.js
✓ Created 3 files in src/components/Button
├── ✓ Button.js
├── ✓ Button.module.css
└── ✓ Button.test.js
✓ Created 3 files in src/components/Card
├── ✓ Card.js
├── ✓ Card.module.css
└── ✓ Card.test.js
src:
components
src/components:
Button
Card
...
Cosa vedrai: il programma risponde in inglese. Created 3 files vuol dire “creati 3 file”. Vedrai anche l’elenco delle cartelle e il codice di un componente. L’output sopra è troncato: quello reale è più completo.
Come capire che è andato bene: dentro src/components ci sono tre cartelle: Header, Button e Card. In ognuna trovi tre file, per esempio per Header: Header.js, Header.module.css e Header.test.js.
Cosa è successo dietro le quinte
La cartella di prova diventa un progetto Node.js. Il comando npm crea un file package.json, che contiene il nome del progetto e i suoi dati di base.
Il file generate-react-cli.json contiene le scelte: niente TypeScript, file di stile con CSS module, test con Testing Library, una libreria per scrivere test di componenti, e componenti dentro src/components. Normalmente il programma chiederebbe queste scelte al primo avvio. Qui le scriviamo direttamente nel file, e il motivo è spiegato nella sezione dei limiti. Un CSS module è un foglio di stile che vale solo per il componente a cui appartiene.
Il comando node avvia il programma dalla cartella scaricata, senza installarlo nel sistema. La parola component e i tre nomi dicono al programma cosa creare.
Per ogni nome il programma crea una cartella e ci scrive i file. Usa la stessa procedura per tutti e tre. Sceglie il modello JavaScript, perché TypeScript è disattivato, e il modello con il foglio di stile CSS module.
Ogni file parte da un modello incorporato. Il componente Button collega il proprio foglio di stile e mostra un elemento con il suo nome, pronto per essere modificato.
Se vuoi vedere cosa verrebbe creato senza scrivere nulla, c’è l’opzione --dry-run. Si aggiunge al comando, dopo i nomi dei componenti.
Cosa tenere presente
Serve Node.js 22 o superiore. Con una versione più vecchia il programma esce con un errore. Controlla la versione installata prima di iniziare.
Le domande iniziali richiedono qualcuno che risponda. Se il programma non riceve risposte, il file delle scelte non viene creato e compare un errore. Per questo il percorso crea quel file con un comando, al posto delle domande.
Il tipo di componente si scrive con il segno uguale. Scrivi --type=page. Con lo spazio, --type page, il programma risponde con un errore.
Il progetto non ha comandi di test né di build. Non c’è un comando predefinito per il test, né per la build, cioè il passo che prepara il programma per l’uso. Se lo modifichi, non trovi un controllo automatico già pronto.
Da dove iniziare a leggere il codice
Il primo file da aprire è bin/generate-react.js. È il file che hai lanciato con node, quindi da lì parte il programma.
bin/generate-react.js: il file che avvia il programma e controlla la versione di Node.js.src/commands/generateComponent.js: il comandocomponente la ripetizione che crea i file per ogni nome.src/utils/generateComponentUtils.js: la scelta dei modelli e del foglio di stile per ogni file.
Glossario
- terminale: la finestra in cui scrivi comandi di testo, invece di usare il mouse.
- CLI: programma che si usa scrivendo comandi nel terminale.
- Node.js: programma che fa girare codice JavaScript fuori dal browser, cioè fuori dalla pagina web.
npm: strumento che installa le dipendenze di un progetto Node.js, cioè i programmi di supporto che usa.git: programma che copia un progetto da GitHub sul tuo computer.- template: testo di partenza da cui il programma crea i file.
Nota sulla prova
Il percorso è stato provato su Debian 12 in WSL2, cioè Linux dentro Windows, con Node.js 22 e npm 10. Non sono stati provati Windows nativo, cioè senza WSL2, e macOS.