mibemerami / visual-cucumber-step-picker

A vscode extension to improve the experience of writing cucumber features.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

visualcucumbersteppicker README

Visual Cucumber Step Picker (for Javascript) is a VSCode extension, that provides a panel in the explorer, to show you all Cucumber steps in your project at a glance, and that allows you, to add them directly to your scenario.

It can be hard, to keep an overview of all your available Cucumber steps, and it gets harder, the more your project grows. If you have hundreds of steps, and more, you don't want to go manually through all off your step definition files, to search for a step, that matches your intention. But if you write unnecessary new steps, the confusion gets only bigger.

With Visual Cucumber Step Picker you have all Cucumber steps at your fingertips, they are sorted by files and folders, and they are searchable. You can add them to your scenario with just a click.

Features

  • List all Cucumber steps in the step definitions folder, which you can select. Default is ./features/step_definitions.
  • Expand or collapse your step definition files and subfolders, to get a better overview.
  • Add steps directly to your scenario.
  • Add steps in a cleaned up way, with a pattern you define, or in a raw form.

Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.

For example if there is an image subfolder under your extension project workspace:

![feature X](images/feature-x.png)

Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.

Requirements

If you have any requirements or dependencies, add a section describing those and how to install and configure them.

Extension Settings

Include if your extension adds any VS Code settings through the contributes.configuration extension point.

For example:

This extension contributes the following settings:

  • myExtension.enable: enable/disable this extension
  • myExtension.thing: set to blah to do something

Known Issues

Calling out known issues can help limit users opening duplicate issues against your extension.

Release Notes

Users appreciate release notes as you update your extension.

1.0.0

Initial release of ...

1.0.1

Fixed issue #.

1.1.0

Added features X, Y, and Z.


Working with Markdown

Note: You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

  • Split the editor (Cmd+\ on macOS or Ctrl+\ on Windows and Linux)
  • Toggle preview (Shift+CMD+V on macOS or Shift+Ctrl+V on Windows and Linux)
  • Press Ctrl+Space (Windows, Linux) or Cmd+Space (macOS) to see a list of Markdown snippets

For more information

Enjoy!

About

A vscode extension to improve the experience of writing cucumber features.


Languages

Language:TypeScript 100.0%