5.0 KiB
Come lavorare sui progetti di pratica
La cartella tools/challenge-helper-scripts contiene strumenti per aiutare a facilitare la creazione e il mantenimento del curriculum basato su progetti di freeCodeCamp.
Creare un nuovo progetto
Esegui npm run create-project. Questo apre un'interfaccia utente a linea di comando che ti guida attraverso il processo. Una volta finito, dovrebbe esserci una nuova sfida nel curriculum inglese che puoi usare come primo passo del progetto. Ad esempio, se hai creato un progetto chiamato test-project nella certificazione Web Design Responsivo, sarebbe in curriculum/challenges/english/01-responsive-web-design/test-project.
Se vuoi creare nuovi passi, i seguenti strumenti semplificano quel processo.
create-next-step
A one-off script that will automatically add the next step based on the last step numbered as step-xxx.md where xxx represents the 3-digit step number of the last step. Il codice seed della sfida userà il codice seed di quella precedente, rimuovendo i marcatori delle regioni editabili (MRE).
Nota: Questo script esegue anche reorder-steps.
Come eseguire lo script:
- Vai alla directory del progetto.
- Esegui il seguente comando npm:
npm run create-next-step
create-empty-steps
Uno script eseguito una sola volta che aggiunge automaticamente un determinato numero di passi a partire da un passo specifico. Il codice seed della sfida per tutti i passi creati sarà vuoto.
Nota: Questo script esegue anche reorder-steps.
Come eseguire lo script:
- Vai alla directory del progetto.
- Esegui il seguente comando npm:
npm run create-empty-steps start=X num=Y # dove X è il numero del passo da cui iniziare e Y è il numero di passi da creare.
create-step-between
Uno script eseguito una sola volta che aggiunge automaticamente un passo in mezzo a due passi consecutivi già esistenti. Il codice seed della sfida userà il codice seed della sfida al passo di partenza già esistente, rimuovendo i marcatori delle regioni editabili (MRE).
Nota: Questo script esegue anche reorder-steps.
Come eseguire lo script:
- Vai alla directory del progetto.
- Esegui il seguente comando npm:
npm run create-step-between start=X # dove X è il passo iniziale di partenza
delete-step
Uno script eseguito una sola volta che cancella un passo esistente e poi riordina i passi rimanenti nella cartella del progetto e che aggiorna l'array della proprietà challengeOrder nel meta.json del progetto secondo il nuovo ordine dei passi.
Come eseguire lo script
- Vai alla directory del progetto.
- Esegui il seguente comando npm:
npm run delete-step num=x # dove x è il numero dello step da eliminare.
reorder-steps
Uno script eseguito una sola volta che riordina automaticamente i file dei passi nel markdown del progetto basandosi sui nomi dei file. Aggiorna anche l'array della proprietà challengeOrder nel meta.json del progetto secondo il nuovo ordine dei passi.
Esempi di funzionamento
Diciamo che inizi con la seguente struttura:
step-001.md
step-002.md
step-003.md
step-004.md
step-005.md
step-006.md
At some point you decide you need to delete step-002.md, because that step is no longer needed. Also, you decide to break down step-004.md into three steps instead of just one.
To accomplish this restructure, you would need to delete step-002.md and then add a step-004a.md and a step-004b.md. La nuova struttura della cartella assomiglierà alla seguente:
step-001.md
step-003.md
step-004.md
step-004a.md
step-004b.md
step-005.md
step-006.md
You now need the file names to be step-001.md through step-007.md, because you removed one but gained two more for a net difference of one file. Inoltre, la presentazione di ogni file sotto un passo rimosso o aggiunto dovrà essere modificata rendendo il valore della chiave title uguale al nuovo numero del passo. For example, after renaming step-3.md to step-2.md, you would need to change step-2.md's title from Step 03 to Step 02.
Vedi qui sotto per gli effettivi cambiamenti necessari alla cartella del progetto:
step-001.md
step-003.md renamed to step-002.md and title changes to "Step 2"
step-004.md renames to step-003.md and title changes to "Step 3"
step-004a.md renames to step-004.md and title changes to "Step 4"
step-004b.md renames to step-005.md and title changes to "Step 5"
step-005.md renames to step-006.md and title changes to "Step 6"
step-006.md renames to step-007.md and title changes to "Step 7"
Insieme ai cambi qui sopra, la chiave challengeOrder nel file meta.json del progetto deve riflettere il nuovo ordine dei passi. Questo è necessario perché ogni passo sotto la cancellazione e/o l'aggiunta di un passo cambia il title associato ad ognuno degli id delle sfide ai passi interessati.
Come eseguire lo script
- Vai alla directory del progetto.
- Esegui il seguente comando npm:
npm run reorder-steps