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

@jambit/wdio-cucumber-selected-steps-stepdoc

v2.4.0

Published

Cucumber step documentation generator for @jambit/wdio-cucumber-selected-steps

Downloads

3

Readme

Description

This is a tool used to generate markdown documentation for the steps included in the @jambit/wdio-cucumber-selected-steps project. It can be used to generate documentation for your custom steps as well. Since this project uses the nunjucks template language, you can generate documentation in HTML or something completely different if you supply template files.

Prerequisites

This documentation generator expects a couple of things to work properly:

  • Step definitions are separate from their support functions
  • Support functions are written in TypeScript.
  • defineTypedStep is used for all steps to be documented.

I.e. the same conditions as in the @jambit/wdio-cucumber-selected-steps project.

For example:

defineTypedStep(
    /^I enter "([^"]*)" into the prompt$/,
    [
        paramType.string,
    ],
    setPromptText,
);

Creating Documentation

All you need to to:

  • npm i -D @jambit/wdio-cucumber-selected-steps-stepdoc
  • Create a stepdoc.json file next to your package.json (see https://github.com/jambit/wdio-cucumber-selected-steps-demo/ for an example)
  • Run npx stepdoc (or create a script in the package.json)
  • You can even customize the (nunjucks) templates used to generate the documentation by copying them from the template directory.
  • Take a look at src/configTypes.ts to see which options are available.

Creating a Template

This project contains two different markdown templates.. a short one and a detailed one. If you want to write your own, take a look at the ones included and use the src/templateTypes.ts file to see what data is available (TemplateData contains the globally available objects).

Check out the Nunjucks templating documentation as well.

Caveats

You might encounter that there are some limitations where this tool has been tailored to work for the @jambit/wdio-cucumber-selected-steps project.

In that respect there are still possibilities to improve this project and make it more generic. Feel free to create a pull request or open an issue if you encounter issues.

License

Licensed under MIT