https://github.com/oknozor/todo-or-boom

A Todo and Fixme linter
https://github.com/oknozor/todo-or-boom

Last synced: 2 months ago
JSON representation

A Todo and Fixme linter

• Host: GitHub
• URL: https://github.com/oknozor/todo-or-boom
• Owner: oknozor
• License: mit
• Created: 2023-11-29T09:00:42.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-22T10:12:45.000Z (about 1 year ago)
• Last Synced: 2025-02-28T15:28:37.484Z (2 months ago)
• Language: Rust
• Size: 378 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  





  

  

  


  

  





ToB is todos and fixme linter. You most likely want to automate its usage using it either in a git commit hook 

or in your CI/CD pipeline. 

| ![example screenshot ok](docs/todo_ok.png) | ![example screenshot err](docs/todo_err.png) |

|-------------------------------------|-------------------------------------|

## Warning

⚠️ ToB is still a work in progress, currently only C-style comments are implemented, ToB will work with language like java, rust, c etc. ⚠️

## Usage

see: `todo-or-boom --help`

### Command line

```shell

todo-or-boom -g "*.rs"

todo-or-boom -g "*.java"

```

### Pre-commit git-hook

```shell

#!/bin/sh

set -e

todo-or-boom -g "**/*.rs"

```