🚀 Unit testing made simple and fun: flat colors and emoji in your tests.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
example
lib
test
.gitignore
CONTRIBUTING.md
DOCUMENTATION.md
LICENSE
README.md
package.json

README.md

tester

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads

Unit testing made simple and fun: flat colors and emoji in your tests.

⭐️ Features

  • It does not create any globals.
  • Writing messages in custom streams (by default in process.stdout).
  • Easy interface for handling sync and async stuff.
  • Emoji & Flat colors 🎨
  • Just run the test file using node

Tip 💡

Use the tester-init to init the test file.

tester

☁️ Installation

# Using npm
npm install --save tester

# Using yarn
yarn add tester

After installing the package, you just need to set up a test file where you require the tester package. Your package.json will look like this:

{
  "name": "tester",
  ...
  "scripts": {
    "test": "node test/your-test-file.js"
  },
  ...
  "devDependencies": {
    "tester": "^1.0.0"
  }
}

test/your-test-file.js will contain your tests, like documented below.

📋 Example

const tester = require("tester");

// Use describe to group the tests
tester.describe("Running some example tests", example => {

    // Without a callback (the code will be executed syncronously)
    example.should("be able to make simple checks using expect", () => {
        example.expect(true).toBe(true);
    });

    // Async function which will fail
    example.should("support async functions", (cb) => {
        setTimeout(function() {
            example.expect(true).toBe(false);
            cb();
        }, 100);
    });

    // Wait a second and pass
    example.it("wait a second", (cb) => {
        setTimeout(function() {
            example.expect(true).toBe(true);
            cb();
        }, 1000);
    });
});

tester.describe("Running another set of tests", another => {
    another.it("some test", () => {
        another.expect(true).toBe(true);
    });
});

Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.

  2. For bug reports and feature requests, open issues. 🐛

  3. For direct and quick help, you can use Codementor. 🚀

📝 Documentation

Describe(message, fn)

Creates a new Describe instance.

To change the default configuration, you can override the tester fields:

let tester = require("tester")

Colors

tester uses color-it to color the messages. You can use any available color name (defaults are listed):

  • colors (Object):
    • it (Object)
      • success: "green"
      • error: "red"
    • describe: "yellow"

For example, to have blue describe messages, you will do: tester.colors.describe = "blue".

Icons

tester uses emoji provided by emojic:

  • icons
    • it
      • success: "zap"
      • error: "x"
    • describe: "arrowRight"

Indent

tester uses indento to indent the strings:

  • indent
    • it: 5
    • describe: 2

Loggers

You can override any of the following fields

  • loggers
    • stream: The stream where the messages will be written (default: process.stdout).
    • it (err, itMessage, icon)
    • describe (message)

Params

  • String message: The Describe message.
  • Function fn: The callback function.

run(fn)

Runs the tests from this group.

Params

  • Function fn: The callback function.

expect()

This is a wrapper around the expect package.

Return

  • Expect The Expect result.

it(what, fn)

Adds a new test in the describe queue.

Params

  • String what: The test message.
  • Function fn: The callback function.

should(what, fn)

Adds a new test in the describe queue prefixing the message with should.

Params

  • String what: The test message.
  • Function fn: The callback function.

describe(what, fn)

Groups more tests together.

Params

  • String what: The describe message.
  • Function fn: The callback function.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like 🚀

  • Buy me a book—I love books! I will remember you after years if you buy me one. 😁 📖

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

  • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

  • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! ❤️

📜 License

MIT © Ionică Bizău