Chrome File Watcher

A Node.js package that watches for PDF and DOC file downloads using Chrome's DevTools Protocol and emits events via Socket.IO.

Features

• Monitors file downloads using Chrome's DevTools Protocol.
• Detects and handles .pdf, .doc, and .docx file types.
• Emits real-time file download events to a Socket.IO server.
• Automatically formats code with Prettier and lints it with ESLint.
• Pre-commit hooks using Husky and lint-staged to ensure consistent code quality.

Prerequisites

• Node.js v14.x or later
• Chrome installed with remote debugging enabled (--remote-debugging-port=9222)

Installation

1. Clone the repository:

   git clone https://github.com/your-repo/chrome-file-watcher.git
   cd chrome-file-watcher

2. Install dependencies:

   npm install

3. Enable Husky hooks:

   npm run prepare

Usage

1. Make sure Chrome is running with remote debugging enabled:

   google-chrome --remote-debugging-port=9222

2. Set up the watcher in your code:

   import { setupFileDownloadWatcher } from 'chrome-file-watcher';
   
   const config = {
     chromeDevToolsPort: 9222, // Default Chrome DevTools port
     socketServerUrl: 'http://localhost:3000',
     channelName: 'file-download-channel',
   };
   
   setupFileDownloadWatcher(config);

3. Start the project:

   npm start

4. Any detected file downloads (.pdf, .doc, .docx) will be emitted to the specified Socket.IO channel.

Scripts

• build: Compiles TypeScript code.
• start: Runs the project using ts-node.
• watch: Recompiles TypeScript code on changes.
• lint: Runs ESLint to lint the source files.
• lint:fix: Automatically fixes linting issues.
• format: Formats code using Prettier.

Pre-commit Hooks

The project uses Husky and lint-staged to ensure code quality before every commit:

• Husky runs a pre-commit hook that triggers lint-staged.
• lint-staged runs ESLint and Prettier on staged files.

Running Lint and Format

You can manually lint and format your code with the following commands:

• Lint files:

  npm run lint

• Fix linting issues:

  npm run lint:fix

• Format code:

  npm run format

Project Structure

your-package/
  ├── src/
  │   ├── interfaces/
  │   │   ├── ChromeFileWatcherConfig.ts
  │   │   ├── Config.ts
  │   │   ├── SocketServiceConfig.ts
  │   │   ├── IChromeFileWatcher.ts
  │   │   ├── ISocketService.ts
  │   ├── services/
  │   │   ├── ChromeFileWatcher.ts
  │   │   ├── SocketService.ts
  │   └── index.ts
  ├── dist/
  ├── .husky/
  ├── .eslintignore
  ├── .prettierignore
  ├── .prettierrc
  ├── eslint.config.js
  ├── tsconfig.json
  ├── package.json
  └── README.md

ESLint and Prettier Setup

The project uses ESLint and Prettier for code linting and formatting, configured to run automatically on every commit.

ESLint

• ESLint is used to statically analyze your TypeScript code for potential issues.

You can run the linter manually:

npm run lint

Prettier

• Prettier ensures consistent code formatting.

To format your code, run:

npm run format

Husky and lint-staged

Husky and lint-staged are set up to run the following tasks on every commit:

• ESLint to check for coding errors.
• Prettier to format the code.

To ensure that Husky is set up correctly, run:

npm run prepare

Contributing

Feel free to open issues or create pull requests. Make sure to follow the project's coding standards by running lint and format commands before submitting your changes.

License

This project is licensed under the MIT License.