https://github.com/phenomnomnominal/icky

Simple tool for tracking ickiness in a codebase
https://github.com/phenomnomnominal/icky

Last synced: 7 months ago
JSON representation

Simple tool for tracking ickiness in a codebase

• Host: GitHub
• URL: https://github.com/phenomnomnominal/icky
• Owner: phenomnomnominal
• License: mit
• Created: 2019-12-11T22:30:21.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T02:49:42.000Z (about 3 years ago)
• Last Synced: 2025-03-02T06:17:42.034Z (10 months ago)
• Language: TypeScript
• Size: 1.27 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![icky](https://github.com/phenomnomnominal/icky/blob/master/docs/logo.png)](https://github.com/phenomnomnominal/icky/)

[![npm version](https://img.shields.io/npm/v/icky.svg)](https://www.npmjs.com/package/icky)

**`ICKY`** is a super simple way to track ickiness in your codebase!

Just pick a string that you want to use to indicate ickiness (defaults to **`ICKY`**), and add it whenever you see something you don't like in your codebase, but can't fix it right now!

Add extra "!" for more ickiness!

## Set up:

```bash

npm install icky --save-dev

```

## Run:

```js

// src/add.js

function add(a, b) {

  // ICKY

  return a + b + 0;

}

```

```html

  


    

    


    

    


  


```

```bash

icky # Total ickiness: 11

```

### Options

| Name                  | Description                                  | Default      |

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

| `--files="[value]"`   | Glob pattern for the files you want to check | `./src/**/*` |

| `--pattern="[value]"` | String that you use to indicate ickiness!    | `ICKY`       |