feat(cli): improve CLI options naming to make them consistent

Author: pierrelalanne

README.md

@@ -77,20 +77,20 @@ repositories. You can override this limit with the option `--limit`, a limit of
 
 ### Default behavior
 
-Note that by default **for github provider**, `src-fingerprint` will exclude private repositories, forks and archived repositories from the fingerprints computation. Use options `-e` or `--all` to change this behavior.
+Note that by default, `src-fingerprint` will exclude forked repositories from the fingerprints computation. **For GitHub provider** archived repositories and public repositories will also be excluded by default. Use flags `--include-forked-repos`, `--include-archived-repos` or `include-public-repos` to change this behavior.
 
 ### GitHub
 
 1. Export all fingerprints from private repositories from a GitHub Org to the default path `./fingerprints.jsonl.gz` with logs:
 
 ```sh
-env VCS_TOKEN="<token>" src-fingerprint -v --provider github --object ORG_NAME --all
+env VCS_TOKEN="<token>" src-fingerprint -v --provider github --object ORG_NAME
 ```
 
 2. Export all fingerprints of every repository the user can access to the default path `./fingerprints.jsonl.gz`:
 
 ```sh
-env VCS_TOKEN="<token>" src-fingerprint -v --provider github --all
+env VCS_TOKEN="<token>" src-fingerprint -v --provider github --include-public-repos --include-forked-repos --include-archived-repos
 ```
 
 ### GitLab
@@ -103,10 +103,8 @@ env VCS_TOKEN="<token>" src-fingerprint -v --provider gitlab --object "GitGuardi
 
 2. Export all fingerprints of every project the user can access to the default path `./fingerprints.jsonl.gz` with logs:
 
-> :warning: On `gitlab.com` this will attempt to retrieve all repositories on `gitlab.com`
-
 ```sh
-env VCS_TOKEN="<token>" src-fingerprint -v --provider gitlab
+env VCS_TOKEN="<token>" src-fingerprint -v --provider gitlab --include-forked-repos
 ```
 
 ### Bitbucket server (formely Atlassian Stash)

cmd/src-fingerprint/main.go

@@ -99,13 +99,17 @@ func main() {
 				Usage:   "verbose logging",
 			},
 			&cli.BoolFlag{
-				Name:    "extract-forks",
-				Aliases: []string{"e"},
-				Value:   false,
-				Usage:   "extract fork repositories when possible",
+				Name:  "include-forked-repos",
+				Value: false,
+				Usage: "include forked repositories when possible",
+			},
+			&cli.BoolFlag{
+				Name:  "include-public-repos",
+				Value: false,
+				Usage: "Include fileshas from both public and private repositories if the provider is 'github'",
 			},
 			&cli.BoolFlag{
-				Name:  "skip-archived",
+				Name:  "include-archived-repos",
 				Value: false,
 				Usage: "skip archived repositories",
 			},
@@ -137,11 +141,6 @@ func main() {
 				Required: true,
 				Usage:    "vcs provider. options: 'gitlab'/'github'/'bitbucket'/'repository'",
 			},
-			&cli.BoolFlag{
-				Name:  "all",
-				Value: false,
-				Usage: "Collect fileshas from every accessible repository including public ones if the provider is 'github'",
-			},
 			&cli.StringFlag{
 				Name:  "repo-name",
 				Usage: "Name of the repository to display in outputs if the provider is 'repository'",
@@ -218,10 +217,10 @@ func mainAction(c *cli.Context) error {
 	var srcCloner cloner.Cloner = cloner.NewDiskCloner(c.String("clone-dir"))
 
 	providerOptions := provider.Options{
-		OmitForks:            !c.Bool("extract-forks"),
-		SkipArchived:         c.Bool("skip-archived"),
+		IncludeForkedRepos:   c.Bool("include-forked-repos"),
+		IncludeArchivedRepos: c.Bool("include-archived-repos"),
+		IncludePublicRepos:   c.Bool("include-public-repos"),
 		BaseURL:              c.String("provider-url"),
-		AllRepositories:      c.Bool("all"),
 		RepositoryName:       c.String("repo-name"),
 		RespositoryIsPrivate: c.Bool("repo-is-private"),
 	}

provider/github.go

@@ -81,7 +81,7 @@ func (p *GitHubProvider) gatherPage(user string, page int) ([]GitRepository, err
 		visibility string
 	)
 
-	if p.options.AllRepositories {
+	if p.options.IncludePublicRepos {
 		visibility = "all"
 	} else {
 		visibility = "private"
@@ -123,11 +123,11 @@ func (p *GitHubProvider) gatherPage(user string, page int) ([]GitRepository, err
 	repositories := make([]GitRepository, 0, len(repos))
 
 	for _, repo := range repos {
-		if p.options.OmitForks && repo.GetFork() {
+		if !p.options.IncludeForkedRepos && repo.GetFork() {
 			continue
 		}
 
-		if p.options.SkipArchived && repo.Archived != nil && *repo.Archived {
+		if !p.options.IncludeArchivedRepos && repo.Archived != nil && *repo.Archived {
 			continue
 		}
 

provider/gitlab.go

@@ -82,7 +82,7 @@ func (p *GitLabProvider) gatherAccessiblePage(page int, verbose bool) ([]GitRepo
 	repositories := make([]GitRepository, 0, len(repos))
 
 	for _, repo := range repos {
-		if p.options.OmitForks && repo.ForkedFromProject != nil {
+		if !p.options.IncludeForkedRepos && repo.ForkedFromProject != nil {
 			continue
 		}
 
@@ -112,7 +112,7 @@ func (p *GitLabProvider) gatherGroupProjectPage(groupID, page int, verbose bool)
 	repositories := make([]GitRepository, 0, len(repos))
 
 	for _, repo := range repos {
-		if p.options.OmitForks && repo.ForkedFromProject != nil {
+		if !p.options.IncludeForkedRepos && repo.ForkedFromProject != nil {
 			continue
 		}
 

provider/provider.go

@@ -38,15 +38,17 @@ type Provider interface {
 
 // Options represents options for the Provider.
 type Options struct {
-	// OmitForks will tell the Provider to omit fork repositories
-	OmitForks bool
-	// SkipArchived will skip archived repositories
-	SkipArchived bool
+	// IncludeForkedRepos will include fork repositories in fingerprints computation
+	// This is available for GitLab and GitHub providers only.
+	IncludeForkedRepos bool
+	// IncludeArchivedRepos will include archived repositories in fingerprints computation
+	// This is only available for GitHub provider only.
+	IncludeArchivedRepos bool
+	// IncludePublicRepos will include public repositories in fingerprints computation
+	// This is only available for GitHub provider only.
+	IncludePublicRepos bool
 	// Repository private status to display in the output if the provider is 'repository'
 	RespositoryIsPrivate bool
-	// AllRepositories collects fileshas from every accessible repository
-	// including public ones. This is only used by "github" provider
-	AllRepositories bool
 	// BaseURL is the base URL of the API
 	BaseURL string
 	// Repository name to display in the output if the provider is 'repository'