Updated comments, comment format.

Author: bnkamalesh

.gitignore

@@ -1 +1,87 @@
-.DS_Store
+# Created by https://www.gitignore.io/api/go,osx,linux,windows
+
+### Go ###
+# Binaries for programs and plugins
+*.exe
+*.dll
+*.so
+*.dylib
+
+# Test binary, build with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736
+.glide/
+
+# Golang project vendor packages which should be ignored
+vendor/
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### OSX ###
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.gitignore.io/api/go,osx,linux,windows
+
+.vscode

config.go

@@ -7,25 +7,25 @@ import (
 	"strconv"
 )
 
-// Config struct for reading app's configuration from json file
+// Config is used for reading app's configuration from json file
 type Config struct {
-	//Env is the deployment environment
+	// Env is the deployment environment
 	Env string `json:"environment"`
-	//Host is the host on which the server is listening
+	// Host is the host on which the server is listening
 	Host string `json:"host,omitempty"`
-	//Port is the port number where the server has to listen for the HTTP requests
+	// Port is the port number where the server has to listen for the HTTP requests
 	Port string `json:"port"`
 
-	//CertFile is the TLS/SSL certificate file path, required for HTTPS
+	// CertFile is the TLS/SSL certificate file path, required for HTTPS
 	CertFile string `json:"certFile,omitempty"`
-	//KeyFile is the filepath of private key of the certificate
+	// KeyFile is the filepath of private key of the certificate
 	KeyFile string `json:"keyFile,omitempty"`
-	//HTTPSPort is the port number where the server has to listen for the HTTP requests
+	// HTTPSPort is the port number where the server has to listen for the HTTP requests
 	HTTPSPort string `json:"httpsPort,omitempty"`
-	//HTTPSOnly if true will enable HTTPS server alone
+	// HTTPSOnly if true will enable HTTPS server alone
 	HTTPSOnly bool `json:"httpsOnly,omitempty"`
 
-	//TemplatesBasePath is the base path where all the HTML templates are located
+	// TemplatesBasePath is the base path where all the HTML templates are located
 	TemplatesBasePath string `json:"templatePath,omitempty"`
 
 	// Data holds the full json config file data as bytes
@@ -61,7 +61,7 @@ func (cfg *Config) Validate() {
 	}
 }
 
-//Globals struct to hold configurations which are shared with all the request handlers via context.
+// Globals struct to hold configurations which are shared with all the request handlers via context.
 type Globals struct {
 
 	// All the app configurations
@@ -80,7 +80,7 @@ func (g *Globals) Add(key string, data interface{}) {
 	g.App[key] = data
 }
 
-//Init initializes the Context and set appropriate values
+// Init initializes the Context and set appropriate values
 func (g *Globals) Init(cfg *Config, tpls map[string]*htpl.Template) {
 	g.App = make(map[string]interface{})
 	g.Templates = make(map[string]*htpl.Template)

errors.go

@@ -6,19 +6,19 @@ import (
 )
 
 const (
-	//C001 Error Code 1
+	// C001 Error Code 1
 	C001 = "Invalid number of arguments provided"
-	//C002 Error Code 2
+	// C002 Error Code 2
 	C002 = "Could not unmarshal JSON config file"
-	//C003 Error Code 3
+	// C003 Error Code 3
 	C003 = "App environment not provided in config file, accepted values are `production` or `development`"
-	//C004 Error Code 4
+	// C004 Error Code 4
 	C004 = "App port not provided in config file"
-	//C005 Error Code 5
+	// C005 Error Code 5
 	C005 = "Invalid JSON"
 )
 
-//Errors struct is the custom error for webgo error handling
+// Errors is the custom error for webgo error handling
 type Errors struct {
 	msg string
 }
@@ -27,7 +27,7 @@ func (e *Errors) Error() string {
 	return e.msg
 }
 
-//New returns a new instance of Errors struct
+// New returns a new instance of Errors struct
 func New(str string) *Errors {
 	return &Errors{
 		msg: str,

middlewares.go

@@ -4,7 +4,7 @@ import (
 	"net/http"
 )
 
-//Middlewares has all the default middlewares provided by webgo
+// Middlewares has all the default middlewares provided by webgo
 type Middlewares struct{}
 
 const (
@@ -18,7 +18,7 @@ const (
 	allowHeaders       = "Accept,Content-Type,Content-Length,Accept-Encoding,Access-Control-Request-Headers,"
 )
 
-//Cors is a basic Cors middleware definition.
+// Cors is a basic Cors middleware definition.
 func (m *Middlewares) Cors(rw http.ResponseWriter, req *http.Request) {
 	// Set response appropriate headers required for CORS
 	rw.Header().Set(headerOrigin, req.Header.Get(headerGetOrigin))
@@ -29,7 +29,7 @@ func (m *Middlewares) Cors(rw http.ResponseWriter, req *http.Request) {
 	rw.Header().Set(headerAllowHeaders, allowHeaders+req.Header.Get(headerReqHeaders))
 }
 
-//CorsOptions is a cors middleware just for Options request - adding this helped remove the request method check (an `if` block to check the request type) from Cors middleware
+// CorsOptions is a cors middleware just for Options request - adding this helped remove the request method check (an `if` block to check the request type) from Cors middleware
 func (m *Middlewares) CorsOptions(rw http.ResponseWriter, req *http.Request) {
 	// Set response appropriate headers required for CORS
 	rw.Header().Set(headerOrigin, req.Header.Get(headerGetOrigin))

responses.go

@@ -7,7 +7,7 @@ import (
 	"net/http"
 )
 
-//ErrorData used to render the error page
+// ErrorData used to render the error page
 type ErrorData struct {
 	ErrCode        int
 	ErrDescription string
@@ -24,24 +24,25 @@ type errOutput struct {
 }
 
 const (
-	//HeaderContentType is the key for mentioning the response header content type
+	// HeaderContentType is the key for mentioning the response header content type
 	HeaderContentType = "Content-Type"
-	//JSONContentType is the MIME type when the response is JSON
+	// JSONContentType is the MIME type when the response is JSON
 	JSONContentType = "application/json"
-	//HTMLContentType is the MIME type when the response is HTML
+	// HTMLContentType is the MIME type when the response is HTML
 	HTMLContentType = "text/html; charset=UTF-8"
 
-	//ErrInternalServer to send when there's an internal server error
+	// ErrInternalServer to send when there's an internal server error
 	ErrInternalServer = "Internal server error."
 )
 
-//SendHeader is used to send only a response header, i.e no response body
+// SendHeader is used to send only a response header, i.e no response body
 func SendHeader(w http.ResponseWriter, rCode int) {
 	w.WriteHeader(rCode)
 	fmt.Fprint(w)
 }
 
-//Send is used to send a completely custom response without wrapping in the `{data: <data>, status: <int>` struct
+// Send sends a completely custom response without wrapping in the
+// `{data: <data>, status: <int>` struct
 func Send(w http.ResponseWriter, contentType string, data interface{}, rCode int) {
 	w.Header().Set(HeaderContentType, contentType)
 	w.WriteHeader(rCode)
@@ -55,7 +56,7 @@ func Send(w http.ResponseWriter, contentType string, data interface{}, rCode int
 	}
 }
 
-//SendResponse is used to respond to any request (JSON response) based on the code, data etc.
+// SendResponse is used to respond to any request (JSON response) based on the code, data etc.
 func SendResponse(w http.ResponseWriter, data interface{}, rCode int) {
 	w.Header().Set(HeaderContentType, JSONContentType)
 
@@ -76,7 +77,7 @@ func SendResponse(w http.ResponseWriter, data interface{}, rCode int) {
 	}
 }
 
-//SendError is used to respond to any request with an error
+// SendError is used to respond to any request with an error
 func SendError(w http.ResponseWriter, data interface{}, rCode int) {
 	w.Header().Set(HeaderContentType, JSONContentType)