diffwatch 1.1.2 → 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sarfraz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,100 +1,168 @@
-# diffwatch
+# DiffWatch
 
-A CLI-based Node.js application that provides a real-time Terminal User Interface (TUI) for monitoring Git repository changes. Watch file statuses and view diffs in a split-pane interface without leaving your terminal.
+A TUI app for watching git repository file changes with diffs.
 
 ![Screenshot](screenshot.jpg)
 
 ## Features
 
-- **Real-time Monitoring**: Automatically refreshes every 5 seconds to show the latest Git status
-- **Split-pane TUI**: Left pane displays files with color-coded status, right pane shows unified diffs
-- **Color-coded Status**: Green for added, Red for deleted, Blue for modified, White for untracked
-- **Keyboard Navigation**: Use arrow keys to navigate files, Tab to switch panes
-- **Git-only Operation**: Works exclusively in Git repositories
-- **Cross-platform**: Built with Node.js and TypeScript
+- **File Status Tracking**: Shows all changed files in a Git repository with their status (modified, new, deleted, renamed, etc.)
+- **Visual Diff Viewer**: Displays differences between file versions with syntax highlighting and line-by-line comparison
+- **Interactive Terminal Interface**: Built with React-like components for terminal UI using the @opentui library
+- **Real-time Updates**: Automatically polls for changes in the repository every 2 seconds
+- **File Operations**: 
+  - Revert changes to files
+  - Delete files safely (with trash/recycle bin support)
+  - Open files in the default editor
+- **Search Functionality**: Allows searching for files by content within the repository
+- **Commit History Browser**: View commit history with hash, message, author, and date
+- **Keyboard Navigation**: Full keyboard controls for navigating files and diffs
 
 ## Installation
 
-### Global Installation (Recommended)
+**Note:** This package currently supports Windows only. Linux and macOS support coming soon.
+
+### Option 1: Install from npm (recommended)
 
 ```bash
 npm install -g diffwatch
 ```
 
-### Local Installation
+Then run from any git repository:
+```bash
+diffwatch
+```
 
+### Option 2: Install from source
+
+1. Clone the repository:
 ```bash
-git clone <repository-url>
+git clone https://github.com/sarfraznawaz2005/diffwatch.git
 cd diffwatch
-npm install
-npm run build
-npm link
+```
+
+2. Install dependencies:
+```bash
+bun install
 ```
 
 ## Usage
 
-Navigate to any Git repository and run:
+### Basic Usage
 
+To watch the current git repository:
 ```bash
-diffwatch [path] [options]
+diffwatch
 ```
 
-### Arguments
+To watch a specific git repository:
+```bash
+diffwatch --path|-p /path/to/repo
+```
 
-- `path`: Path to the git repository (default: current directory)
+### Command Line Options
 
-### Options
+```bash
+diffwatch [OPTIONS]
+```
 
-- `-h, --help`: Show help information
+**Options:**
+- `--path <path>` or `-p <path>` - Specify git repository path to watch
+- `--help` or `-h` - Show help message
+- `--version` or `-v` - Show version number
 
-The application will:
-1. Check if the current directory is a Git repository
-2. Display a TUI with two panes
-3. Automatically refresh every 5 seconds
+### Examples
 
-### Controls
+Watch the repository in the current directory:
+```bash
+diffwatch
+```
 
-- **Arrow Keys / Tab**: Navigate through the file list and scroll in diff pane
-- **Enter**: Open selected file in default editor
-- **Escape/Q/Ctrl+C**: Exit the application
+Watch a specific project:
+```bash
+diffwatch --path ~/projects/my-app
+```
 
-## Prerequisites
+Check version:
+```bash
+diffwatch --version
+```
 
-- Node.js 16 or higher
-- Git installed and accessible in PATH
-- A terminal that supports TUI applications (most modern terminals)
+Show help:
+```bash
+diffwatch --help
+```
+
+## Keyboard Shortcuts
+
+- `↑` / `↓` - Navigate through the file list
+- `Tab` / `←` / `→` - Switch between file list and diff view
+- `Enter` - Open selected file in default editor
+- `D` - Delete selected file
+- `R` - Revert changes to selected file
+- `S` - Enter search mode
+- `H` - View commit history
+- `Q` - Quit the application
+- `Esc` - Exit search mode or close dialogs
 
 ## Development
 
+### Prerequisites
+
+- [Bun](https://bun.sh/) - Fast JavaScript runtime and package manager
+- Node.js 18+ (for running published package)
+
 ### Setup
 
+1. Clone the repository:
 ```bash
-npm install
-npm run build
-npm run dev  # Run in development mode
-npm test     # Run tests
+git clone https://github.com/sarfraznawaz2005/diffwatch.git
+cd diffwatch
 ```
 
-### Project Structure
-
+2. Install dependencies:
+```bash
+bun install
 ```
-src/
-├── index.ts          # Main application entry point
-└── utils/
-    └── git.ts        # Git operations and status handling
-tests/
-├── git.test.ts       # Unit tests for GitHandler
+
+### Running the App in Development
+
+```bash
+bun run dev
+# or
+bun run start
 ```
 
 ### Building
 
+To build the application for distribution:
+```bash
+bun run build
+```
+
+This creates a compiled binary in `dist/` directory.
+
+### Running Tests
+
 ```bash
-npm run build  # Compile TypeScript to JavaScript
+bun test                    # Run all tests
+bun test:watch            # Run tests in watch mode
+bun test:coverage         # Run tests with coverage
+bun test:unit            # Run unit tests only
+bun test:integration     # Run integration tests only
+bun test:git            # Run git-related tests only
+bun test:components     # Run component tests only
+bun test:app           # Run app integration tests
 ```
 
-### Testing
+### Type Checking
 
 ```bash
-npm test  # Run Jest test suite
+bun run typecheck
+# or
+bun run lint
 ```
 
+## License
+
+[MIT](LICENSE)

package/bin/diffwatch.js

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+
+import { spawn } from 'child_process';
+import { fileURLToPath } from 'url';
+import { dirname, join } from 'path';
+import { platform } from 'os';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+let binary = 'diffwatch';
+if (platform() === 'win32') {
+  binary += '.exe';
+}
+
+const appPath = join(__dirname, '..', 'dist', binary);
+
+const child = spawn(appPath, process.argv.slice(2), {
+  stdio: 'inherit',
+  cwd: process.cwd()
+});
+
+child.on('error', (err) => {
+  console.error('Failed to start diffwatch:', err.message);
+  process.exit(1);
+});
+
+child.on('exit', (code) => {
+  process.exit(code);
+});

package/package.json

@@ -1,40 +1,78 @@
 {
   "name": "diffwatch",
-  "version": "1.1.2",
-  "description": "An app for watching git repository file changes.",
-  "author": "Sarfraz Ahmed <sarfraznawaz2005@gmail.com>",
-  "main": "dist/index.js",
-  "bin": {
-    "diffwatch": "dist/index.js"
-  },
-  "scripts": {
-    "build": "tsc",
-    "start": "node dist/index.js",
-    "dev": "ts-node src/index.ts",
-    "test": "jest"
-  },
+  "version": "2.0.0",
+  "description": "A TUI app for watching git repository file changes with diffs.",
   "keywords": [
+    "git",
     "diff",
-    "watch",
-    "file",
-    "comparison",
-    "utility"
+    "terminal",
+    "tui",
+    "cli",
+    "git-gui",
+    "git-diff",
+    "terminal-ui"
   ],
+  "homepage": "https://github.com/sarfraznawaz2005/diffwatch#readme",
+  "bugs": {
+    "url": "https://github.com/sarfraznawaz2005/diffwatch/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sarfraznawaz2005/diffwatch.git"
+  },
   "license": "MIT",
-  "type": "commonjs",
-  "dependencies": {
-    "chalk": "^4.1.2",
-    "cheerio": "^1.1.2",
-    "diff2html": "^3.4.55",
-    "neo-neo-blessed": "^0.7.1",
-    "simple-git": "^3.30.0"
+  "author": "Sarfraz <sarfraznawaz2005@gmail.com>",
+  "engines": {
+    "node": ">=18.0.0"
   },
+  "bin": {
+    "diffwatch": "./bin/diffwatch.js"
+  },
+  "files": [
+    "dist/**/*",
+    "bin/**/*",
+    "README.md",
+    "LICENSE",
+    "package.json"
+  ],
+  "type": "module",
   "devDependencies": {
-    "@types/jest": "^30.0.0",
-    "@types/node": "^25.0.8",
-    "jest": "^30.2.0",
-    "ts-jest": "^29.4.6",
-    "ts-node": "^10.9.2",
+    "@types/bun": "latest",
+    "@types/node": "^25.0.10",
+    "@types/react": "^19.2.9",
+    "@types/react-dom": "^19.2.3"
+  },
+  "peerDependencies": {
     "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "@opentui/core": "^0.1.75",
+    "@opentui/react": "^0.1.75",
+    "@types/diff": "^8.0.0",
+    "diff": "^8.0.3",
+    "diff2html": "^3.4.55",
+    "fuse.js": "^7.1.0",
+    "isbinaryfile": "^6.0.0",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3",
+    "simple-git": "^3.30.0",
+    "trash": "^9.0.0"
+  },
+  "scripts": {
+    "build": "bun run build:version && bun build src/index.tsx --compile --outfile dist/diffwatch",
+    "build:version": "node -e \"console.log('export const BUILD_VERSION = \\\"' + require('./package.json').version + '\\\";')\" > src/version.ts",
+    "dev": "bun run src/index.tsx",
+    "start": "bun run src/index.tsx",
+    "prepublishOnly": "bun run build",
+    "test": "bun test",
+    "test:watch": "bun test --watch",
+    "test:coverage": "bun test --coverage",
+    "test:git": "bun test tests/unit/git.test.ts",
+    "test:components": "bun test tests/unit/*.test.ts",
+    "test:app": "bun test tests/integration/App.test.ts",
+    "test:unit": "bun test tests/unit/",
+    "test:integration": "bun test tests/integration/",
+    "typecheck": "bun x tsc --noEmit",
+    "lint": "bun run typecheck"
   }
 }

package/AGENTS.md

@@ -1,201 +0,0 @@
-# DiffWatch Agent Guidelines
-
-This document provides coding standards and operational guidelines for agentic coding assistants working on the DiffWatch project.
-
-## Build, Lint, and Test Commands
-
-### Primary Commands
-- **Build**: `npm run build` - Compiles TypeScript to JavaScript using `tsc`
-- **Test**: `npm test` - Runs Jest test suite
-- **Dev**: `npm run dev` - Runs the application in development mode with `ts-node`
-- **Start**: `npm start` - Runs the compiled application from `dist/`
-
-### Testing Specific Files
-- Run a single test file: `npm test -- tests/git.test.ts`
-- Run tests matching a pattern: `npm test -- --testNamePattern="should return file status"`
-
-### Linting and Type Checking
-- **Type Check**: `npx tsc --noEmit` - TypeScript type checking without compilation
-- **No explicit linting configured** - TypeScript strict mode serves as the primary code quality gate
-
-## Code Style Guidelines
-
-### Language and Module System
-- **Language**: TypeScript with strict mode enabled
-- **Target**: ES6 JavaScript output
-- **Module System**: CommonJS output (`"type": "commonjs"` in package.json)
-- **Source**: ES6 modules with `import`/`export` syntax
-
-### Import/Export Style
-```typescript
-// ES6 imports at the top of files
-import { simpleGit, SimpleGit, StatusResult } from 'simple-git';
-import fs from 'fs/promises';
-import chalk from 'chalk';
-
-// Named exports for utilities
-export interface FileStatus {
-  path: string;
-  status: 'modified' | 'added' | 'deleted' | 'unstaged' | 'unknown' | 'unchanged';
-  mtime?: Date;
-}
-
-// Default export for main classes
-export class GitHandler {
-  // ...
-}
-```
-
-### Naming Conventions
-- **Variables/Functions**: camelCase (`filePath`, `getStatus`, `updateFileList`)
-- **Classes/Interfaces**: PascalCase (`GitHandler`, `FileStatus`)
-- **Constants**: UPPER_CASE (not commonly used in this codebase)
-- **Files**: kebab-case for directories (`diff-formatter.ts`), camelCase for utilities
-- **Test Files**: Match source filename with `.test.ts` extension (`git.test.ts`)
-
-### Code Structure and Patterns
-- **Async/Await**: Preferred over Promises for asynchronous operations
-- **Error Handling**: Try-catch blocks with descriptive error messages
-- **Type Safety**: Use interfaces for data structures, avoid `any` type
-- **Class Design**: Private properties with public methods, constructor injection
-- **Functional Programming**: Pure functions where possible, avoid side effects
-
-### Formatting and Style
-- **Indentation**: 2 spaces (no tabs)
-- **Semicolons**: Not used (TypeScript ASI)
-- **Quotes**: Single quotes for strings (`'string'`)
-- **Line Length**: No strict limit, break long lines naturally
-- **Blank Lines**: Use sparingly between logical code blocks
-- **Comments**: Minimal comments, rely on descriptive naming
-- **Braces**: Same line for functions/classes, new line for control structures
-
-### Example Code Style
-```typescript
-export class GitHandler {
-  private git: SimpleGit;
-
-  constructor(workingDir: string = process.cwd()) {
-    this.git = simpleGit(workingDir);
-  }
-
-  async getStatus(): Promise<FileStatus[]> {
-    const status: StatusResult = await this.git.status();
-    const uniqueFiles = new Map<string, FileStatus>();
-
-    status.modified.forEach(path => {
-      uniqueFiles.set(path, { path, status: 'modified' });
-    });
-
-    // Process and return sorted results
-    const fileArray = Array.from(uniqueFiles.values());
-    return fileArray.sort((a, b) => {
-      const timeDiff = (b.mtime || new Date(0)).getTime() - (a.mtime || new Date(0)).getTime();
-      return timeDiff !== 0 ? timeDiff : a.path.localeCompare(b.path);
-    });
-  }
-}
-```
-
-### Error Handling Patterns
-```typescript
-async getFileContent(filePath: string): Promise<string> {
-  try {
-    return await fs.readFile(filePath, 'utf8');
-  } catch (error) {
-    return `Error reading file: ${error}`;
-  }
-}
-
-async isRepo(): Promise<boolean> {
-  try {
-    return await this.git.checkIsRepo();
-  } catch {
-    return false;
-  }
-}
-```
-
-### Testing Guidelines
-- **Framework**: Jest with ts-jest for TypeScript support
-- **Mocking**: Mock external dependencies (simple-git, fs/promises)
-- **Test Structure**: `describe` blocks for classes, `it` blocks for methods
-- **Assertions**: Use Jest matchers (`expect().toBe()`, `expect().toEqual()`)
-- **Test Naming**: Descriptive sentences starting with "should"
-- **Coverage**: Aim for critical path coverage, especially Git operations
-
-```typescript
-describe('GitHandler', () => {
-  let gitHandler: GitHandler;
-  let mockGit: any;
-
-  beforeEach(() => {
-    mockGit = { checkIsRepo: jest.fn() };
-    (simpleGit as jest.Mock).mockReturnValue(mockGit);
-    gitHandler = new GitHandler();
-  });
-
-  it('should return true if directory is a repo', async () => {
-    mockGit.checkIsRepo.mockResolvedValue(true);
-    const result = await gitHandler.isRepo();
-    expect(result).toBe(true);
-  });
-});
-```
-
-### File Organization
-- **Source Code**: `src/` directory with subdirectories for utilities
-- **Tests**: `tests/` directory mirroring source structure
-- **Build Output**: `dist/` directory (gitignored)
-- **Configuration**: Root level for `package.json`, `tsconfig.json`, `jest.config.js`
-
-### TypeScript Configuration
-- **Strict Mode**: Enabled for type safety
-- **Source Maps**: Enabled for debugging
-- **Declaration Files**: Generated for library usage
-- **Module Resolution**: Node.js style
-- **ES Module Interop**: Enabled for compatibility
-
-### Dependencies
-- **Runtime**: chalk (colors), simple-git (Git operations), neo-neo-blessed (TUI)
-- **Dev**: Jest, ts-jest, ts-node, TypeScript
-- **Keep dependencies minimal** - only add when necessary for functionality
-
-### Git and Version Control
-- **Branching**: Feature branches for development
-- **Commits**: Descriptive messages focusing on "why" rather than "what"
-- **Tags**: Semantic versioning (current: 1.0.8)
-- **Hooks**: No custom hooks configured
-
-### Security Considerations
-- **Input Validation**: Validate file paths and user inputs
-- **Error Messages**: Avoid exposing sensitive system information
-- **Dependencies**: Keep updated, audit regularly
-- **Secrets**: Never commit sensitive data
-
-### Performance Guidelines
-- **Async Operations**: Use efficient patterns, avoid blocking operations
-- **Memory Management**: Clean up resources, avoid memory leaks
-- **File I/O**: Handle large files appropriately
-- **Real-time Updates**: Debounce rapid operations (150ms in current code)
-
-### Code Review Checklist
-- [ ] TypeScript compiles without errors
-- [ ] Tests pass and cover new functionality
-- [ ] Follows established naming and style conventions
-- [ ] Error handling appropriate for use case
-- [ ] No console.log statements in production code
-- [ ] Dependencies justified and minimal
-- [ ] Documentation updated if public API changes</content>
-<parameter name="filePath">D:\SystemFolders\Downloads\Dev\node\diffwatch\AGENTS.md
-
-<!-- GENERAL-RULES-RULES-START -->
-
-## You must always follow these rules:
-
-- If you are unsure about any requirement, behavior, or implementation detail, ask clarifying questions **before** writing code.
-- At every step, provide a **high-level explanation** of what changes were made and why.
-- After implementing changes or new features, always provide a list of **suggestions or improvements**, even if they differ from the user's original request.
-- If the user requests a change or feature that is an **anti-pattern** or violates well-established best practices, clearly explain the issue and ask for confirmation before proceeding.
-- Always use Context7 MCP when I need library/API documentation, code generation, setup or configuration steps without me having to explicitly ask.
-
-<!-- GENERAL-RULES-RULES-END -->

package/dist/index.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}