{"id":21877018,"url":"https://github.com/aexol-studio/bddx","last_synced_at":"2025-04-15T02:42:56.652Z","repository":{"id":62997815,"uuid":"561286831","full_name":"aexol-studio/bddx","owner":"aexol-studio","description":"Behavior driven development CLI. Write tests in Gherkin and integrate with Git and JIRA.","archived":false,"fork":false,"pushed_at":"2023-06-21T15:35:43.000Z","size":19034,"stargazers_count":9,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-28T14:37:10.493Z","etag":null,"topics":["bdd","bdd-framework","bdd-tests","cli","tests"],"latest_commit_sha":null,"homepage":"https://www.bddtests.com","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/aexol-studio.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2022-11-03T11:16:59.000Z","updated_at":"2024-02-02T20:36:58.000Z","dependencies_parsed_at":"2024-06-21T13:09:00.445Z","dependency_job_id":null,"html_url":"https://github.com/aexol-studio/bddx","commit_stats":{"total_commits":85,"total_committers":7,"mean_commits":"12.142857142857142","dds":"0.48235294117647054","last_synced_commit":"3adb260fed8f61ab9344b96877196d224de646c5"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aexol-studio%2Fbddx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aexol-studio%2Fbddx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aexol-studio%2Fbddx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aexol-studio%2Fbddx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aexol-studio","download_url":"https://codeload.github.com/aexol-studio/bddx/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248997049,"owners_count":21195785,"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":["bdd","bdd-framework","bdd-tests","cli","tests"],"created_at":"2024-11-28T08:07:45.229Z","updated_at":"2025-04-15T02:42:56.633Z","avatar_url":"https://github.com/aexol-studio.png","language":"TypeScript","readme":"# BDDx [![NPM Version](https://img.shields.io/npm/v/bddx.svg?style=flat)](https://www.npmjs.com/package/bddx) [![NPM Version](https://img.shields.io/github/checks-status/aexol-studio/bddx/main)](https://www.npmjs.com/package/bddx) [![NPM Version](https://img.shields.io/github/last-commit/aexol-studio/bddx)](https://github.com/aexol-studio/bddx)\n\nRun Behavior-Driven Development tests inside a CLI\n\n![Alt Text](packages/bddx-landing/src/components/Site/PresentationOfMDtx.gif)\n\n\n### What is BDDx?\n\n- Write tests in Gherkin, Cucumber's simply structured plain-text language\n- Upload BDD test files in bulk,\n- Run tests to execute them line by line for all your files\n- Get a detailed summary on **what** failed and **why**\n- Failed tests can be made to automatically result in a Jira task or Github issue to automate the fixing process\n\n# Downloads:\n\n## \u003cspan class=\"buttons-wrapper\"\u003e[![GitHub package.json version (subfolder of monorepo)](https://img.shields.io/github/package-json/v/aexol-studio/bddx?color=yellow\u0026filename=%2Fpackages%2Fbddx%2Fpackage.json\u0026label=CLI\u0026style=for-the-badge)](https://github.com/aexol-studio/bddx) [![GitHub package.json version (subfolder of monorepo)](https://img.shields.io/github/package-json/v/aexol-studio/bddx?color=green\u0026filename=%2Fpackages%2Fbddx-core%2Fpackage.json\u0026label=CORE\u0026style=for-the-badge)](https://github.com/aexol-studio/bddx/tree/main/packages/bddx-core)\u003c/span\u003e\n\n\n## CLI commands:\n\n\n### Installation and initialization:\n[**Remember that Node is required**](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)\n| Description | Command |\n| --- | --- |\n| to install BDDx: | `npm i bddx` |\n| to initialize BDDx (with optional Jira integration): | `npx bddx init` |\n| to initialize only BDDx Jira integration without changing the basic configuration: | `npx bddx jiraInit` |\n| to check if the Jira API token is working correctly\u003csup\u003e1\u003c/sup\u003e : | `npx bddx checkToken`\n| to connect to bddx cloud\u003csup\u003e2\u003c/sup\u003e : | `npx bddx cloud`\n\n\u003csup\u003e1\u003c/sup\u003eIf there's a problem with the loop BDDx will ask the user to provide the correct token value.\n\n\u003csup\u003e2\u003c/sup\u003eUser should create project and generate project key \n\n### Config file:\nAfter initializing the config file contains:\n\n```\n{\n  \"in\": \"./bddx/tests\",\n  \"out\": \"./bddx/results\",\n}\n```\n\nor when Jira is integrated:\n\n```\n{\n   \"in\": \"./bddx/tests\",\n   \"out\": \"./bddx/results\",\n    \"organizationName\": \"organizationName.atlassian.net\",\n    \"projectName\": \"ProjectName\",\n    \"issueTypeName\": \"TASK\"\n}\n```\n\n- in: string - input folder with the test files, **(default: \"./bddx/tests\")**\n- out: string - output folder where the test result files are saved, **(default: \"./bddx/results\")**\n\nThe e-mail and Jira API token are saved locally on the machine to ensure safety!\n\n### Running tests\n\n| Description | Command |\n| --- | --- |\n| to run all .feature tests and save results in a file in the output directory: | `npx bddx` |\n| to run all .feature tests and create a task for each failed one on the configured Jira: | `npx bddx jira` |\n| to select an unfinished session and continue the tests from that point (you will also be asked about Jira usage): | `npx bddx continue` |\n| to run all failed .feature tests in selected source and submit results to the bddx cloud: | `npx bddx failedTest` |\n\n\n#### [Readme CORE](https://github.com/aexol-studio/bddx/blob/main/Readme.md)\n\n## Roadmap\n\n- [x] 2 test scenarios: display test \u0026 pass or fail test\n- [x] Jira plugin\n- [ ] GitHub plugin\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faexol-studio%2Fbddx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faexol-studio%2Fbddx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faexol-studio%2Fbddx/lists"}