{"id":20258376,"url":"https://github.com/opentable/grunt-gherkin-report","last_synced_at":"2025-05-07T13:33:57.489Z","repository":{"id":14857084,"uuid":"17580315","full_name":"opentable/grunt-gherkin-report","owner":"opentable","description":"A grunt task that reads a folder of Cucumber/SpecFlow feature files and generates an html report","archived":false,"fork":false,"pushed_at":"2016-02-20T23:03:48.000Z","size":311,"stargazers_count":2,"open_issues_count":1,"forks_count":4,"subscribers_count":26,"default_branch":"master","last_synced_at":"2024-11-01T22:38:48.408Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/opentable.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-MIT","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-03-10T03:10:18.000Z","updated_at":"2019-04-15T10:52:41.000Z","dependencies_parsed_at":"2022-09-05T02:40:09.552Z","dependency_job_id":null,"html_url":"https://github.com/opentable/grunt-gherkin-report","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opentable%2Fgrunt-gherkin-report","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opentable%2Fgrunt-gherkin-report/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opentable%2Fgrunt-gherkin-report/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opentable%2Fgrunt-gherkin-report/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opentable","download_url":"https://codeload.github.com/opentable/grunt-gherkin-report/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224608971,"owners_count":17339785,"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":[],"created_at":"2024-11-14T11:08:34.004Z","updated_at":"2024-11-14T11:08:34.600Z","avatar_url":"https://github.com/opentable.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# grunt-gherkin-report\n\n\u003e It saves your gherkin features (generated by Cucumber, SpecFlow, Cucumber.js...) in a friendly html format\n\nNode version: **0.8.0** required\n\nBuild status: [![Build Status](https://secure.travis-ci.org/opentable/logstash-redis.png?branch=master)](http://travis-ci.org/opentable/grunt-gherkin-report)\n\n[![NPM](https://nodei.co/npm/grunt-gherkin-report.png?downloads=true)](https://npmjs.org/package/grunt-gherkin-report)\n\n## Getting Started\nThis plugin requires Grunt `~0.4.2`\n\nIf you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:\n\n```shell\nnpm install grunt-gherkin-report --save-dev\n```\n\nOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:\n\n```js\ngrunt.loadNpmTasks('grunt-gherkin-report');\n```\n\n## The \"gherkin_report\" task\n\n### Overview\nIn your project's Gruntfile, add a section named `gherkin_report` to the data object passed into `grunt.initConfig()`.\n\n```js\ngrunt.initConfig({\n  gherkin_report: {\n    my_project: {\n      // Target-specific file lists and/or options go here.\n      options: {\n        title: 'My project\\'s features',\n        subtitle: 'Generated on ' + (new Date()).toISOString() + ', version: ' + grunt.option('versionNumber') || 'unknown',\n        destination: 'path-to-output/report.html'\n      },\n      files: [{\n        cwd: 'path/to/my/features',\n        src: ['**/*.feature']\n      }]\n    },\n  },\n});\n```\n\n### Options\n\n#### options.title\nType: `String`\n\nThe title of your report.\n\n#### options.subtitle\nType: `String`\n\nA string that is saved during the generation and placed on the top of the generated document. Cool to place a date and a version here. Look at the example.\n\n#### options.destination\nType: `String`\n\nThe destination of your html report and its filename.\n\n#### files\nType: `Object`\n\nThe features to import.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopentable%2Fgrunt-gherkin-report","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopentable%2Fgrunt-gherkin-report","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopentable%2Fgrunt-gherkin-report/lists"}