nilbuild/makers.ae

Add command to validate if all the members have valid data

Aperta

#5 aperta il 2 nov 2020

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)TypeScript (9 fork)github user discovery
good first issue

Metriche repository

Star
 (39 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

We need to write a command which will be used during the build time to validate if all the members have valid data.

The command should go through the members directory, run the following validations:

  • All the directories have two files inside profile.json and bio.md
  • profile.json has valid JSON
  • Directory name matches the username inside profile.json
  • The imageUrl given in profile.json exists in the image directory.
  • All the required fields exist in the profile.json i.e. username, title, designation, company, imageUrl and joinDate

If any of the validation checks above fail, prepare the list of errors and exit with error.

I have already added the placeholder code for running the commands, we just have to write the logic inside the command.

yarn cmd members.validate

Guida contributor

Direzione di ricerca
Implementa il comando validate members in cmd/validate members.cmd.ts. Leggi la directory members, controlla ogni sottodirectory per profile.json e bio.md, valida il JSON, verifica che il nome della directory corrisponda allo username, controlla che imageUrl esista in public/avatars e assicurati che tutti i campi richiesti siano presenti. Registra gli errori ed esci con codice non zero in caso di fallimento.
Tech stack
typescriptnodejs
Dominio
clitooling
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
TypeScriptNode.jsYarn
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75