Dependabit Setup Guide

This guide describes how to set up and maintain the dependabit project.

Prerequisites

• Node.js >= 20.0.0
• pnpm >= 10.0.0

Initial Setup

1. Clone the repository:

   git clone https://github.com/pradeepmouli/dependabit.git
   cd dependabit

2. Install dependencies:

   pnpm install

3. Build all packages:

   pnpm run build

Local Development

Running Development Mode

Start all packages in development mode:

pnpm run dev

Testing

Run tests across all packages:

pnpm test

Run tests with coverage:

pnpm run test:coverage

Run tests in watch mode:

pnpm run test:watch

Linting and Formatting

Check code quality:

pnpm run lint

Fix linting issues:

pnpm run lint:fix

Format code:

pnpm run format

Check formatting:

pnpm run format:check

Type Checking

Run TypeScript type checking:

pnpm run type-check

Package Management

Adding a New Package

1. Create a new directory under packages/:

   mkdir packages/my-package

2. Initialize with package.json following the existing structure (see other packages as examples)

3. Add to the monorepo by ensuring it's in the workspace (already configured via packages/*)

Building Packages

Build all packages:

pnpm run build

Build a specific package:

cd packages/my-package
pnpm run build

Cleaning

Clean build artifacts:

pnpm run clean

Clean everything including node_modules:

pnpm run clean:all

Fresh reinstall:

pnpm run fresh

Git Hooks

This project uses simple-git-hooks and lint-staged to run checks before commits. Hooks are automatically installed when you run pnpm install.

Troubleshooting

Build Errors

1. Try cleaning and rebuilding:

   pnpm run clean
   pnpm run build

2. If issues persist, do a fresh install:

   pnpm run fresh

Test Failures

Ensure all packages are built:

pnpm run build

Then run tests:

pnpm test

Linting Issues

Auto-fix issues where possible:

pnpm run lint:fix
pnpm run format