npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ts-nanotest

v0.2.4

Published

Bare-bones Typescript test runner

Downloads

4

Readme

TS Nanotest

npm version CI

Bare-bones Typescript test runner. No bells and whistles. Zero-config.

Installation

Install via NPM:

$ npm install --save-dev ts-nanotest

Use it in the test script:

// package.json

{
  // ...
  "scripts": {
    // ...
    "test": "ts-nanotest **/*.test.ts"
  }
}

You can drop **/*.test.ts as it is assumed by default.

Usage

Create a test class as follows:

// cook.test.ts

import { TestCase, TestSuite } from 'ts-nanotest';
import assert from 'assert';

export default class CookTest extends TestSuite {
  override tests(): TestCase[] {
    return [
      this.test('should cook lunch with low calories', () => {
        const lunch = cookLunch();
        assert.equal(lunch.calories, 'low');
      }),
    ];
  }
}

Nanotest does not use global definitions (such as describe and it). No assertion helpers either. assert almost always suffices. You can still use assertion libraries with Nanotest.

Run the tests via NPM script:

$ npm test

... or directly (needs global installation: npm install --global ts-nanotest):

$ ts-nanotest <glob-pattern>...

Hooks

TestSuite contains the following overrideable hooks:

  • beforeAll
  • afterAll
  • beforeEach
  • afterEach

All hooks can be async. The after-hooks are always called, even if the test failed.

Example

import { TestCase, TestSuite } from 'ts-nanotest';
import assert from 'assert';

export default class AdvancedCookTest extends TestSuite {
  override async beforeAll() {
    await turnOnTheStove();
  }

  override afterAll() {
    turnOffTheStove();
  }

  override async beforeEach() {
    await buyComponents();
  }

  override afterEach() {
    washTheDishes();
  }

  override tests(): TestCase[] {
    return [
      this.test('should cook a delicious dinner', () => {
        const dinner = cookDinner();
        assert.equals(dinner.salt, 'perfect');
      }),

      this.test('should reject bad taste', async () => {
        const badDish = cookSomethingBad();
        await assert.rejects(async () => {
          await judge.taste(badDish);
        }, BadTasteError);
      }),
    ];
  }
}

Skipping tests

Sometimes you need to temporarily skip some tests during active development. To do so, use this.skip() instead of this.test().

Why

Testing should be fast, easy, light, and manageable. These characteristics are especially important if you are practising test-driven development (TDD).

Fast. Most projects should have all their tests run in a few seconds.

Easy. Writing tests should be as easy as writing production code. No learning curve.

Light. Test packages (not the tests themselves) should have almost no effect on the size of a project.

Manageable. Test packages should interface with but be isolated from the production environment.

To achieve this, Nanotest includes only the bare minimum.