ignore symlinks

Author: Itay Donanhirsh

README.md

@@ -109,6 +109,18 @@ These tags are written as a normal tag to the index, with an added attribute `se
 * somewhere:1.1-19 lang=hs search=glob
 ```
 
+### Pragma Tags
+
+There are only two pragma tags implemented: `%stop` and `%cont`. Example:
+
+```
+[# to_be #]
+[# %stop #]
+[# or_not_to_be #]
+[# %cont #]
+[# that_is_the_question #]
+```
+
 ## Index
 
 To generate an index, use:
@@ -178,6 +190,12 @@ scanner:
     right: "#]"
 ```
 
+## Caveats
+
+- Only textual files are scanned.
+- Tags are scanned whether they are in a comment or not.
+- Links are ignored.
+
 ## Integrations
 
 - [Vim Plugin](https://github.com/cluttercode/vim-clutter)

cmd/clutter/index.go

@@ -56,11 +56,11 @@ func readIndex(c *cli.Context) (*index.Index, error) {
 				continue
 			}
 
-			if path == "" {
-				path = "stdin"
+			if path != "" {
+				path = path + ": "
 			}
 
-			return nil, fmt.Errorf("%s: %w", path, err)
+			return nil, fmt.Errorf("%s%w", path, err)
 		}
 
 		z.Infow("index read", "n", idx.Size())

internal/pkg/scanner/filter.go

@@ -27,14 +27,29 @@ func NewFilter(z *zap.SugaredLogger, cfg Config) (func(string, os.FileInfo) (boo
 	exclude := gitignore.NewMatcher(ignores).Match
 
 	return func(path string, fi os.FileInfo) (bool, error) {
-		isDir := fi != nil && fi.IsDir()
+		var (
+			isDir, isLink bool
+			mode          os.FileMode
+		)
+
+		if fi != nil {
+			mode = fi.Mode()
+			isDir = fi.IsDir()
+			isLink = mode&os.ModeSymlink != 0
+		}
 
 		split := strings.Split(path, string(filepath.Separator))
 
-		z := z.With("path", split, "is_dir", isDir)
+		z := z.With("path", split, "is_link", isLink, "is_dir", isDir, "mode", mode)
+
+		if isLink {
+			z.Debug("links are excluded")
+
+			return false, nil
+		}
 
 		if exclude(split, isDir) {
-			z.Debug("exclude")
+			z.Debug("exclude dir")
 
 			if isDir {
 				return false, filepath.SkipDir

internal/pkg/scanner/scan.go

@@ -45,8 +45,6 @@ func ScanReader(
 	for i := 0; scanner.Scan(); i++ {
 		line := scanner.Text()
 
-		z.Debugw("read", "line", line)
-
 		ms := re.FindAllStringIndex(line, -1)
 
 		for _, m := range ms {