{"id":40789,"library":"cucumber-pretty","title":"cucumber-pretty","description":"This package provides a custom pretty formatter for Cucumber.js versions 3 to 6, using the event protocol. It is deprecated in favor of @cucumber/pretty-formatter for Cucumber.js v7+. The last stable version is 6.0.1, which supports Cucumber.js v6. It requires explicit path usage in the CLI and has no breaking changes within its supported range. The key differentiator is its compatibility with older Cucumber.js versions while offering a visually enhanced output compared to the built-in formatters.","status":"deprecated","version":"6.0.1","language":"javascript","source_language":"en","source_url":"https://github.com/kozhevnikov/cucumber-pretty","tags":["javascript"],"install":[{"cmd":"npm install cucumber-pretty","lang":"bash","label":"npm"},{"cmd":"yarn add cucumber-pretty","lang":"bash","label":"yarn"},{"cmd":"pnpm add cucumber-pretty","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Peer dependency: requires cucumber >=6.0.0 <7.0.0","package":"cucumber","optional":true}],"imports":[{"note":"For Cucumber.js v6, you must specify the full path to the formatter module. The -f pretty alias is only for built-in formatters.","wrong":"cucumber-js -f pretty","symbol":"default formatter","correct":"cucumber-js -f node_modules/cucumber-pretty"},{"note":"This package uses CommonJS. ESM import is not supported and will fail.","wrong":"import prettyFormatter from 'cucumber-pretty';","symbol":"programmatic usage","correct":"const prettyFormatter = require('cucumber-pretty');"},{"note":"The formatter must be referenced by its file path, not just by package name.","wrong":"\"format\": [\"cucumber-pretty\"]","symbol":"formatter in configuration","correct":"\"format\": [\"node_modules/cucumber-pretty\"]"}],"quickstart":{"code":"// Install the formatter and Cucumber.js v6\n// npm install cucumber@6 cucumber-pretty@6\n\n// Create a simple feature file: features/example.feature\n// Feature: Example\n//   Scenario: Passing\n//     Given a step\n\n// Run with the formatter:\n// npx cucumber-js features/example.feature -f node_modules/cucumber-pretty\n\n// Output will be a colorful, indented representation of the test run.\n","lang":"javascript","description":"This example shows how to install and use cucumber-pretty with Cucumber.js v6 from the command line, including the required formatter path."},"warnings":[{"fix":"npm install @cucumber/pretty-formatter and use -f @cucumber/pretty-formatter","message":"cucumber-pretty is deprecated for Cucumber.js v7+. Use @cucumber/pretty-formatter instead.","severity":"deprecated","affected_versions":">=7.0"},{"fix":"Downgrade or upgrade cucumber to v6, or use the appropriate formatter for your version (cucumber-pretty@1.5 for v3-v5, @cucumber/pretty-formatter for v7+).","message":"Requires exact peer dependency: cucumber >=6.0.0 <7.0.0. Will not work with Cucumber.js v7 or v5.","severity":"breaking","affected_versions":">=6.0.0 <7.0.0"},{"fix":"Use -f node_modules/cucumber-pretty or configure in cucumber.js file with format: ['node_modules/cucumber-pretty'].","message":"The CLI argument must be the full path 'node_modules/cucumber-pretty'. Using '-f pretty' without installation causes a 'formatter not found' error.","severity":"gotcha","affected_versions":">=6.0"}],"env_vars":null,"search_vec":"'3':14 '6':16 '6.0.1':36 'break':52 'built':78 'built-in':77 'chang':53 'cli':48 'compar':74 'compat':63 'cucumb':2 'cucumber-pretti':1 'cucumber.js':12,29,39,66 'cucumber/pretty-formatter':27 'custom':8 'deprec':23 'differenti':60 'enhanc':72 'event':19 'explicit':43 'favor':25 'formatt':10,80 'javascript':81 'key':59 'last':32 'offer':69 'older':65 'output':73 'packag':5 'path':44 'pretti':3,9 'protocol':20 'provid':6 'rang':57 'requir':42 'stabl':33 'support':38,56 'usag':45 'use':17 'v6':40 'v7':30 'version':13,34,67 'visual':71 'within':54","created_at":"2026-06-04T18:49:16.694949+00:00","updated_at":"2026-06-04T18:49:16.694949+00:00","problems":[{"fix":"Use -f node_modules/cucumber-pretty instead of -f pretty.","cause":"Using -f pretty with cucumber-pretty installed, but for Cucumber.js v6 the formatter must be referenced by path.","error":"Formatter 'pretty' not found"},{"fix":"Run 'npm install cucumber-pretty@6' with Cucumber.js v6 installed, or for v3-v5 use 'npm install cucumber-pretty@1.5'.","cause":"Package not installed or wrong version of Cucumber.js.","error":"Cannot find module 'cucumber-pretty'"},{"fix":"Either downgrade Cucumber.js to v6, or use the appropriate formatter: @cucumber/pretty-formatter for v7, cucumber-pretty@1.5 for v3-v5.","cause":"Using Cucumber.js v7 or v5 with cucumber-pretty v6.","error":"Error: Unsupported Cucumber version. cucumber-pretty requires Cucumber >=6.0.0 <7.0.0"}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://github.com/kozhevnikov/cucumber-pretty#readme","github":"https://github.com/kozhevnikov/cucumber-pretty","docs":null,"changelog":null,"pypi":null,"npm":"cucumber-pretty","openapi_spec":null,"status_page":null,"smithery":null,"categories":["testing"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-04","next_check":"2026-09-02","install_tag":null}}