tout-doux

Tout-Doux 🦄

Tout-Doux (pronounced [təˈdu] - todo ), is a dead simple utility inspired by kotlin TODO. It provides you a function throwing an NotImplementedError when called. Can be useful for many usage (TDD, P.O.C., design, etc...).

Tout doux means 'really soft', 'cute' in french

Install

You know, the classic

yarn add --dev tout-doux

Why --dev ?
Hum, do you really want a production code with todos ???

Usage

import TODO from 'todo';

class Foo {
  doSomething(bar, baz) {
    TODO();
  }
}

const foo = new Foo();
foo.doSomething('bar', 'baz');

This will throw:

NotImplementedError: you need to implement that
    at module.exports (/Users/banst/Documents/github/tout-doux/index.js:4:9)
    at Foo.doSomething (/Users/banst/Documents/github/tout-doux/doctest.js:5:5)
    at Object.<anonymous> (/Users/banst/Documents/github/tout-doux/doctest.js:10:5)
    at Module._compile (module.js:649:30)
    at Object.Module._extensions..js (module.js:660:10)
    at Module.load (module.js:561:32)
    at tryModuleLoad (module.js:501:12)
    at Function.Module._load (module.js:493:3)
    at Function.Module.runMain (module.js:690:10)
    at startup (bootstrap_node.js:194:16)

You can pass a reason that will override the error message:

TODO('because I was lazy 😰');

NotImplementedError: because I was lazy 😰

A bit more

If you need the NotImplementedError you can pull it via:

import NotImplementedError from 'tout-doux/not-implemented-error';

// then
throw new NotImplementedError('reason');

License

MIT