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

@nartallax/clamsensor

v2.1.3

Published

A little testing framework

Downloads

363

Readme

Clam Sensor

A builder-agnostic tool to test Typescript projects.
For those of us who deem Jest needlessly complicated and demanding.

How it works

First, you define tests. Tests are defined in files that ends in .test.ts, as per custom.
Second, you generate test code. Test code contains imports from all .test.ts files to avoid tree-shaking, and code that runs all (or some of) the defined tests.
Third, you build and launch test build. It runs tests you select and gives progress and results in stderr. It also exits with nonzero exit code if testing was not successful.

Usage

Install

npm install --save-dev @nartallax/clamsensor

Define the tests

First step is to define the test cases.

import {describe, test} from "@nartallax/clamsensor";
import {MyCalc} from "appcode/my_calc";

describe("MyCalc", () => {
    test("calculator should sum numbers correctly", () => {
        if(MyCalc.sum(1,2,3) !== 6){
            throw new Error("Something is wrong")
        }
    })
})

It's up to you what assertion library to use. Clamsensor don't have anything built-in for that; the only expectation is that test will throw if something is not right.
Asyncronous tests should return promise.

Generating the code

To generate the code, you should run ./node_modules/.bin/clamsensor_generator.js ./src/test ./generated/test_entrypoint.ts.
If you want to just have a module that imports from all the test modules without running them, you can add --no-run as generator option.

Running the code

Next step is to build your test build using file generated at the previous step as entrypoint. It's up to you how to do that.
Then you can run your build like node ./dist/test_build.js.
If you chose to add code that runs test in generated code (default behaviour), you should also be able to pass an argument (first one in CLI) to filter by test name.
You can also pass --no-stack-trace if you want to only see messages of the errors instead of full stacks.

Naming

Clams are sometimes used as a sensors to control quality of outputted water in some water treatment plants.