{"id":15434185,"url":"https://github.com/hdorgeval/cucumber6-static-usage","last_synced_at":"2025-07-19T16:11:50.023Z","repository":{"id":87275047,"uuid":"388876036","full_name":"hdorgeval/cucumber6-static-usage","owner":"hdorgeval","description":"Static steps usage reporter for cucumber-js v6","archived":false,"fork":false,"pushed_at":"2021-07-27T20:16:42.000Z","size":190,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-18T08:37:13.623Z","etag":null,"topics":["cucumber","cucumber-js","cucumberjs-v6","custom-formatter","reporter","steps-usage","usage"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hdorgeval.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-23T17:23:03.000Z","updated_at":"2023-03-09T01:12:28.000Z","dependencies_parsed_at":null,"dependency_job_id":"8d1b7864-8aeb-4dcf-9bd0-4bb9231192b3","html_url":"https://github.com/hdorgeval/cucumber6-static-usage","commit_stats":{"total_commits":17,"total_committers":2,"mean_commits":8.5,"dds":0.05882352941176472,"last_synced_commit":"8794a7f72bd1001bd2c6a80a0ee1cf71274e2c2f"},"previous_names":["hdorgeval/cucumber6-usage-formatter"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hdorgeval%2Fcucumber6-static-usage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hdorgeval%2Fcucumber6-static-usage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hdorgeval%2Fcucumber6-static-usage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hdorgeval%2Fcucumber6-static-usage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hdorgeval","download_url":"https://codeload.github.com/hdorgeval/cucumber6-static-usage/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245978277,"owners_count":20703678,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cucumber","cucumber-js","cucumberjs-v6","custom-formatter","reporter","steps-usage","usage"],"created_at":"2024-10-01T18:37:46.507Z","updated_at":"2025-03-28T06:12:25.124Z","avatar_url":"https://github.com/hdorgeval.png","language":"TypeScript","readme":"# cucumber6-static-usage\n\n[![npm version](https://img.shields.io/npm/v/cucumber6-static-usage.svg)](https://www.npmjs.com/package/cucumber6-static-usage)\n\nStatic steps usage reporter for cucumber-js v6.\n\nThis reporter is inspired by the built-in `usage` reporter without limiting the matches to the first five:\nthis reporter gives you the usage for all steps without any limitation, so the generated report might be huge.\n\n## To install this steps usage reporter\n\n- run the command:\n\n  ```sh\n  npm install --save cucumber6-static-usage\n  ```\n\n## Usage\n\n- add to the cucumber-js command-line the following option:\n\n  ```sh\n  --format node_modules/cucumber6-static-usage:steps-usage.txt --dry-run\n  ```\n\nYou should run `cucumber-js` in dry mode, because this reporter does not handle test execution results and durations.\n\n## What it generates\n\nHere is a sample that corresponds to this feature file:\n\n`simple-maths.feature`:\n\n```gherkin\n@foo\nFeature: Simple maths\n  In order to do maths\n  As a developer\n  I want to increment variables\n\nBackground: Calculator\n  Given I have a simple maths calculator\n\nScenario: easy maths\n  Given a variable is set to 11\n  When I increment this variable by 1\n  Then the variable should contain 12\n  When I increment this variable by 2\n  Then the variable should contain 14\n  When I increment this variable by 2\n  Then the variable should contain 16\n\nScenario Outline: much more complex stuff\n  Given a variable is set to \u003cvar\u003e\n  When I increment this variable by \u003cincrement\u003e\n  When I increment this variable by 2\n  Then the variable should contain \u003cresult\u003e\n  Examples:\n    | var | increment | result |\n    | 100 | 5         | 105    |\n    | 99  | 1234      | 1333   |\n    | 12  | 5         | 17     |\n\n```\n\n`steps-usage.txt`:\n\n```txt\n┌────────────────────────────────────────────┬────────┬─────────────────────────────────────────────────┐\n│ Pattern / Text                             │ Usage  │ Location                                        │\n├────────────────────────────────────────────┼────────┼─────────────────────────────────────────────────┤\n│ I have a simple maths calculator           │ -      │ step-definitions/maths/simple-maths-steps.ts:5  │\n│   I have a simple maths calculator         │ -      │ features/simple-maths.feature:8                 │\n├────────────────────────────────────────────┼────────┼─────────────────────────────────────────────────┤\n│ a variable is set to {int}                 │ -      │ step-definitions/maths/simple-maths-steps.ts:9  │\n│   a variable is set to 11                  │ -      │ features/simple-maths.feature:11                │\n│   a variable is set to \u003cvar\u003e               │ -      │ features/simple-maths.feature:20                │\n├────────────────────────────────────────────┼────────┼─────────────────────────────────────────────────┤\n│ I increment this variable by {int}         │ -      │ step-definitions/maths/simple-maths-steps.ts:13 │\n│   I increment this variable by 1           │ -      │ features/simple-maths.feature:12                │\n│   I increment this variable by 2           │ -      │ features/simple-maths.feature:14                │\n│   I increment this variable by 2           │ -      │ features/simple-maths.feature:16                │\n│   I increment this variable by 2           │ -      │ features/simple-maths.feature:22                │\n│   I increment this variable by \u003cincrement\u003e │ -      │ features/simple-maths.feature:21                │\n├────────────────────────────────────────────┼────────┼─────────────────────────────────────────────────┤\n│ I foobar this variable by {int}            │ UNUSED │ step-definitions/maths/simple-maths-steps.ts:17 │\n├────────────────────────────────────────────┼────────┼─────────────────────────────────────────────────┤\n│ the variable should contain {int}          │ -      │ step-definitions/maths/simple-maths-steps.ts:21 │\n│   the variable should contain 12           │ -      │ features/simple-maths.feature:13                │\n│   the variable should contain 14           │ -      │ features/simple-maths.feature:15                │\n│   the variable should contain 16           │ -      │ features/simple-maths.feature:17                │\n│   the variable should contain \u003cresult\u003e     │ -      │ features/simple-maths.feature:23                │\n└────────────────────────────────────────────┴────────┴─────────────────────────────────────────────────┘\n\n```\n\n## Control the size of the first column of the generated report\n\nThe reporter tries to infer a 'best' width for the first column of the report.\n\nIn some cases this value may not fit your needs; you can control the width of the first column by setting the environment variable `STEPS_USAGE_REPORT_FIRST_COL_WIDTH`:\n\n```js\nprocess.env['STEPS_USAGE_REPORT_FIRST_COL_WIDTH'] = 150;\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhdorgeval%2Fcucumber6-static-usage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhdorgeval%2Fcucumber6-static-usage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhdorgeval%2Fcucumber6-static-usage/lists"}