nilbuild/makers.ae

Add command to validate if all the members have valid data

Open

#5 opened on Nov 2, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (9 forks)github user discovery
good first issue

Repository metrics

Stars
 (39 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

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 direction
Implement the validate members command in cmd/validate members.cmd.ts. Read the members directory, check each subdirectory for profile.json and bio.md, validate JSON, check directory name matches username, verify imageUrl exists in public/avatars, and ensure all required fields are present. Log errors and exit with non zero code on failure.
Tech stack
typescriptnodejs
Domain
clitooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptNode.jsYarn
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75