Dotfiles, and distinct number color !53

merged merged by cmc on 2026-10-05 21:10 UTC · krz/orgstar:colors-and-dotfiles into main

9 files changed, +85 −23

Layout: unified · split

Sources/OrgApp/AgendaModel.swift +2 −1

     /// Emacs lists a directory in `org-agenda-files`.
     public var files: [String] {
         workspace.files
-            .filter { $0.kind == .org && (includeSubfolders || !$0.relativePath.contains("/")) }
+            // Dotfiles stay out, as `org-agenda-file-regexp` leaves them out.
+            .filter { $0.kind == .org && !$0.name.hasPrefix(".") && (includeSubfolders || !$0.relativePath.contains("/")) }
             .map(\.path)
             .sorted()
     }

Sources/OrgApp/UserConfig.swift +6

 import Foundation
 import OrgCore
 import OrgPresentation
+import OrgWorkspace
 /// The configuration folder (`$XDG_CONFIG_HOME/orgstar`, else `~/.config/orgstar`) and
 /// `config.toml` in it: every setting of the Settings window as text, to edit, keep in a
                 comment: "left, right, both or none", legacy: "general.option-as-meta"),
         Setting(section: "orgstar", key: "show-markup", defaultsKey: "showMarkup", kind: .bool, fallback: .bool(false),
                 comment: "show link brackets and emphasis markers (View ▸ Show Markup)", legacy: "editor.show-markup"),
+        Setting(section: "orgstar", key: "show-hidden-files", defaultsKey: "showHiddenFiles", kind: .bool, fallback: .bool(true),
+                comment: "list dotfiles and dot folders in your folders", legacy: ""),
+        Setting(section: "orgstar", key: "ignored-folders", defaultsKey: "ignoredFolders", kind: .string,
+                fallback: .string(ScanRules.defaultIgnoredFolders.sorted().joined(separator: " ")),
+                comment: "folder names never listed or searched, separated by spaces", legacy: ""),
         Setting(section: "orgstar", key: "agenda-include-subfolders", defaultsKey: "agendaSubfolders", kind: .bool, fallback: .bool(false),
                 comment: "the agenda reads org files in subfolders too", legacy: "agenda.include-subfolders"),
         Setting(section: "orgstar", key: "reminders", defaultsKey: "reminders", kind: .bool, fallback: .bool(true),

Sources/OrgApp/WorkspaceModel.swift +10 −2

     // MARK: - Indexing
+    /// Which files the folders show; a change rescans them.
+    public var scanRules = ScanRules() {
+        didSet {
+            guard scanRules != oldValue else { return }
+            Task { await refresh() }
+        }
+    }
     /// Reconciles every root off the main thread, then reloads the file list.
     public func refresh() async {
         isIndexing = true
         defer { isIndexing = false }
-        let reconciler = Reconciler(index: index, settings: settings)
+        let reconciler = Reconciler(index: index, settings: settings, rules: scanRules)
         for url in resolvedRoots.values {
             do {
                 _ = try await Task.detached { try reconciler.reconcile(root: url) }.value
     /// Reconciles the paths a batch of file events named, or whole roots when events were lost.
     public func filesChanged(_ paths: [URL], rescan roots: [URL]) async {
-        let reconciler = Reconciler(index: index, settings: settings)
+        let reconciler = Reconciler(index: index, settings: settings, rules: scanRules)
         for rootURL in roots {
             _ = try? await Task.detached { try reconciler.reconcile(root: rootURL) }.value
         }

Sources/OrgPresentation/ThemeSpec.swift +2 −2

Sources/OrgWorkspace/Discovery.swift +37 −10

     case ignored
 }
+/// Which files and folders a scan takes in.
+public struct ScanRules: Sendable, Equatable {
+    /// Dotfiles and dot folders, other than ignored folders.
+    public var hiddenFiles: Bool
+    /// Folder names never looked into: version control, caches, build output.
+    public var ignoredFolders: Set<String>
+    public static let defaultIgnoredFolders: Set<String> = [
+        ".git", ".hg", ".svn", ".jj", ".bzr", ".stfolder", ".stversions", ".Trash", ".Spotlight-V100", ".fseventsd",
+        ".build", ".venv", ".cache", ".tox", ".mypy_cache", ".pytest_cache", ".gradle", ".next", ".terraform", "node_modules",
+    ]
+    public init(hiddenFiles: Bool = true, ignoredFolders: Set<String> = defaultIgnoredFolders) {
+        self.hiddenFiles = hiddenFiles
+        self.ignoredFolders = ignoredFolders
+    }
+    public func skipsFolder(_ name: String) -> Bool {
+        ignoredFolders.contains(name) || (!hiddenFiles && name.hasPrefix("."))
+    }
+}
 public enum WorkspaceScanner {
     /// What a file name means to the workspace. Syncthing temp files, our own temp and backup
-    /// files, Emacs backups and auto-saves, and other hidden files are ignored; files that
+    /// files, Emacs backups, auto-saves and lock files, and Finder's files are ignored, and
-    /// aren't org files are `.other`.
+    /// other dotfiles unless `rules` takes them in; files that aren't org files are `.other`.
-    public static func classify(_ name: String) -> FileClassification {
+    public static func classify(_ name: String, rules: ScanRules = ScanRules()) -> FileClassification {
         if name.hasPrefix(".") {
             if name.hasSuffix(".icloud") {
                 let inner = String(name.dropFirst().dropLast(".icloud".count))
-                if case .file = classify(inner) { return .placeholder(inner) }
+                if case .file = classify(inner, rules: rules) { return .placeholder(inner) }
+                return .ignored
+            }
+            if !rules.hiddenFiles || name.hasPrefix(".#") || name.hasPrefix(".syncthing.") || name.contains(".orgstar-")
+                || name == ".DS_Store" || name == ".localized" {
+                return .ignored
             }
-            return .ignored
         }
         if name.hasSuffix("~") || name.hasPrefix("#") { return .ignored }
         let conflict = name.contains(".sync-conflict-")
         return .file(.other)
     }
-    /// Every file under `root`, skipping hidden folders (`.git`, `.stfolder`, `.stversions`).
+    /// Every file under `root`, skipping the folders `rules` ignores.
-    public static func scan(_ root: URL) throws -> Discovery {
+    public static func scan(_ root: URL, rules: ScanRules = ScanRules()) throws -> Discovery {
         let keys: [URLResourceKey] = [.isDirectoryKey, .fileSizeKey, .contentModificationDateKey]
         guard let enumerator = FileManager.default.enumerator(at: root, includingPropertiesForKeys: keys) else {
             return Discovery()
             let values = try url.resourceValues(forKeys: Set(keys))
             let name = url.lastPathComponent
             if values.isDirectory == true {
-                if name.hasPrefix(".") { enumerator.skipDescendants() }
+                if rules.skipsFolder(name) { enumerator.skipDescendants() }
                 continue
             }
-            switch classify(name) {
+            switch classify(name, rules: rules) {
             case .file(let kind):
                 discovery.files.append(DiscoveredFile(
                     url: url.standardizedFileURL,
     }
     public func contains(relativePath: String, kind: FileKind) -> Bool {
-        guard kind == .org else { return false }
+        // `org-agenda-file-regexp` leaves out dotfiles.
+        guard kind == .org, !(relativePath as NSString).lastPathComponent.hasPrefix(".") else { return false }
         guard !globs.isEmpty else { return true }
         // Without FNM_PATHNAME, `*` also matches `/`, so `work/*` covers nested folders.
         return globs.contains { fnmatch($0, relativePath, 0) == 0 }

Sources/OrgWorkspace/Reconciler.swift +7 −5

 public struct Reconciler: Sendable {
     public let index: IndexStore
     public let settings: IndexSettings
+    public let rules: ScanRules
-    public init(index: IndexStore, settings: IndexSettings) {
+    public init(index: IndexStore, settings: IndexSettings, rules: ScanRules = ScanRules()) {
         self.index = index
         self.settings = settings
+        self.rules = rules
     }
     /// Reconciles the whole root.
     public func reconcile(root: URL) throws -> ReconcileReport {
-        let discovery = try WorkspaceScanner.scan(root)
+        let discovery = try WorkspaceScanner.scan(root, rules: rules)
         for placeholder in discovery.placeholders {
             try? FileManager.default.startDownloadingUbiquitousItem(at: placeholder)
         }
         var found: [DiscoveredFile] = []
         let rootComponents = root.standardizedFileURL.pathComponents.count
         for url in paths.map(\.standardizedFileURL) {
-            // Files in hidden folders (`.git`) aren't part of the workspace, as in `scan`.
+            // Files in ignored folders (`.git`) aren't part of the workspace, as in `scan`.
-            if url.pathComponents.dropFirst(rootComponents).dropLast().contains(where: { $0.hasPrefix(".") }) { continue }
+            if url.pathComponents.dropFirst(rootComponents).dropLast().contains(where: rules.skipsFolder) { continue }
-            guard case .file(let kind) = WorkspaceScanner.classify(url.lastPathComponent),
+            guard case .file(let kind) = WorkspaceScanner.classify(url.lastPathComponent, rules: rules),
                   let values = try? url.resourceValues(forKeys: [.fileSizeKey, .contentModificationDateKey, .isDirectoryKey]),
                   values.isDirectory != true else { continue }
             found.append(DiscoveredFile(

Sources/Orgstar/ContentView.swift +6

 import OrgCore
 import OrgEditorAppKit
 import OrgPresentation
+import OrgWorkspace
 import OrgIndex
 import SwiftUI
 import UniformTypeIdentifiers
     @AppStorage("outlineWidth") private var outlineWidth = 220.0
     @AppStorage("showMarkup") private var showMarkup = false
     @AppStorage("showLineNumbers") private var showLineNumbers = true
+    @AppStorage("showHiddenFiles") private var showHiddenFiles = true
+    @AppStorage("ignoredFolders") private var ignoredFolders = ScanRules.defaultIgnoredFolders.sorted().joined(separator: " ")
     @AppStorage("themeFont") private var themeFont = ""
     @AppStorage("themeFontSize") private var themeFontSize = 13
     @AppStorage("themeLineSpacing") private var themeLineSpacing = 2
         .searchFocused($searchFocused)
         .toolbar { toolbarItems }
         .onChange(of: session.path) { plainOutlineShown = false }
+        .onChange(of: ScanRules(hiddenFiles: showHiddenFiles, ignoredFolders: Set(ignoredFolders.split(separator: " ").map(String.init))), initial: true) { _, rules in
+            workspace.scanRules = rules
+        }
         .onChange(of: selectedFile) { old, path in
             guard let path else { return }
             if !DocumentSession.isOrgPath(path), !FileTypes.isText(path) {

Sources/Orgstar/OrgstarApp.swift +2

     @AppStorage("reminderLead") private var reminderLead = 12
     @AppStorage("globalCapture") private var globalCapture = true
     @AppStorage("settingsTab") private var tab = "general"
+    @AppStorage("showHiddenFiles") private var showHiddenFiles = true
     @AppStorage("themeFont") private var themeFont = ""
     @AppStorage("themeFontSize") private var themeFontSize = 13
     @AppStorage("themeLineSpacing") private var themeLineSpacing = 2
                 Picker("Keys", selection: $preset) {
                     ForEach(KeymapPreset.allCases, id: \.self) { Text($0.title).tag($0) }
                 }
+                Toggle("Show hidden files and folders", isOn: $showHiddenFiles)
                 Picker("Option as Meta", selection: $optionAsMeta) {
                     Text("Left Option").tag(OptionAsMeta.left.rawValue)
                     Text("Right Option").tag(OptionAsMeta.right.rawValue)

Tests/OrgWorkspaceTests/DiscoveryTests.swift +13 −3

         ("#a.org#", .ignored),
         ("a.md", .file(.other)),
         ("photo.jpg", .file(.other)),
-        (".hidden.org", .ignored),
+        (".hidden.org", .file(.org)),
+        (".zshrc", .file(.other)),
+        (".#a.org", .ignored),
+        (".DS_Store", .ignored),
+        (".a.org.orgstar-backup-1", .ignored),
     ])
     func classify(name: String, expected: FileClassification) {
         #expect(WorkspaceScanner.classify(name) == expected)
         #expect(AgendaScope().contains(relativePath: "a.org", kind: .org))
         #expect(!AgendaScope().contains(relativePath: "a.org_archive", kind: .archive))
         #expect(!AgendaScope().contains(relativePath: "a.org", kind: .conflict))
+        #expect(!AgendaScope().contains(relativePath: "sub/.draft.org", kind: .org))
         let work = AgendaScope(globs: ["work/*"])
         #expect(work.contains(relativePath: "work/deep/a.org", kind: .org))
         #expect(!work.contains(relativePath: "home/a.org", kind: .org))
         try folder.write(".stversions/d.org", "* d\n")
         try folder.write("sub/.e.org.icloud", "")
         try folder.write("notes.txt", "")
+        try folder.write(".config/app.toml", "")
+        try folder.write(".notes.org", "* n\n")
+        try folder.write("node_modules/x/index.js", "")
         let discovery = try WorkspaceScanner.scan(folder.url)
-        #expect(discovery.files.map(\.url.lastPathComponent) == ["a.org", "notes.txt", "b.org_archive"])
+        #expect(discovery.files.map(\.url.lastPathComponent) == ["app.toml", ".notes.org", "a.org", "notes.txt", "b.org_archive"])
-        #expect(discovery.files.map(\.kind) == [.org, .other, .archive])
+        #expect(discovery.files.map(\.kind) == [.other, .org, .org, .other, .archive])
+        let visible = try WorkspaceScanner.scan(folder.url, rules: ScanRules(hiddenFiles: false))
+        #expect(visible.files.map(\.url.lastPathComponent) == ["a.org", "notes.txt", "b.org_archive"])
         #expect(discovery.placeholders.map(\.lastPathComponent) == ["e.org"])
     }
 }

	@@ -143,7 +143,7 @@ public struct ThemeSpec: Equatable, Sendable {
143	"block-background": "#f6f8fa", "block-delimiter": "#8c959f", "table": "#1f2328",	143	"block-background": "#f6f8fa", "block-delimiter": "#8c959f", "table": "#1f2328",
144	"line-number": "#8c959f", "line-number-current": "#1f2328",	144	"line-number": "#8c959f", "line-number-current": "#1f2328",
145	"syntax-keyword": "#cf222e", "syntax-string": "#0a3069", "syntax-comment": "#6e7781", "syntax-function": "#8250df",	145	"syntax-keyword": "#cf222e", "syntax-string": "#0a3069", "syntax-comment": "#6e7781", "syntax-function": "#8250df",
146	"syntax-type": "#953800", "syntax-number": "#0550ae", "syntax-property": "#0550ae", "syntax-label": "#8250df",	146	"syntax-type": "#953800", "syntax-number": "#1b7c83", "syntax-property": "#0550ae", "syntax-label": "#8250df",
147	"modeline-highlight": "#1f2328", "state-normal": "#0969da", "state-insert": "#1a7f37", "state-visual": "#bc4c00",	147	"modeline-highlight": "#1f2328", "state-normal": "#0969da", "state-insert": "#1a7f37", "state-visual": "#bc4c00",
148	"agenda-date": "#1f2328", "agenda-today": "#0969da", "agenda-time": "#6e7781", "agenda-category": "#6e7781",	148	"agenda-date": "#1f2328", "agenda-today": "#0969da", "agenda-time": "#6e7781", "agenda-category": "#6e7781",
149	"agenda-deadline": "#cf222e", "agenda-upcoming": "#bc4c00", "agenda-scheduled": "#6e7781", "agenda-scheduled-past": "#953800",	149	"agenda-deadline": "#cf222e", "agenda-upcoming": "#bc4c00", "agenda-scheduled": "#6e7781", "agenda-scheduled-past": "#953800",
	@@ -159,7 +159,7 @@ public struct ThemeSpec: Equatable, Sendable {
159	"block-background": "#161b22", "block-delimiter": "#6e7681", "table": "#e6edf3",	159	"block-background": "#161b22", "block-delimiter": "#6e7681", "table": "#e6edf3",
160	"line-number": "#6e7681", "line-number-current": "#e6edf3",	160	"line-number": "#6e7681", "line-number-current": "#e6edf3",
161	"syntax-keyword": "#ff7b72", "syntax-string": "#a5d6ff", "syntax-comment": "#8b949e", "syntax-function": "#d2a8ff",	161	"syntax-keyword": "#ff7b72", "syntax-string": "#a5d6ff", "syntax-comment": "#8b949e", "syntax-function": "#d2a8ff",
162	"syntax-type": "#ffa657", "syntax-number": "#79c0ff", "syntax-property": "#79c0ff", "syntax-label": "#d2a8ff",	162	"syntax-type": "#ffa657", "syntax-number": "#56d4dd", "syntax-property": "#79c0ff", "syntax-label": "#d2a8ff",
163	"modeline-highlight": "#e6edf3", "state-normal": "#1f6feb", "state-insert": "#238636", "state-visual": "#9e6a03",	163	"modeline-highlight": "#e6edf3", "state-normal": "#1f6feb", "state-insert": "#238636", "state-visual": "#9e6a03",
164	"agenda-date": "#e6edf3", "agenda-today": "#58a6ff", "agenda-time": "#8b949e", "agenda-category": "#8b949e",	164	"agenda-date": "#e6edf3", "agenda-today": "#58a6ff", "agenda-time": "#8b949e", "agenda-category": "#8b949e",
165	"agenda-deadline": "#ff7b72", "agenda-upcoming": "#ffa657", "agenda-scheduled": "#8b949e", "agenda-scheduled-past": "#d29922",	165	"agenda-deadline": "#ff7b72", "agenda-upcoming": "#ffa657", "agenda-scheduled": "#8b949e", "agenda-scheduled-past": "#d29922",