ljharb/repo-report

Add Repository Command Line Option to Target Specific Repositories

Open

#71 opened on Mar 3, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (17 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (25 stars)
PR merge metrics
 (PR metrics pending)

Description

Summary

Add Repository Command Line Option to Target Specific Repositories

Background

To provide additional flexibility and control, a new --repo-url {repo_url_value} command-line option (or similar name) could be implemented to only target a specific repository. This option would indicate that the user only wants to generate a report for this repository.

Tasks

  • Introduce the new repository command-line option
  • add repository URL validation logic - ensure URL is non-empty and valid
  • review and update logic to only process the specified repository

Acceptance Criteria

  • the repository command-line option is available and is shown in the help output
  • the repository command-line option value is validated; must be non-empty, must be a valid repository URL
  • the repository command-line option forces the reporting tool to only generate a report for the specified repository

Contributor guide

Research direction
Implement a new command line option ` repo url`, validate that it is a non empty valid URL, and modify the report generation logic to only process that specified repository.
Tech stack
javascript
Domain
cli
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Node.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75