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

doctests-via-ava

v0.0.11

Published

doctests for javascript and typescript

Downloads

19

Readme

doctests-via-ava

doctests (via ava) for javascript and typescript

Installing

npm install doctests-via-ava -D or yarn add doctests-via-ava -D

make sure you have ava installed as well:

npm install ava -D or yarn add ava -D

Usage

Write your comments in normal JS Doc format, but instead of using @example use @doctest or @doctests (either/or), followed by a JS code block of your ava test, EG:

/**
 * sums two numbers
 *
 * @doctests
 * ```js
 * t.is(sum(1, 2), 3)
 * t.is(sum(4, 4), 8)
 * ```
 */
export const sum = (a: number, b: number): number => {
  return a + b;
};

Next, add a script in your package.json:

  "scripts": {
    "doctest": "doctests-via-ava \"./dist/src/**/*.js\" && ava test ./doctests/*.js"
   }

Running yarn doctest (or the npm equivalent) will transform your doctests into regular ava tests, and then run them. Up to you whether to add doctests to .gitignore or not.

We utilize the excellent fast-glob library to find files w/ doctests. What you pass into doctests-via-ava gets directly passed to fast-glob. Be sure to wrap your glob in quotes (eg doctests-via-ava "./src/*.js"), since unix will turn certain globs into a list of files, which the cli does not expect.

All this lib does is transform your doctests into regular ava tests. As such, it can only doctest exported functions (since it needs to import them from the original source). It's also your responsibility to install ava.

For example, the above sum function would compile down to the ava test of:

import test from "ava";
import { sum } from "../dist/src/sum.js";

test("sum", (t) => {
  t.is(sum(1, 2), 3);
  t.is(sum(4, 4), 8);
});

@doctest_only

Use @doctest_only or @doctests_only to only create/run a specific group of doctests.

TypeScript

If you're compiling your TS yourself, simply point the doctests-via-ava CLI command at TS's outDir (see above).

If you're using something like create-react-app that's compiling your TS for you, first follow AVA's instructions for setting up ts-node.

Then, pass in the --ts flag to the doctests-via-ava cli command:

doctests-via-ava "./src/**/*.ts" --ts && ava test ./doctests/*.ts

One gotcha is that ts-node wants you to add a .js ending to your imports, eg import sortBy from 'lodash/sortBy.js'; - which CRA doesn't require (but is harmless to add), so you might see a ERR_MODULE_NOT_FOUND error if missing that in your files with doctests.

Stage of development

This lib is very new, probably buggy, and only really handles the happy path. This will improve over time.

NPM link: https://www.npmjs.com/package/doctests-via-ava

License

MIT