Gathering detailed insights and metrics for @jambit/wdio-cucumber-selected-steps-stepdoc
Gathering detailed insights and metrics for @jambit/wdio-cucumber-selected-steps-stepdoc
Common steps for writing cucumber feature files with webdriver.io
Installations
npm install @jambit/wdio-cucumber-selected-steps-stepdocDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
14.16.1
NPM Version
lerna/4.0.0/node@v14.16.1+x64 (linux)
Releases
Unable to fetch releases
Languages
2
TypeScript
JavaScript
TypeScript (91.19%)
JavaScript (8.81%)
Developer
jambit
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
13 Stars
66 Commits
4 Watchers
14 Branches
1 Contributors
Updated on Dec 28, 2021
Maintainers
2
Package Meta Information
Latest Version
2.4.0
Package Id
@jambit/wdio-cucumber-selected-steps-stepdoc@2.4.0
Unpacked Size
12.24 kB
Size
4.70 kB
File Count
6
NPM Version
lerna/4.0.0/node@v14.16.1+x64 (linux)
Node Version
14.16.1
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
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:
1defineTypedStep( 2 /^I enter "([^"]*)" into the prompt$/, 3 [ 4 paramType.string, 5 ], 6 setPromptText, 7);
Creating Documentation
All you need to to:
npm i -D @jambit/wdio-cucumber-selected-steps-stepdoc- Create a
stepdoc.jsonfile 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
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
Found 0/24 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 6 are checked with a SAST tool
Reason
51 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
- Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
- Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
- Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-wg6g-ppvx-927h
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
- Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
- Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-gmwp-3pwc-3j3g
- Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
- Warn: Project is vulnerable to: GHSA-x77j-w7wf-fjmw
- Warn: Project is vulnerable to: GHSA-3j8f-xvm3-ffx4
- Warn: Project is vulnerable to: GHSA-4p35-cfcx-8653
- Warn: Project is vulnerable to: GHSA-7f3x-x4pr-wqhj
- Warn: Project is vulnerable to: GHSA-jpp7-7chh-cf67
- Warn: Project is vulnerable to: GHSA-q6wq-5p59-983w
- Warn: Project is vulnerable to: GHSA-j9fq-vwqv-2fm2
- Warn: Project is vulnerable to: GHSA-pqw5-jmp5-px4v
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-pq67-2wwv-3xjx
- Warn: Project is vulnerable to: GHSA-8cj5-5rvv-wf4v
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3
- Warn: Project is vulnerable to: GHSA-g3ch-rx76-35fx
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
1.7
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More