as per review

Signed-off-by: Andrew Thornton <[email protected]>

Author: zeripath

modules/options/base.go

@@ -9,10 +9,13 @@ import (
 	"io/fs"
 	"os"
 	"path/filepath"
+
+	"code.gitea.io/gitea/modules/util"
 )
 
 func walkAssetDir(root string, callback func(path, name string, d fs.DirEntry, err error) error) error {
 	if err := filepath.WalkDir(root, func(path string, d fs.DirEntry, err error) error {
+		// name is the path relative to the root
 		name := path[len(root):]
 		if len(name) > 0 && name[0] == '/' {
 			name = name[1:]
@@ -23,7 +26,7 @@ func walkAssetDir(root string, callback func(path, name string, d fs.DirEntry, e
 			}
 			return err
 		}
-		if d.Name() == ".DS_Store" && d.IsDir() { // Because Macs...
+		if d.IsDir() && util.CommonSkipDir(d.Name()) {
 			return fs.SkipDir
 		}
 		return callback(path, name, d, err)

modules/templates/base.go

@@ -111,7 +111,7 @@ func walkAssetDir(root string, skipMail bool, callback func(path, name string, d
 		if skipMail && path == mailRoot && d.IsDir() {
 			return fs.SkipDir
 		}
-		if d.Name() == ".DS_Store" && d.IsDir() { // Because Macs...
+		if d.IsDir() && util.CommonSkipDir(d.Name()) { // Because Macs...
 			return fs.SkipDir
 		}
 		if strings.HasSuffix(d.Name(), ".tmpl") || d.IsDir() {

modules/templates/htmlrenderer.go

@@ -21,7 +21,7 @@ func HTMLRenderer(ctx context.Context) (context.Context, *render.Render) {
 	rendererInterface := ctx.Value(rendererKey)
 	if rendererInterface != nil {
 		renderer, ok := rendererInterface.(*render.Render)
-		if ok && renderer != nil {
+		if ok {
 			return ctx, renderer
 		}
 	}

modules/templates/mailer.go

@@ -42,13 +42,7 @@ func Mailer(ctx context.Context) (*texttmpl.Template, *template.Template) {
 				continue
 			}
 
-			assetName := strings.TrimPrefix(
-				strings.TrimSuffix(
-					assetPath,
-					".tmpl",
-				),
-				"mail/",
-			)
+			assetName := strings.TrimPrefix(strings.TrimSuffix(assetPath, ".tmpl"), "mail/")
 
 			log.Trace("Adding built-in mailer template for %s", assetName)
 			buildSubjectBodyTemplate(subjectTemplates,

modules/util/path.go

@@ -12,7 +12,6 @@ import (
 	"path/filepath"
 	"regexp"
 	"runtime"
-	"strings"
 )
 
 // EnsureAbsolutePath ensure that a path is absolute, making it
@@ -91,7 +90,7 @@ func statDir(dirPath, recPath string, includeDir, isDirOnly, followSymlinks bool
 
 	statList := make([]string, 0)
 	for _, fi := range fis {
-		if strings.Contains(fi.Name(), ".DS_Store") {
+		if fi.IsDir() && CommonSkipDir(fi.Name()) {
 			continue
 		}
 
@@ -199,3 +198,9 @@ func HomeDir() (home string, err error) {
 
 	return home, nil
 }
+
+// CommonSkipDir will check a provided name to see if it represents directory that should not be watched
+func CommonSkipDir(name string) bool {
+	// Check for Mac's .DS_Store entries
+	return name == ".DS_Store"
+}

modules/watcher/watcher.go

@@ -15,13 +15,23 @@ import (
 	"github.com/fsnotify/fsnotify"
 )
 
+// CreateWatcherOpts are options to configure the watcher
 type CreateWatcherOpts struct {
-	PathsCallback   func(func(path, name string, d fs.DirEntry, err error) error) error
-	BeforeCallback  func()
+	// PathsCallback is used to set the required paths to watch
+	PathsCallback func(func(path, name string, d fs.DirEntry, err error) error) error
+
+	// BeforeCallback is called before any files are watched
+	BeforeCallback func()
+
+	// Between Callback is called between after a watched event has occured
 	BetweenCallback func()
-	AfterCallback   func()
+
+	// AfterCallback is called as this watcher ends
+	AfterCallback func()
 }
 
+// CreateWatcher creates a watcher labelled with the provided description and running with the provided options.
+// The created watcher will create a subcontext from the provided ctx and register it with the process manager.
 func CreateWatcher(ctx context.Context, desc string, opts *CreateWatcherOpts) {
 	go run(ctx, desc, opts)
 }
@@ -44,7 +54,7 @@ func run(ctx context.Context, desc string, opts *CreateWatcherOpts) {
 		log.Error("Unable to create watcher for %s: %v", desc, err)
 		return
 	}
-	if err := opts.PathsCallback(func(path, _ string, _ fs.DirEntry, err error) error {
+	if err := opts.PathsCallback(func(path, _ string, d fs.DirEntry, err error) error {
 		if err != nil && !os.IsNotExist(err) {
 			return err
 		}