Skip to content

Latest commit

 

History

History
49 lines (25 loc) · 1.48 KB

DECISIONS.md

File metadata and controls

49 lines (25 loc) · 1.48 KB

Design Decisions

D1: Metadata-only for files in v1.0

File content search is deferred to a later version. The first version indexes only filesystem metadata (name, path, size, timestamps, permissions).

D2: JSON records as first DB-like source

JSON and NDJSON records are the first structured data sources. SQLite is deferred.

D3: Daemon uses Unix domain sockets

The daemon communicates via Unix domain sockets for lowest latency and local-only security.

D4: Unicode normalization defaults to NFC

NFC is the most common normalization form and works well for most use cases.

D5: Case-insensitive for file names

File name matching is case-insensitive by default to match common user expectations.

D6: Hidden files excluded by default

Hidden files (dotfiles) are excluded unless explicitly configured.

D7: Symlinks not followed by default

Symbolic links are not followed to prevent loops and unexpected behavior.

D8: Result totals are exact within source

Total counts are exact, not estimated, for sources that support it.

D9: Default sort is deterministic relevance

Results are sorted by deterministic relevance score, then by source ID and record ID for stability.

D10: Internal helper named formatSearchOutput

The output formatting function is named formatSearchOutput internally.

D11: No external runtime dependencies

Core functionality uses only Node.js built-in modules.

D12: Apache-2.0 license

Apache-2.0 chosen for patent clarity as a standard.