{"id":14969252,"url":"https://github.com/cucumber/gherkin-streams","last_synced_at":"2025-10-19T09:32:24.347Z","repository":{"id":37018348,"uuid":"464962284","full_name":"cucumber/gherkin-streams","owner":"cucumber","description":"Stream utilities to read Gherkin parser output.","archived":false,"fork":false,"pushed_at":"2024-04-10T18:49:44.000Z","size":675,"stargazers_count":2,"open_issues_count":2,"forks_count":1,"subscribers_count":74,"default_branch":"main","last_synced_at":"2024-04-14T13:08:33.622Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://cucumber.io/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cucumber.png","metadata":{"funding":{"open_collective":"cucumber"},"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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}},"created_at":"2022-03-01T16:03:26.000Z","updated_at":"2023-07-26T07:47:29.000Z","dependencies_parsed_at":"2023-12-22T09:03:04.013Z","dependency_job_id":"1069fe2e-5a8f-4173-bc0c-1bcbb00572a8","html_url":"https://github.com/cucumber/gherkin-streams","commit_stats":{"total_commits":373,"total_committers":11,"mean_commits":33.90909090909091,"dds":0.4745308310991957,"last_synced_commit":"4e9713b087e1af761d644e5978d15fcf0a73dfa7"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cucumber%2Fgherkin-streams","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cucumber%2Fgherkin-streams/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cucumber%2Fgherkin-streams/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cucumber%2Fgherkin-streams/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cucumber","download_url":"https://codeload.github.com/cucumber/gherkin-streams/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219869479,"owners_count":16555292,"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-09-24T13:41:26.486Z","updated_at":"2025-10-19T09:32:23.940Z","avatar_url":"https://github.com/cucumber.png","language":"TypeScript","funding_links":["https://opencollective.com/cucumber"],"categories":[],"sub_categories":[],"readme":"# Gherkin Streams\n\nThis module contains utilities to use the Gherkin library with streams.\n\n## Installation\n\n`gherkin-streams` has 3 peer dependencies: `@cucumber/gherkin`, `@cucumber/messages`\nand `@cucumber/message-streams`.\n\nYou need to have `@cucumber/gherkin` and`@cucumber/message-streams` in your dependencies,\n`@cucumber/messages` is actually installed automatically with `@cucumber/gherkin`.\n\n    npm install @cucumber/gherkin-streams @cucumber/gherkin @cucumber/message-streams\n\n## Usage\n\n```javascript\nconst { GherkinStreams } = require('@cucumber/gherkin-streams')\n\nconst options = {\n  includeSource: true,\n  includeGherkinDocument: true,\n  includePickles: true,\n}\nconst stream = GherkinStreams.fromPaths(['features/hello.feature'])\n\n// Pipe the stream to another stream that can read messages.\nstream.pipe(...)\n```\n\n### Shortening URIs with `relativeTo`\n\nYou can include `relativeTo` option to avoid emitting longer or absolute URIs, instead making them only relative to the current working directory (or whatever makes sense for your use case):\n\n```javascript\nconst { GherkinStreams } = require('@cucumber/gherkin-streams')\n\n// imagine `discoverPaths()` is a function that returns absolute paths\nconst paths = discoverPaths();\nconst options = {\n  includeSource: true,\n  includeGherkinDocument: true,\n  includePickles: true,\n  relativeTo: process.cwd()\n}\nconst stream = GherkinStreams.fromPaths(paths)\n\n// Pipe the stream to another stream that can read messages.\nstream.pipe(...)\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcucumber%2Fgherkin-streams","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcucumber%2Fgherkin-streams","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcucumber%2Fgherkin-streams/lists"}