fix(nav): traversal skip (#363)

feat(nav): fix up SkipDir (#363)

feat(nav): fix up pointer to slice (#363)

feat(nav): move proxy method to frame (#363)

feat(nav): make frame on navigation info private (#363)

feat(nav): add SkipTraversal (#363)

feat(nav): fix up traversal skip (#363)

Author: plastikfan

.gitignore

@@ -20,6 +20,8 @@ ginkgo.report
 
 .task/
 .env
+.DS_Store
+thumbs.db
 
 test-options*.json
 test-state*.json

.vscode/launch.json

@@ -4,6 +4,7 @@
   // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
   "configurations": [
+  
     {
       "name": "Launch Package",
       "type": "go",

.vscode/settings.json

@@ -7,14 +7,17 @@
     "bodyclose",
     "booter",
     "bootstrapper",
+    "cerr",
     "chardata",
+    "cmds",
     "cobrass",
     "coverpkg",
     "coverprofile",
     "deadcode",
     "deepcopy",
     "depguard",
     "dogsled",
+    "dotenv",
     "dupl",
     "ensync",
     "errcheck",
@@ -70,9 +73,11 @@
     "oldpath",
     "onecontext",
     "onsi",
+    "outdir",
     "prealloc",
     "rabbitweed",
     "repath",
+    "repotoken",
     "Resumer",
     "rxgo",
     "samber",
@@ -92,6 +97,11 @@
     "unparam",
     "usao",
     "varcheck",
+    "watchv",
+    "watchvc",
+    "watchvi",
+    "watchvn",
+    "watchvu",
     "wgan",
     "xname",
     "xpander",

xfs/nav/directory-entries.go

@@ -63,7 +63,7 @@ func (e *DirectoryEntries) arrange(entries *[]fs.DirEntry) {
 	}
 }
 
-func (e *DirectoryEntries) all() *[]fs.DirEntry {
+func (e *DirectoryEntries) all() []fs.DirEntry {
 	result := []fs.DirEntry{}
 
 	switch e.Order {
@@ -73,7 +73,7 @@ func (e *DirectoryEntries) all() *[]fs.DirEntry {
 		result = append(e.Files, e.Folders...) //nolint:gocritic // no alternative known
 	}
 
-	return &result
+	return result
 }
 
 func (e *DirectoryEntries) sort(entries *[]fs.DirEntry) {

xfs/nav/error-handlers.go

@@ -33,17 +33,13 @@ func (h *notifyCallbackErrorHandler) accept(params *fileSystemErrorParams) error
 		},
 	)
 
-	callbackErr := params.agent.proxy(&agentProxyParams{
-		item: &TraverseItem{
-			Path:      params.path,
-			Info:      params.info,
-			Error:     err,
-			Children:  []fs.DirEntry{},
-			Extension: &ExtendedItem{},
-		},
-
-		frame: params.frame,
-	})
+	callbackErr := params.frame.proxy(&TraverseItem{
+		Path:      params.path,
+		Info:      params.info,
+		Error:     err,
+		Children:  []fs.DirEntry{},
+		Extension: &ExtendedItem{},
+	}, nil)
 
 	return callbackErr
 }

xfs/nav/errors.go

@@ -2,7 +2,6 @@ package nav
 
 import (
 	"fmt"
-	"io/fs"
 )
 
 // ❌ Invalid Notification Mute Requested
@@ -52,10 +51,3 @@ func NewInvalidPeriscopeRootPathNativeError(root, current string) error {
 func NewResumeControllerNotSetNativeError(from string) error {
 	return fmt.Errorf("internal: resume controller not set (from: '%v')", from)
 }
-
-// ❌ SkipDir
-
-// QuerySkipDirError query if error is the fs SkipDir error
-func QuerySkipDirError(target error) bool {
-	return target != nil && target == fs.SkipDir
-}

xfs/nav/helpers_test.go

@@ -45,8 +45,11 @@ type naviTE struct {
 
 type skipTE struct {
 	naviTE
-	skip    string
-	exclude string
+	skipAt      string
+	prohibit    string
+	all         bool
+	folderCount int
+	fileCount   int
 }
 
 type listenTE struct {
@@ -368,12 +371,12 @@ func foldersCaseSensitiveCallback(first, second string) *nav.LabelledTraverseCal
 
 // === skip
 
-func skipFolderCallback(skip, exclude string) *nav.LabelledTraverseCallback {
+func skipDirFolderCallback(skip, exclude string) *nav.LabelledTraverseCallback {
 	return &nav.LabelledTraverseCallback{
 		Label: "test skip folder callback",
 		Fn: func(item *nav.TraverseItem) error {
 			GinkgoWriter.Printf(
-				"---> ♻️ ON-NAVIGATOR-SKIP-CALLBACK(skip:%v): '%v'\n", skip, item.Path,
+				"---> ♻️ ON-NAVIGATOR-SKIP-DIR-CALLBACK(skip:%v): '%v'\n", skip, item.Path,
 			)
 
 			Expect(strings.HasSuffix(item.Path, exclude)).To(BeFalse())
@@ -385,6 +388,23 @@ func skipFolderCallback(skip, exclude string) *nav.LabelledTraverseCallback {
 	}
 }
 
+func skipAllFolderCallback(skip, exclude string) *nav.LabelledTraverseCallback {
+	return &nav.LabelledTraverseCallback{
+		Label: "test skipAll folder callback",
+		Fn: func(item *nav.TraverseItem) error {
+			GinkgoWriter.Printf(
+				"---> ♻️ ON-NAVIGATOR-SKIP-ALL-CALLBACK(skip:%v): '%v'\n", skip, item.Path,
+			)
+
+			Expect(strings.HasSuffix(item.Path, exclude)).To(BeFalse())
+
+			return lo.Ternary(strings.HasSuffix(item.Path, skip),
+				fs.SkipAll, nil,
+			)
+		},
+	}
+}
+
 func boostCallback(name string) *nav.LabelledTraverseCallback {
 	return &nav.LabelledTraverseCallback{
 		Label: "test boost callback",

xfs/nav/hook-extend.go

@@ -23,22 +23,22 @@ func DefaultExtendHookFn(navi *NavigationInfo, entries *DirectoryEntries) {
 
 	if navi.Item.IsDir() {
 		isLeaf = len(entries.Folders) == 0
-		scope = navi.Frame.periscope.scope(isLeaf)
+		scope = navi.frame.periscope.scope(isLeaf)
 	} else {
 		scope = ScopeLeafEn
 	}
 
 	parent, name := filepath.Split(navi.Item.Path)
 	navi.Item.Extension = &ExtendedItem{
-		Depth:     navi.Frame.periscope.depth(),
+		Depth:     navi.frame.periscope.depth(),
 		IsLeaf:    isLeaf,
 		Name:      name,
 		Parent:    parent,
 		NodeScope: scope,
 	}
 
 	spInfo := &SubPathInfo{
-		Root:      navi.Frame.root.Get(),
+		Root:      navi.frame.root.Get(),
 		Item:      navi.Item,
 		Behaviour: &navi.Options.Store.Behaviours.SubPath,
 	}