feat(exporter): add support for jsonl

Author: jguerreiro

.pre-commit-config.yaml

@@ -1,25 +1,25 @@
 default_stages: [commit]
 repos:
   - repo: git://github.com/dnephin/pre-commit-golang
-    rev: v0.3.5
+    rev: v0.4.0
     hooks:
       - id: go-fmt
       - id: go-imports
       - id: golangci-lint
   - repo: https://github.com/Woile/commitizen
-    rev: v2.17.4
+    rev: v2.17.6
     hooks:
       - id: commitizen
         # don't forget to run pre-commit install --hook-type commit-msg for this hook to run
         stages: [commit-msg]
 
   - repo: https://github.com/pre-commit/mirrors-prettier # to format JSON, YAML and markdown files among others
-    rev: v2.2.1
+    rev: v2.3.0
     hooks:
       - id: prettier
 
   - repo: https://github.com/gitguardian/gg-shield
-    rev: v1.4.0
+    rev: v1.5.0
     hooks:
       - id: ggshield
         language_version: python3

exporter/output.go

@@ -0,0 +1,58 @@
+package exporter
+
+import (
+	"encoding/json"
+	"io"
+	"srcfingerprint"
+)
+
+type ExportGitFile struct {
+	RepositoryName    string `json:"repository_name"` // nolint
+	RepositoryPrivate bool   `json:"private"`
+	srcfingerprint.GitFile
+}
+
+type Exporter interface {
+	AddElement(gitFile *ExportGitFile) error
+	Close() error
+}
+
+type JSONExporter struct {
+	elements []*ExportGitFile
+	encoder  *json.Encoder
+}
+
+func NewJSONExporter(output io.Writer) Exporter {
+	return &JSONExporter{
+		elements: []*ExportGitFile{},
+		encoder:  json.NewEncoder(output),
+	}
+}
+
+func (e *JSONExporter) AddElement(gitFile *ExportGitFile) error {
+	e.elements = append(e.elements, gitFile)
+
+	return nil
+}
+
+func (e *JSONExporter) Close() error {
+	return e.encoder.Encode(e.elements)
+}
+
+type JSONLExporter struct {
+	encoder *json.Encoder
+}
+
+func NewJSONLExporter(output io.Writer) Exporter {
+	return &JSONLExporter{
+		encoder: json.NewEncoder(output),
+	}
+}
+
+func (e *JSONLExporter) AddElement(gitFile *ExportGitFile) error {
+	return e.encoder.Encode(gitFile)
+}
+
+func (e *JSONLExporter) Close() error {
+	return nil
+}

provider/bitbucket.go

@@ -14,7 +14,7 @@ import (
 	"github.com/suhaibmujahid/go-bitbucket-server/bitbucket"
 )
 
-// Provider is capable of gathering Bitbucket server repositories from an org.
+// BitbucketProvider is capable of gathering Bitbucket server repositories from an org.
 type BitbucketProvider struct {
 	client    *bitbucket.Client
 	transport *AuthHeaderTransport
@@ -86,7 +86,7 @@ func NewAuthHeaderTransport(T http.RoundTripper, token string) *AuthHeaderTransp
 	}
 }
 
-// NewProvider creates a new Github Provider.
+// NewBitbucketProvider creates a new Bitbucket provider.
 func NewBitbucketProvider(token string, options Options) Provider {
 	// BaseURL should be like http://localhost:7990/rest/api/1.0/
 	if options.BaseURL == "" {

provider/generic_repository.go

@@ -6,7 +6,7 @@ import (
 	"time"
 )
 
-// Generic Repository Structure.
+// Repository Structure. Generic.
 type Repository struct {
 	name        string
 	sshURL      string

provider/github.go

@@ -18,7 +18,7 @@ const (
 	DefaultGithubAPIURL = "https://api.github.com/"
 )
 
-// Provider is capable of gathering Github repositories from an org.
+// GitHubProvider is capable of gathering Github repositories from an org.
 type GitHubProvider struct {
 	client  *github.Client
 	options Options
@@ -36,7 +36,7 @@ func createFromGithubRepo(r *github.Repository) *Repository {
 	}
 }
 
-// NewProvider creates a new Github Provider.
+// NewGitHubProvider creates a new Github Provider.
 func NewGitHubProvider(token string, options Options) Provider {
 	client := github.NewClient(oauth2.NewClient(
 		context.TODO(),

provider/gitlab.go

@@ -12,21 +12,21 @@ import (
 )
 
 const (
-	// DefaultGithubAPIURL is the default API URL.
+	// DefaultGitLabAPIURL is the default API URL.
 	DefaultGitLabAPIURL = "https://gitlab.com/api/v4"
 )
 
 // ErrGroupNotFound is the error returned when group can not be found.
 var ErrGroupNotFound = errors.New("group not found")
 
-// Provider represents a Gitlab Provider. It can gather the list of repositories a given user.
+// GitLabProvider represents a Gitlab Provider. It can gather the list of repositories a given user.
 type GitLabProvider struct {
 	token   string
 	client  *gitlab.Client
 	options Options
 }
 
-// NewProvider  creates a Provider given a token.
+// NewGitLabProvider creates a Provider given a token.
 // If accessing private repositories, token must not be empty.
 func NewGitLabProvider(token string, options Options) Provider {
 	GitLabBaseURL := DefaultGitLabAPIURL