How nrjdalal/smart-registry works
Project Type and Purpose
• This is a Node.js command-line tool (“Smart Registry”) written in TypeScript.
• Purpose: scan a codebase (registry/components folders), automatically detect dependencies and files, and generate a complete, error-free JSON registry for use by the shadcn UI ecosystem.
High-Level Architecture
• It’s a single-package CLI application with these major layers:
a. CLI Entry Point (bin/index.ts)
b. File System Scanner & Parser (bin/utils/files + bin/utils/resolvers)
c. Dependency & Import Analyzer (bin/utils/transformer + codemods)
d. Registry Item Builder (bin/constants + builder logic)
e. Output Writer (generates JSON under public/r or configured output)
Main Components and Their Interactions
• User invokes npx smart‐registry [options] → CLI Entry
• CLI Entry
• Parses flags (output dir, cwd, patterns)
• Calls File System Scanner
• File System Scanner
• Walks registry/, components/, or custom paths
• Collects file metadata (paths, types)
• Hands files to Dependency Analyzer
• Dependency & Import Analyzer
• Reads and parses each TypeScript/TSX file
• Extracts import statements for:
– runtime dependencies (e.g. “@radix-ui/react-dialog”)
– registry dependencies (other registry items)
• Builds a file/component dependency graph
• Registry Item Builder
• For each scanned file, consolidates:
– name, type (ui, lib, hooks, etc.)
– list of dependencies
– list of related files (with content snippets)
• Merges with any existing root registry.json extensions
• Output Writer
• Emits per-item JSON under public/r/<item>.json
• Emits a combined public/r/registry.json
Architectural Patterns & Principles
• Modular functional decomposition:
• “bin” folder holds entry points and high-level orchestration
• “bin/utils/files” for file traversal concerns
• “bin/utils/resolvers” for import resolution concerns
• Zero-Configuration defaulting: no required config file → uses convention (registry/components folder names)
• Dependency inversion: CLI parsing, file scanning, and JSON generation layers depend on abstracted utility modules
Technology Stack
• Node.js + TypeScript
• TSup for bundling (tsup.config.ts)
• Bun lockfile (bun.lock) supported
• GitHub Actions workflows for CI (.github/workflows/*.yml)
• File system: native fs + custom utilities
• Parser: TS AST via TypeScript compiler API (used in transformer)
• JSON I/O for final registry
• User → CLI Parser → File Scanner → Analyzer → Builder → Writer
• Green for input sources
• Blue for processing modules
• Orange for output stores
• Rectangles for code modules