phenomnomnominal / icky

Simple tool for tracking ickiness in a codebase

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

icky

npm version

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:

npm install icky --save-dev

Run:

// src/add.js
function add(a, b) {
  // ICKY
  return a + b + 0;
}
<!-- src/index.html -->
<html>
  <div>
    <!-- ICKY!!!! -->
    <div class="button"></div>
    <!-- ICKY!!!! -->
    <div class="button"></div>
  </div>
</html>
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

About

Simple tool for tracking ickiness in a codebase

License:MIT License


Languages

Language:TypeScript 84.5%Language:JavaScript 15.2%Language:HTML 0.2%