Merge branch 'refactor/go-naming-good-practices' into main

apiclient/apiclient.go

@@ -0,0 +1,2 @@
+// Package apiclient provides the API client used by the web app
+package apiclient

apihandler/apihandler.go

@@ -0,0 +1,2 @@
+// Package apihandler provides handlers for API routes
+package apihandler

apiresponse/apiresponse.go

@@ -0,0 +1,2 @@
+// Package apiresponse provides response types for API routes
+package apiresponse

cmd/api.go

@@ -18,7 +18,7 @@ var apiCmd = &cobra.Command{
 	Use:   "api",
 	Short: "Start the API server",
 	Run: func(cmd *cobra.Command, args []string) {
-		cfg, err := config.GetConfig()
+		cfg, err := config.UnmarshalConfig()
 		if err != nil {
 			log.Fatal(err)
 		}

cmd/root.go

@@ -1,6 +1,4 @@
-/*
-Copyright © 2023 AGECEM & Victor Lacasse-Beaudoin
-*/
+// Package cmd provides the cobra command and subcommands for the application
 package cmd
 
 import (

cmd/web.go

@@ -18,7 +18,7 @@ var webCmd = &cobra.Command{
 	Use:   "web",
 	Short: "Start the webserver",
 	Run: func(cmd *cobra.Command, args []string) {
-		cfg, err := config.GetConfig()
+		cfg, err := config.UnmarshalConfig()
 		if err != nil {
 			log.Fatal(err)
 		}

config/config.go

@@ -1,3 +1,7 @@
+/*
+Package config provides types and methods for managing this application's
+config options and flags
+*/
 package config
 
 import (
@@ -18,7 +22,7 @@ type WebConfig struct {
 	Port int
 }
 
-func GetConfig() (cfg Config, err error) {
+func UnmarshalConfig() (cfg Config, err error) {
 	return cfg, viper.Unmarshal(&cfg)
 }
 

dbclient/dbclient.go

@@ -0,0 +1,2 @@
+// Package dbclient provides the database client used by the API server
+package dbclient

main.go

@@ -1,6 +1,7 @@
 /*
 Copyright © 2023 AGECEM & Victor Lacasse-Beaudoin
 
+Application de registre de présences en Assemblée Générale de l'AGECEM
 */
 package main
 

webcontent/webcontent.go

@@ -0,0 +1,5 @@
+/*
+Package webcontent provides the content to be embedded in the binary executable
+for the web app
+*/
+package webcontent

webhandler/webhandler.go

@@ -0,0 +1,2 @@
+// Package webhandler provides handlers for the web app routes
+package webhandler