nilbuild/makers.ae

Add command to validate if all the members have valid data

Offen

#5 geöffnet am 02.11.2020

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (9 Forks)github user discovery
good first issue

Repository-Metriken

Stars
 (39 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Implementieren Sie den Befehl validate members in cmd/validate members.cmd.ts. Lesen Sie das members Verzeichnis, überprüfen Sie jedes Unterverzeichnis auf profile.json und bio.md, validieren Sie JSON, überprüfen Sie, ob der Verzeichnisname mit dem username übereinstimmt, prüfen Sie, ob imageUrl in public/avatars existiert, und stellen Sie sicher, dass alle erforderlichen Felder vorhanden sind. Protokollieren Sie Fehler und beenden Sie das Programm bei Fehlern mit einem Exit Code ungleich Null.
Tech Stack
typescriptnodejs
Domain
clitooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
TypeScriptNode.jsYarn
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75