{"id":20883963,"url":"https://github.com/getgauge/gauge-vscode","last_synced_at":"2025-04-07T17:09:43.605Z","repository":{"id":24606113,"uuid":"97581585","full_name":"getgauge/gauge-vscode","owner":"getgauge","description":"A Visual Studio Code plug-in for Gauge","archived":false,"fork":false,"pushed_at":"2025-03-27T18:14:55.000Z","size":66602,"stargazers_count":51,"open_issues_count":19,"forks_count":19,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-03-31T14:15:19.671Z","etag":null,"topics":["agile","bdd","gauge","gauge-plugin","gauge-vscode","languageserver","testing","visual-studio-code"],"latest_commit_sha":null,"homepage":"https://gauge.org","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/getgauge.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2017-07-18T09:45:10.000Z","updated_at":"2025-03-26T16:01:51.000Z","dependencies_parsed_at":"2022-08-07T11:01:12.109Z","dependency_job_id":"5215222d-12a7-4fda-979c-ea25ab4c1692","html_url":"https://github.com/getgauge/gauge-vscode","commit_stats":{"total_commits":645,"total_committers":22,"mean_commits":"29.318181818181817","dds":0.7782945736434108,"last_synced_commit":"3869780ee5ce1f701523a4148953722871ef6693"},"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getgauge%2Fgauge-vscode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getgauge%2Fgauge-vscode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getgauge%2Fgauge-vscode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getgauge%2Fgauge-vscode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/getgauge","download_url":"https://codeload.github.com/getgauge/gauge-vscode/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247694876,"owners_count":20980733,"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":["agile","bdd","gauge","gauge-plugin","gauge-vscode","languageserver","testing","visual-studio-code"],"created_at":"2024-11-18T08:08:36.343Z","updated_at":"2025-04-07T17:09:43.584Z","avatar_url":"https://github.com/getgauge.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Gauge extension for [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=getgauge.gauge)\n\n# Install\n\n```\n$ code --install-extension getgauge.gauge\n```\n*Other Install [options](#install-from-source)*\n\n\n# Features\n\n* [Create New Project](#create-new-project)\n* [Code Completion](#code-completion)\n* [Goto Definition](#goto-definition)\n* [Diagnostics](#diagnostics)\n* [Format Specifications](#format-specifications)\n* [References](#references)\n* [Symbols](#symbols)\n* [Run Specs/Scenarios](#run-specifications-and-scenarios)\n* [Debug Specs/Scenarios](#debug-specifications-and-scenarios)\n* [Reports](#reports)\n* [Test Explorer](#test-explorer)\n* [Code Snippets](#snippets-for-specification-scenarios-and-tables)\n\nGauge langauge plugins supported by the Gauge Visual Studio Code plugin are:\n* [gauge-js](https://github.com/getgauge/gauge-js)\n* [gauge-java](https://github.com/getgauge/gauge-java)\n* [gauge-dotnet](https://github.com/getgauge/gauge-dotnet)\n* [gauge-python](https://github.com/getgauge/gauge-python)\n* [gauge-ruby](https://github.com/getgauge/gauge-ruby)\n\n## Create new project\n\nExecute the Command `Gauge: Create new Gauge Project` and select the appropriate template to create a new Gauge Project\n\n\u003cimg src=\"https://github.com/getgauge/gauge-vscode/raw/master/images/newProj.jpg\" alt=\"Create New Project preview\" style=\"width: 600px;\"/\u003e\n\n## Code Completion\n\u003cimg src=\"https://github.com/getgauge/gauge-vscode/raw/master/images/autocomplete.jpg\" alt=\"Code Completion preview\" style=\"width: 600px;\"/\u003e\n\n## Goto Definition\n\u003cimg src=\"https://github.com/getgauge/gauge-vscode/raw/master/images/gotoDefinition.jpg\" alt=\"Goto Definition preview\" style=\"width: 600px;\"/\u003e\n\n## Diagnostics\n\n\u003cimg src=\"https://github.com/getgauge/gauge-vscode/raw/master/images/diagnostics.jpg\" alt=\"Diagnostics preview\" style=\"width: 600px;\"/\u003e\n\n## Format Specifications\n\n\u003cimg src=\"https://github.com/getgauge/gauge-vscode/raw/master/images/format.jpg\" alt=\"Formatting preview\" style=\"width: 600px;\"/\u003e\n\n## Symbols\n\n\u003cimg src=\"https://github.com/getgauge/gauge-vscode/raw/master/images/symbols.jpg\" alt=\"Symbols preview\" style=\"width: 600px;\"/\u003e\n\n## References\n\n\u003cimg src=\"https://github.com/getgauge/gauge-vscode/raw/master/images/references.jpg\" alt=\"References preview\" style=\"width: 600px;\"/\u003e\n\n## Run specifications and scenarios\n\n### Using Codelens\n\n\u003cimg src=\"https://github.com/getgauge/gauge-vscode/raw/master/images/runSpec.jpg\" alt=\"Run Specs/Scenarios preview\" style=\"width: 600px;\"/\u003e\n\n### Using command palette\n[Launch the command palette](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line)\n\n\t* Gauge: Create a new Gauge Project\n\t* Gauge: Create a new Specification\n\t* Gauge: Find Step References\n\t* Gauge: Optimize VS Code Configuration for Gauge\n\t* Gauge: Run All Specification\n\t* Gauge: Run Specification\n\t* Gauge: Run Scenarios\n\t* Gauge: Run Scenario At Cursor\n\t* Gauge: Repeat Last Run\n\t* Gauge: Re-Run Failed Scenario(s)\n\t* Gauge: Show Last Run Report\n\t* Gauge: Stop current gauge execution\n\t* Gauge: Report Issue\n\t* Test: Focus on Gauge Specs View\n\n## Debug specifications and scenarios\n\n\u003cimg src=\"https://github.com/getgauge/gauge-vscode/raw/master/images/debugSpec.jpg\" alt=\"Debug Specs/Scenarios preview\" style=\"width: 600px;\"/\u003e\n\nSuport for Debugging of step implementations in JS, Python and Ruby\n\n## Reports\n\nView execution reports inside VS Code\n\n\u003cimg src=\"https://github.com/getgauge/gauge-vscode/raw/master/images/reports.jpg\" alt=\"Execution Report preview\" style=\"width: 600px;\"/\u003e\n\n## Test Explorer\n\n\u003cimg src=\"https://github.com/getgauge/gauge-vscode/raw/master/images/testExplorer.jpg\" alt=\"Test Explorer preview\" style=\"width: 600px;\"/\u003e\n\n## Snippets for specification, scenarios and tables\n\nTo invoke a snippet type any of the following snippet keywords and Ctrl+space\n\n* `spec` - for specification\n* `sce` - for scenario\n* `table:1` - table with one column\n* `table:2` - table with two columns\n* `table:3` - table with three columns\n* `table:4` - table with four columns\n* `table:5` - table with five columns\n* `table:6` - table with six columns\n\n# Configuration\n\nTo override default configurations in [VSCode settings](https://code.visualstudio.com/docs/getstarted/settings)\n\n* `gauge.launch.enableDebugLogs`:  Starts gauge lsp server with log-level `debug`, defaults to `false`\n* `gauge.execution.debugPort`:  Debug port, defaults to `9229`\n* `gauge.notification.suppressUpdateNotification`:  Stops notifications for gauge-vscode plugin auto-updates, defaults to `false`\n* `gauge.create.specification.withHelp`: Create specification template with help comments, defaults to `true`\n\n## Run and Debug configuration\n\nTo specify the execution options for the tests, add a `\"type\":\"gauge\"` entry with `\"request\":\"test\"` to `launch.json`.\nThe options of the [gage run command](https://manpage.gauge.org/gauge_run.html) are available as properties of the entry. For Maven and Gradle plugins, the corresponding arguments are supported.\nIf there are multiple `\"request\":\"test\"` entries in `launch.json`, the first definition will be used.\n\n# Install from source\n\n\t$ npm run build\n\nThis will create `gauge-\u003cversion\u003e.vsix` file which can be installed via VScode's [Install from VSIX](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix).\n\u003e Note: Manually delete the Gauge extension folder from [VSCode extensions folder](https://vscode-docs.readthedocs.io/en/stable/extensions/install-extension/) for a successful uninstallation of VSCode extension\n\n# Troubleshooting\n\nIf gauge features are not activated, check file associations for `.spec` and `.cpt` it maybe used by another plugin. To fix this, add this to [user settings](https://code.visualstudio.com/docs/getstarted/settings)\n\n```\n\"files.associations\": {\n\t\"*.spec\": \"gauge\",\n\t\"*.cpt\": \"gauge\"\n}\n```\n\n## Facing other issues?\n\nRefer our [Troubleshooting](https://docs.getgauge.io/troubleshooting.html) guide\n\n# Talk to us\n\nPlease see below for the best place to ask a query:\n\n- How do I? -- [Stack Overflow](https://stackoverflow.com/questions/ask?tags=getgauge)\n- I got this error, why? -- [Stack Overflow](https://stackoverflow.com/questions/ask?tags=getgauge)\n- I got this error and I'm sure it's a bug -- file an [issue](https://github.com/getgauge/gauge-vscode/issues)\n- I have an idea/request -- file an [issue](https://github.com/getgauge/gauge-vscode/issues)\n- Why do you? -- [Google Groups](https://groups.google.com/forum/#!forum/getgauge)\n- When will you? -- [Google Groups](https://groups.google.com/forum/#!forum/getgauge)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetgauge%2Fgauge-vscode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgetgauge%2Fgauge-vscode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetgauge%2Fgauge-vscode/lists"}