Progress on #14

Makefile

@@ -45,3 +45,9 @@ install: all
 
 build-docker:
 	docker build -t freetonik/underblog .
+
+fmt:
+	go fmt ./app/...
+
+lint: 
+	golint ./app/... && go vet ./app/...

app/cmd/blog.go

@@ -2,7 +2,6 @@ package cmd
 
 import (
 	"context"
-	"errors"
 	"fmt"
 	"html/template"
 	"io"
@@ -17,9 +16,10 @@ import (
 	"github.com/freetonik/underblog/app/internal"
 )
 
+// DefaultMarkdownPath The folder where the markdown posts are stored
 const DefaultMarkdownPath = "./markdown/"
 
-// Create and initialize Blog
+// NewBlog Create and initialize Blog
 func NewBlog(opts internal.Opts) *Blog {
 	b := new(Blog)
 
@@ -49,13 +49,13 @@ type Blog struct {
 // Render md-files->HTML, generate root index.html
 func (b *Blog) Render() error {
 	if err := b.verifyMarkdownPresent(); err != nil {
-		log.Fatal(errors.New(fmt.Sprintf("Markdown directory is not found: %v", err)))
+		log.Fatal(fmt.Errorf("Markdown directory is not found: %v", err))
 	}
 
 	b.indexPage = b.getIndexPage(b.opts.Path)
 	b.createPosts()
 	err := b.renderMd()
-	b.copyCssToPublicDir()
+	b.copyCSSToPublicDir()
 
 	return err
 }
@@ -75,13 +75,13 @@ func (b *Blog) getIndexPage(currentPath string) io.Writer {
 	p := filepath.Join(rootPath, "public")
 	err := os.MkdirAll(p, os.ModePerm)
 	if err != nil {
-		log.Fatal(errors.New(fmt.Sprintf("Can't create public dir: %v", err)))
+		log.Fatal(fmt.Errorf("Can't create public dir: %v", err))
 	}
 
 	f, err := os.Create("public/index.html")
 
 	if err != nil {
-		log.Fatal(errors.New(fmt.Sprintf("Can't create public/index.html: %v", err)))
+		log.Fatal(fmt.Errorf("Can't create public/index.html: %v", err))
 	}
 
 	return f
@@ -134,7 +134,7 @@ func (b *Blog) createPosts() {
 	close(filesChan)
 }
 
-func (b *Blog) copyCssToPublicDir() {
+func (b *Blog) copyCSSToPublicDir() {
 	from, err := os.Open("./css/styles.css")
 	if err != nil {
 		log.Fatal(err)
@@ -184,6 +184,7 @@ func (b *Blog) getTemplateFuncs() template.FuncMap {
 	}
 }
 
+// SortPosts Sort posts
 func (b *Blog) SortPosts() {
 	sort.Slice(b.Posts, func(i, j int) bool {
 		return b.Posts[i].Date.Unix() > b.Posts[j].Date.Unix()

app/cmd/post.go

@@ -15,6 +15,7 @@ import (
 	"gopkg.in/russross/blackfriday.v2"
 )
 
+// NewPost Converts a Markdown post to HTML
 func NewPost(filename string) Post {
 	post, err := ExtractMetaFromFilename(filename)
 	if err != nil {
@@ -43,6 +44,7 @@ func NewPost(filename string) Post {
 	return post
 }
 
+// Post Represents a post
 type Post struct {
 	Title string
 	Body  template.HTML
@@ -78,6 +80,7 @@ func fNameWithoutExtension(fn string) string {
 	return strings.TrimSuffix(fn, path.Ext(fn))
 }
 
+// ExtractMetaFromFilename Extracts slug and date from filename
 func ExtractMetaFromFilename(filename string) (Post, error) {
 	errorMessage := fmt.Sprintf("can't parse filename '%s', it should be in format 'YYYY-MM-DD-slug.md'", filename)
 	dateFormat := "2006-01-02"

app/internal/cli.go

@@ -4,6 +4,7 @@ import (
 	"flag"
 )
 
+// Opts options of the command line
 type Opts struct {
 	Version   bool
 	WatchMode bool

app/internal/watch_mode.go

@@ -8,6 +8,7 @@ import (
 	"time"
 )
 
+// WatchForChangedFiles Rebuild the blog when files are changed
 func WatchForChangedFiles(rebuildBlog func()) {
 	w := watcher.New()
 
@@ -44,6 +45,7 @@ func WatchForChangedFiles(rebuildBlog func()) {
 	}
 }
 
+// RunDevelopmentWebserver Run the development server
 func RunDevelopmentWebserver() {
 	// todo: extract ./public to constant
 	http.Handle("/", http.FileServer(http.Dir("./public")))