debt-collector

A nodejs util to identify, track and mesure technical debt in a project.

Note that debt-collector is an alpha version and you should consider that bugs may occur and API may change without warnings.
As debt-collector is a tool that does not interfere with your code base, even buggy, it is relatively safe to use.
Considering the previous informations, we recomend to install a fixed version of debt-collector as of now.

Developer Documentation

$3

- Node.js >= 18
- pnpm (recommended) or npm
- Git

$3

1. Clone the repository:
``bash
git clone https://github.com/gael-boyenval/debt-collector.git
cd debt-collector
`

2. Install dependencies:
`bash
pnpm install
`

$3

1. Build the project:
`bash
pnpm build
`

2. For development with watch mode:
`bash
pnpm dev
`

$3

The project uses Vitest for testing. Available test commands:

- Run tests once:
`bash
pnpm test
`

- Run tests in watch mode:
`bash
pnpm test:watch
`

- Run tests with coverage:
`bash
pnpm test:coverage
`

$3

To test the CLI locally during development:

1. Link the package globally:
`bash
pnpm link --global
`

2. Now you can use the debt-collector command from anywhere to test your changes.

3. To unlink when you're done:
`bash
pnpm unlink --global
`

$3

`
debt-collector/
├── source/
│ ├── commands/ # CLI commands implementation
│ ├── components/ # React components for CLI UI
│ └── lib/ # Core library functionality
├── docs/ # Documentation
└── tests/ # Test files
`

$3

The project uses:
- ESLint with XO React configuration
- Prettier for code formatting
- TypeScript for type safety

To lint your code:
`bash
pnpm lint
`

$3

To create a production build:
`bash
pnpm build
`

The build output will be in the dist directory.

$3

1. Create a new branch for your feature
2. Make your changes
3. Run tests and linting
4. Submit a pull request

$3

If you encounter any issues:

1. Make sure you're using Node.js >= 18
2. Clear your node_modules and reinstall dependencies:
`bash
rm -rf node_modules
pnpm install
`
3. Check if the package is properly linked if testing locally:
`bash
which debt-collector
``