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

@pleasure-js/docs

v1.2.2-beta

Published

Better docs for software dev

Downloads

7

Readme

Parses .feature files

Having a JSON object parsed per test is useful in order to output it to any other desired format.

// > @source 'Given the tests in `./benchmark/sample.test.js` './benchmark/sample.test.js'
const { feature } = await parseFeatureFile(sampleFeature)
t.true(typeof feature === 'object')
t.true(feature.hasOwnProperty('children'))
t.true(feature.children.length > 0)

Converts .feature files into markdown

Given a .feature file, we must be able to parse it into a markdown string.

To do so, we have to convert the .feature file into a CucumberFeature by using the parseFeatureFile method.

const feature = await parseFeatureFile(fromTestDirectory('./benchmark/sample-feature.feature'))
t.is(cucumberFeatureToMd(feature), mdBenchmark)

{{source mdBenchmark './benchmark/sample.test.md'}}

Parses AVA files

Having a object parsed per test is useful in order to output it to any other desired format.

// > @source 'Given the tests in `./benchmark/sample.test.js` './benchmark/sample.test.js'
const arrayOfTests = await parseAvaFile(fromTestDirectory('./benchmark/sample.test.js'))

// returned object is an array of tests
t.true(Array.isArray(arrayOfTests))
t.is(arrayOfTests.length, 3)

const firstAvaTest = arrayOfTests[0]

t.true(typeof firstAvaTest === 'object')
t.is(firstAvaTest.title, `Parses ava test\`s files`)
t.is(firstAvaTest.description, 'I want to be able to parse test files to improve my software development experience')
t.is(firstAvaTest.code, '// some code\nt.pass()')

t.deepEqual(require(fromTestDirectory('./benchmark/sample.test.json')), arrayOfTests)

Converts AVA tests into markdown

Having a object parsed per test is useful in order easily to output it to any other desired format.

{{source 'Given the tests in ./benchmark/sample.test.js' './benchmark/sample.test.js'}}

const arrayOfTests = await parseAvaFile(fromTestDirectory('./benchmark/sample.test.js'))
t.is(avaTestsToMd(arrayOfTests), sampleAvaTestMdBenchmark)