add global ignore #32

Author: laktak

cmd/chkbit/help.go

@@ -18,6 +18,7 @@ var helpTips = `
   - \\      escape to match the following character
 - lines starting with '#' are skipped
 - lines starting with '/' are only applied to the current directory
+- global ignore file location: <global-ignore-file>
 
 Status codes:
   PNC: exception/panic, unable to continue

cmd/chkbit/main.go

@@ -64,6 +64,8 @@ var (
 	termDimFG   = lterm.Fg8(240)
 )
 
+var configRoot string
+
 type CLI struct {
 	Check struct {
 		Paths   []string `arg:"" name:"paths" help:"directories to check"`
@@ -113,22 +115,23 @@ type CLI struct {
 	Version struct {
 	} `cmd:"" help:"show version information"`
 
-	LogDeleted   bool   `short:"x" help:"log deleted/missing files/directories since the last run" negatable:""`
-	IncludeDot   bool   `short:"d" help:"include dot files" negatable:""`
-	SkipSymlinks bool   `short:"S" help:"do not follow symlinks" negatable:""`
-	NoRecurse    bool   `short:"R" help:"do not recurse into subdirectories" negatable:""`
-	NoDirInIndex bool   `short:"D" help:"do not track directories in the index" negatable:""`
-	NoConfig     bool   `help:"ignore the config file"`
-	MaxDepth     int    `default:0 help:"process a directory only if it is N or fewer levels below the specified path(s); 0 for no limit"`
-	LogFile      string `short:"l" help:"write to a logfile if specified"`
-	LogVerbose   bool   `help:"verbose logging" negatable:""`
-	Algo         string `default:"blake3" help:"hash algorithm: md5, sha512, blake3"`
-	IndexName    string `default:".chkbit" help:"filename where chkbit stores its hashes, needs to start with '.'"`
-	IgnoreName   string `default:".chkbitignore" help:"filename that chkbit reads its ignore list from, needs to start with '.'"`
-	Workers      int    `short:"w" default:"5" help:"number of workers to use. For slow IO (like on a spinning disk) --workers=1 will be faster"`
-	Plain        bool   `help:"show plain status instead of being fancy" negatable:""`
-	Quiet        bool   `short:"q" help:"quiet, don't show progress/information" negatable:""`
-	Verbose      bool   `short:"v" help:"verbose output" negatable:""`
+	LogDeleted     bool   `short:"x" help:"log deleted/missing files/directories since the last run" negatable:""`
+	IncludeDot     bool   `short:"d" help:"include dot files" negatable:""`
+	SkipSymlinks   bool   `short:"S" help:"do not follow symlinks" negatable:""`
+	NoRecurse      bool   `short:"R" help:"do not recurse into subdirectories" negatable:""`
+	NoDirInIndex   bool   `short:"D" help:"do not track directories in the index" negatable:""`
+	NoConfig       bool   `help:"do not load the config file"`
+	NoGlobalIgnore bool   `help:"do not load the global ignore file"`
+	MaxDepth       int    `default:0 help:"process a directory only if it is N or fewer levels below the specified path(s); 0 for no limit"`
+	LogFile        string `short:"l" help:"write to a logfile if specified"`
+	LogVerbose     bool   `help:"verbose logging" negatable:""`
+	Algo           string `default:"blake3" help:"hash algorithm: md5, sha512, blake3"`
+	IndexName      string `default:".chkbit" help:"filename where chkbit stores its hashes, needs to start with '.'"`
+	IgnoreName     string `default:".chkbitignore" help:"filename that chkbit reads its ignore list from, needs to start with '.'"`
+	Workers        int    `short:"w" default:"5" help:"number of workers to use. For slow IO (like on a spinning disk) --workers=1 will be faster"`
+	Plain          bool   `help:"show plain status instead of being fancy" negatable:""`
+	Quiet          bool   `short:"q" help:"quiet, don't show progress/information" negatable:""`
+	Verbose        bool   `short:"v" help:"verbose output" negatable:""`
 }
 
 type CLIDedup struct {
@@ -338,6 +341,9 @@ func (m *Main) runCmd(command string, cli CLI) int {
 	m.context.SkipSubdirectories = cli.NoRecurse
 	m.context.TrackDirectories = !cli.NoDirInIndex
 	m.context.MaxDepth = cli.MaxDepth
+	if !cli.NoGlobalIgnore {
+		m.context.GlobalIgnorePath = configRoot
+	}
 
 	st, root, err := chkbit.LocateIndex(pathList[0], chkbit.IndexTypeAny, m.context.IndexFilename)
 	if err != nil {
@@ -461,9 +467,8 @@ func (m *Main) run() int {
 	}
 
 	var configPath = "chkbit-config.json"
-	configRoot, err := os.UserConfigDir()
-	if err == nil {
-		configPath = slpath.Join(configRoot, "chkbit/config.json")
+	if configRoot != "" {
+		configPath = slpath.Join(configRoot, "config.json")
 	}
 
 	var cli CLI
@@ -595,7 +600,14 @@ func (m *Main) run() int {
 		return 0
 
 	case cmdTips:
-		fmt.Println(strings.ReplaceAll(helpTips, "<config-file>", configPath))
+		globalIgnoreFile := "unsupported"
+
+		if configRoot != "" {
+			globalIgnoreFile = slpath.Join(configRoot, cli.IgnoreName)
+		}
+		tips := strings.ReplaceAll(helpTips, "<config-file>", configPath)
+		tips = strings.ReplaceAll(tips, "<global-ignore-file>", globalIgnoreFile)
+		fmt.Println(tips)
 		return 0
 	case cmdVersion:
 		fmt.Println("github.com/laktak/chkbit")
@@ -616,6 +628,13 @@ func main() {
 		}
 	}()
 
+	var err error
+	if configRoot, err = os.UserConfigDir(); err == nil {
+		configRoot = slpath.Join(configRoot, "chkbit")
+	} else {
+		configRoot = ""
+	}
+
 	termWidth := lterm.GetWidth()
 	m := &Main{
 		logger:    log.New(io.Discard, "", 0),

context.go

@@ -24,6 +24,7 @@ type Context struct {
 	SkipSubdirectories bool
 	IndexFilename      string
 	IgnoreFilename     string
+	GlobalIgnorePath   string
 	MaxDepth           int
 
 	WorkQueue chan *WorkItem
@@ -142,6 +143,14 @@ func (context *Context) Process(pathList []string) {
 	context.NumUpd = 0
 	context.NumDel = 0
 
+	var globalIgnore *Ignore = nil
+
+	if context.GlobalIgnorePath != "" {
+		if ignore, err := GetIgnore(context, context.GlobalIgnorePath, nil); err == nil {
+			globalIgnore = ignore
+		}
+	}
+
 	err := context.store.Open(!context.UpdateIndex, context.NumWorkers*10)
 	if err != nil {
 		context.logErr("index", err)
@@ -159,7 +168,7 @@ func (context *Context) Process(pathList []string) {
 	}
 	go func() {
 		for _, path := range pathList {
-			context.scanDir(path, nil, 1)
+			context.scanDir(path, globalIgnore, 1)
 		}
 		for i := 0; i < context.NumWorkers; i++ {
 			context.endWork()

index.go

@@ -127,7 +127,7 @@ func (i *Index) calcHashes(ignore *Ignore) {
 
 func (i *Index) showIgnoredOnly(ignore *Ignore) {
 	for _, name := range i.files {
-		if ignore.shouldIgnore(name) {
+		if ignore.shouldIgnore(name) && !ignore.context.isChkbitFile(name) {
 			i.logFile(StatusIgnore, name)
 		}
 	}

scripts/run_test.go

@@ -19,7 +19,7 @@ func runCmd(args ...string) *exec.Cmd {
 	_, filename, _, _ := runtime.Caller(0)
 	prjRoot := filepath.Dir(filepath.Dir(filename))
 	tool := filepath.Join(prjRoot, "chkbit")
-	args = append([]string{"--no-config"}, args...)
+	args = append([]string{"--no-config", "--no-global-ignore"}, args...)
 	return exec.Command(tool, args...)
 }