Merge pull request #4 from merico-dev/code-style-improvement

Code style improvement

Author: IronCore864

.github/workflows/golangci-lint.yml

@@ -0,0 +1,23 @@
+name: golangci-lint
+
+on:
+  push:
+    tags:
+      - v*
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v2
+        with:
+          version: latest

CONTRIBUTING.md

@@ -20,6 +20,43 @@ We aim to reply to issues within 24 hours.
 
 ## Style Guides
 
+### Linters
+
+We use `golangci-lint` ([official website](https://golangci-lint.run/), [GitHub](https://github.com/golangci/golangci-lint)) for linting, which is a Go linters aggregator. It's also integrated with the GitHub Actions workflows.
+
+- The list of linters enabled by default is documented [here](https://golangci-lint.run/usage/linters/).
+- It can be [integrated with IDE](https://golangci-lint.run/usage/integrations/)
+- You can [run it locally](https://golangci-lint.run/usage/quick-start/).
+
+Besides, we also use the [Go Report Card](https://goreportcard.com/report/github.com/merico-dev/stream). There is a badge like [![Go Report Card](https://goreportcard.com/badge/github.com/merico-dev/stream)](https://goreportcard.com/report/github.com/merico-dev/stream) in the main README.md.
+
 ### Git Commit Message
 
 We try our best to follow the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) guidelines.
+
+TL;DR: The commit message should be structured as follows:
+
+```
+<type>[optional scope]: <description>
+[optional body]
+[optional footer(s)]
+```
+
+where "type" can be:
+- `feat`: implements a feature
+- `fix`: patches a bug
+- `BREAKING CHANGE`: a breaking change. Or append `!` at the end of "feat" or "fix", like `feat!` and `fix!`
+- other types are allowed, for example: `build`, `chore`, `ci`, `docs`, `style`, `refactor`, `perf`, `test`
+
+Both "body" and "footer" are optional; BREAKING CHANGE can be addressed both in the title as well as in the footer. Some examples:
+
+- `feat: send an email to the customer when a product is shipped`
+- `feat!: send an email to the customer when a product is shipped`
+- `feat(api): send an email to the customer when a product is shipped`
+- `feat(api)!: send an email to the customer when a product is shipped`
+- `BREAKING CHANGE: send an email to the customer when a product is shipped`
+- ```
+  feat!: send an email to the customer when a product is shipped
+  A detailed description in the body.
+  BREAKING CHANGE: readdressing the breaking change in the footer.
+  ```

cmd/argocd/main.go

@@ -16,22 +16,22 @@ type Plugin string
 // Install implements the installation of ArgoCD.
 func (p Plugin) Install(options *map[string]interface{}) {
 	argocd.Install(options)
-	log.Println("argocd install finished")
+	log.Printf("%s install finished", NAME)
 }
 
 // Reinstall implements the reinstallation of ArgoCD.
 func (p Plugin) Reinstall(options *map[string]interface{}) {
-	log.Println("mock: argocd reinstall finished")
+	log.Printf("mock: %s reinstall finished", NAME)
 }
 
 // Uninstall implements the uninstallation of ArgoCD.
 func (p Plugin) Uninstall(options *map[string]interface{}) {
-	log.Println("mock: argocd uninstall finished")
+	log.Printf("mock: %s uninstall finished", NAME)
 }
 
 // DevStreamPlugin is the exported variable used by the DevStream core.
 var DevStreamPlugin Plugin
 
 func main() {
-	fmt.Println("This is a plugin for DevStream. Use it with DevStream.")
+	fmt.Printf("%T: %s is a plugin for DevStream. Use it with DevStream.\n", NAME, DevStreamPlugin)
 }

cmd/argocdapp/main.go

@@ -16,22 +16,22 @@ type Plugin string
 // Install implements the installation of an ArgoCD app.
 func (p Plugin) Install(options *map[string]interface{}) {
 	argocdapp.Install(options)
-	log.Println("argocdapps install finished")
+	log.Printf("%s install finished", NAME)
 }
 
 // Reinstall implements the installation of an ArgoCD app.
 func (p Plugin) Reinstall(options *map[string]interface{}) {
-	log.Println("mock: argocdapps reinstall finished")
+	log.Printf("mock: %s reinstall finished", NAME)
 }
 
 // Uninstall Uninstall the installation of an ArgoCD app.
 func (p Plugin) Uninstall(options *map[string]interface{}) {
-	log.Println("mock: argocdapps uninstall finished")
+	log.Printf("mock: %s uninstall finished", NAME)
 }
 
 // DevStreamPlugin is the exported variable used by the DevStream core.
 var DevStreamPlugin Plugin
 
 func main() {
-	fmt.Println("This is a plugin for DevStream. Use it with DevStream.")
+	fmt.Printf("%T: %s is a plugin for DevStream. Use it with DevStream.\n", NAME, DevStreamPlugin)
 }

cmd/devstream/main.go

@@ -1,6 +1,8 @@
 package main
 
 import (
+	"log"
+
 	"github.com/spf13/cobra"
 )
 
@@ -14,11 +16,6 @@ var (
 	}
 )
 
-// Execute runs the rootCMD's Execute func.
-func Execute() error {
-	return rootCMD.Execute()
-}
-
 func init() {
 	rootCMD.PersistentFlags().StringVarP(&configFile, "config-file", "f", "config.yaml", "config file")
 
@@ -27,5 +24,8 @@ func init() {
 }
 
 func main() {
-	rootCMD.Execute()
+	err := rootCMD.Execute()
+	if err != nil {
+		log.Fatal(err)
+	}
 }

cmd/githubactions/main.go

@@ -16,22 +16,22 @@ type Plugin string
 // Install implements the installation of some GitHub Actions workflows.
 func (p Plugin) Install(options *map[string]interface{}) {
 	githubactions.Install(options)
-	log.Println("github actions install finished")
+	log.Printf("%s install finished", NAME)
 }
 
 // Reinstall implements the installation of some GitHub Actions workflows.
 func (p Plugin) Reinstall(options *map[string]interface{}) {
-	log.Println("mock: github actions reinstall finished")
+	log.Printf("mock: %s reinstall finished", NAME)
 }
 
 // Uninstall implements the installation of some GitHub Actions workflows.
 func (p Plugin) Uninstall(options *map[string]interface{}) {
-	log.Println("mock: github actions uninstall finished")
+	log.Printf("mock: %s uninstall finished", NAME)
 }
 
 // DevStreamPlugin is the exported variable used by the DevStream core.
 var DevStreamPlugin Plugin
 
 func main() {
-	fmt.Println("This is a plugin for DevStream. Use it with DevStream.")
+	fmt.Printf("%T: %s is a plugin for DevStream. Use it with DevStream.\n", NAME, DevStreamPlugin)
 }

internal/pkg/githubactions/githubactions.go

@@ -15,12 +15,16 @@ func generateGitHubWorkflowFileByName(f string) string {
 }
 
 func getGitHubToken() string {
-	viper.BindEnv("github_token")
-	token, ok := viper.Get("github_token").(string)
+	err := viper.BindEnv("github_token")
+	if err != nil {
+		log.Fatalf("ENV var GITHUB_TOKEN is needed")
+	}
 
+	token, ok := viper.Get("github_token").(string)
 	if !ok {
 		log.Fatalf("ENV var GITHUB_TOKEN is needed")
 	}
+
 	return token
 }