Add pre-commit config and include goimports (gruntwork-io#52)

andyfeller · Sep 23, 2021 · 19e1e86 · 19e1e86
1 parent 7b8ec9c
commit 19e1e86
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 8 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -23,6 +23,17 @@ install_gruntwork_utils: &install_gruntwork_utils
     --go-version ${GOLANG_VERSION} 
 version: 2
 jobs:
+  pre-commit:
+    <<: *defaults
+    steps:
+      - checkout
+      - run:
+          command: |
+            pip install pre-commit
+            go get golang.org/x/tools/cmd/goimports
+            export GOPATH=~/go/bin && export PATH=$PATH:$GOPATH
+            pre-commit install
+            pre-commit run --all-files
   test:
     <<: *defaults
     steps:
@@ -50,7 +61,15 @@ workflows:
   version: 2
   build-and-test:
     jobs:
+      - pre-commit:
+          filters:
+            tags:
+              only: /^v.*/
+          context:
+            - Gruntwork Admin
       - test:
+          requires:
+            - pre-commit
           filters:
             tags:
               only: /^v.*/

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,5 @@
+repos:
+  - repo: https://github.com/gruntwork-io/pre-commit
+    rev: v0.1.13
+    hooks:
+      - id: goimports
diff --git a/config/config.go b/config/config.go
@@ -15,7 +15,7 @@ type GitXargsConfig struct {
 	DryRun                 bool
 	SkipPullRequests       bool
 	SkipArchivedRepos      bool
-	MaxConcurrentRepos	   int
+	MaxConcurrentRepos     int
 	BranchName             string
 	CommitMessage          string
 	PullRequestTitle       string

diff --git a/mocks/mocks.go b/mocks/mocks.go
@@ -47,10 +47,10 @@ var MockGithubRepositories = []*github.Repository{
 	},
 	&github.Repository{
 		Owner: &github.User{
-		Login: &ownerName,
+			Login: &ownerName,
 		},
-		Name:    &repoName4,
-		HTMLURL: &repoURL4,
+		Name:     &repoName4,
+		HTMLURL:  &repoURL4,
 		Archived: &archivedFlag,
 	},
 }

diff --git a/repository/fetch-repos_test.go b/repository/fetch-repos_test.go
@@ -63,6 +63,6 @@ func TestSkipArchivedRepos(t *testing.T) {
 
 	githubRepos, reposByOrgLookupErr := getReposByOrg(config)
 
-	assert.Equal(t, len(githubRepos), len(mocks.MockGithubRepositories) -1)
+	assert.Equal(t, len(githubRepos), len(mocks.MockGithubRepositories)-1)
 	assert.NoError(t, reposByOrgLookupErr)
 }
diff --git a/repository/process.go b/repository/process.go
@@ -48,7 +48,7 @@ func ProcessRepos(gitxargsConfig *config.GitXargsConfig, repos []*github.Reposit
 // run report that is displayed in table format to the operator following each run
 func processRepo(config *config.GitXargsConfig, repo *github.Repository) error {
 	logger := logging.GetLogger("git-xargs")
-	
+
 	// Create a new temporary directory in the default temp directory of the system, but append
 	// git-xargs-<repo-name> to it so that it's easier to find when you're looking for it
 	repositoryDir, localRepository, cloneErr := cloneLocalRepository(config, repo)

diff --git a/repository/repo-operations.go b/repository/repo-operations.go
@@ -53,7 +53,7 @@ func cloneLocalRepository(config *config.GitXargsConfig, repo *github.Repository
 	})
 
 	logger.WithFields(logrus.Fields{
-		"Repo":  repo.GetName(),
+		"Repo": repo.GetName(),
 	}).Debug(gitProgressBuffer)
 
 	if err != nil {
@@ -196,7 +196,7 @@ func checkoutLocalBranch(config *config.GitXargsConfig, ref *plumbing.Reference,
 	}
 
 	logger.WithFields(logrus.Fields{
-		"Repo":  remoteRepository.GetName(),
+		"Repo": remoteRepository.GetName(),
 	}).Debug(gitProgressBuffer)
 
 	pullErr := worktree.Pull(po)