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

@javarome/testscript

v0.13.1

Published

Simple, straightforward TypeScript test solution

Downloads

21

Readme

testscript

Tired of finding the right configuration to make Node + Common JS, ESM, Babel, Jest and TypeScript work together?
Fed up of understanding why the configuration that used to work is not working anymore?
Just want to run tests of your code, period?

The alternative is here, as follows:

  • Run all TypeScript stuff using tsx as a drop-in replacement for the node command. It just works with TypeScript, and it's fast.
  • A test is an autonomous executable: you don't need a test runner to run a single test file. Instead, just execute the test file:
    tsx src/My.test.ts
    Thanks to Node's assert() predicates, this will throw a TestError if the test doesn't pass (this can also work with a tsx alternative as well, but tsx makes it easier).
  • Keep syntax as similar as possible to the syntax used by Jest (describe(), test(), expect(), beforeEach()...) , which is the most popular framework to test JS/TS.
// MyTest.ts
import { describe, expect, test } from '@javarome/testscript';

describe("Some software item", () => {

  test("does something", async () => {
    const item = new SoftwareItem('item1')
    expect(item.name).toBe("item1")
    expect(item.name).not.toBe("item2")
  })
})
  • The only remaining thing you need is a TestRunner to locate tests and execute them at once. One can be run using this command:
testscript

(make sure to install tsx before)

This will output: Test runner failure output And an error will output as:

Test runner failure output

Of course this is typically what you want to run for your test npm script.

By default, it will look for all *.test.ts files in all subdirs, but you can specifiy a different file pattern, like:

testscript --include **/*.spec.ts

By default node_modules is ignored. You can also customize those excluded paths by specifying a second argument, which can be an array of paths:

testscript --include **/*.test.ts --exclude '{out/**,node_modules/**/*.*}'

You can also use the TESTSCRIPT_INCLUDE and TESTSCRIPT_EXCLUDE env vars.

Assertions

The same assertions as found in Jest can be used:

  • x.toBe(y) for == approximate comparison (string as number, nullish as other nullish, fasly as other falsy, etc.)
  • x.toEqual(y) for strict ===. Here the above comparisons will fail.
  • call.toThrow(errMsg) etc.

You can also insert the not operator, like in x.not.toBe(y)

Lifecycle

The same callbacks can be used, like beforeEach(), etc.

Options

A test can be skipped by setting the skip property in an option object before the test function parameter:

test("skipped test", {skip: true}, async () => {
  expect("not tested").toBe(true) // Will not be executed
})

Reporting

By default, the LogTestReporter is used. See bin/index.ts to see how you could provide your own implementation of a TestReporter.

Debugging

Once you have your test scripts ready in your package.json, all you need to need all or one test is to set your breakpoints in your tests and run those scripts in debug mode.

Also note that the TestRunner uses a DefaultLogger instance as a Logger, which can be specified as its third constructor argument. You can also set the LOGLEVEL env var to include debug.