ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Gherkin Auto-Complete Plus

by austincrft ST3

Gherkin Auto-Complete Plus is a Sublime Text plugin that will catalog Gherkin steps from the *.feature files of the provided directory, and provide autocomplete suggestions based on the catalogued steps.

Details

  • 1.2.2
  • github.​com
  • github.​com
  • 10 months ago
  • 57 minutes ago
  • 2 years ago

Installs

  • Total 4K
  • Win 2K
  • OS X 1K
  • Linux 670
Dec 15 Dec 14 Dec 13 Dec 12 Dec 11 Dec 10 Dec 9 Dec 8 Dec 7 Dec 6 Dec 5 Dec 4 Dec 3 Dec 2 Dec 1 Nov 30 Nov 29 Nov 28 Nov 27 Nov 26 Nov 25 Nov 24 Nov 23 Nov 22 Nov 21 Nov 20 Nov 19 Nov 18 Nov 17 Nov 16 Nov 15 Nov 14 Nov 13 Nov 12 Nov 11 Nov 10 Nov 9 Nov 8 Nov 7 Nov 6 Nov 5 Nov 4 Nov 3 Nov 2 Nov 1 Oct 31
Windows 0 6 0 3 5 2 0 3 6 3 1 4 1 1 3 5 4 1 7 0 2 3 2 1 4 3 0 0 3 4 6 12 4 3 0 3 5 3 8 4 1 0 1 4 5 3
OS X 0 0 6 3 3 0 3 0 3 2 5 2 0 0 1 3 4 2 2 1 0 1 2 0 3 0 1 0 3 5 2 2 1 0 0 3 3 2 5 6 1 0 1 3 3 3
Linux 2 0 2 0 2 0 0 1 2 2 0 1 0 0 1 2 2 1 1 0 1 1 1 1 1 2 1 0 2 0 0 2 1 1 0 1 0 1 2 1 0 1 1 3 0 1

Readme

Source
raw.​githubusercontent.​com

Gherkin Auto-Complete Plus

Build Status Join the chat at https://gitter.im/austincrft/sublime-gherkin-auto-complete-plus

This is a Sublime Text auto-complete package for use with Cucumber's Gherkin language. This package will catalog Gherkin step definitions from the *.feature files of the selected directories and provide auto-complete suggestions based on the catalogued steps.

Examples

Auto-Complete

auto_complete

Fuzzy-searching steps

example

Usage Info

This package is only compatible with Sublime Text 3. It will not work on Sublime Text 2. - Any folders open in Sublime Text will be searched recursively for *.feature files. You can specify additional directories via the package's settings file (Note: There is an option to use only these directories). - Step catalog is updated when the package loads or on the save of a *.feature file - This package relies on the first word of the line being a keyword (Given, When, Then) in order to give auto-complete suggestions. If a keyword is not found on the current line, the previous one will be used. - If the first word on a line is an asterisk (*), that step will show up under all other step types - It is not recommended that this is used alongside cucumber-sublime-bundle, as the bundled auto-complete will interfere with the results. At the moment, I've included the Gherkin syntax files so that this package can be self-contained. I have tried contacting the owner of that bundle, but he is not an easy man to reach.

Options/Settings

The settings file for this package can be accessed from the toolbar via Preferences -> Package Settings -> Gherkin Auto-Complete Plus -> Settings - User (Note: You can open Settings - Default as a reference)

{
    // A collection of ADDITIONAL directories containing the features files you would like to scan
    // The directories listed here will be scanned IN ADDITION to the folder(s) open in Sublime Text
    "feature_file_directories":
    [
        "path/to/feature/files/directory",
        "some/path/to/different/feature/files/directory"
    ],

    // When this is set to true, the open directories in Sublime Text will be ignored, and only
    // the directories listed in the `feature_file_directories` option will be used
    "ignore_open_directories": false,

    // Logging for execution information -- this will output to the Sublime Text Console
    // You can view the console by going to the toolbar and selecting `View -> Show Console`
    // Valid options:
    // DEBUG - Detailed information for debugging
    // INFO - Confirmation that things are working as expected
    // WARNING - An indication something might fail in the future
    // ERROR - An error occurred, likely a recoverable one
    // CRITICAL - A non-recoverable error -- execution will stop
    "logging_level": "error"
}

Why did you create a new Gherkin Auto-Complete package instead of contributing to the existing one?

Short answer: There were a lot of changes I wanted to make, and felt it warranted a new package.

Differences: - The auto-complete suggestions will pop up as you type – no need to open manually - Pressing space does not automatically commit the highlighted suggestion, so it shouldn't interrupt your workflow - Only gives suggestions for current step-type (if the line starts with Given, then only Given steps will be suggested) - Steps are formatted in snippet-notation to allow tabbing to values - Table rows are not catalogued, which are unlikely to be duplicated exactly - Values in between quotes (single and double), less- and greater-than signs, and numbers in 'integer' and 'decimal' format are ignored to remove duplicates from the step list

Isn't the name 'Gherkin Auto-Complete Plus' a bit arrogant?

Absolutely, yes. It's intended to be tongue-in-cheek, but also I couldn't think of a better name. :smirk:

Installation

Automatic - via Package Control

Search for 'Gherkin Auto-Complete Plus'

Mac OSX

cd ~/Library/Application\ Support/Sublime\ Text\ 3/Packages
git clone https://github.com/austincrft/sublime-gherkin-auto-complete-plus.git "Gherkin Auto-Complete Plus"

Linux

cd ~/.config/sublime-text-3/Installed\ Packages
git clone https://github.com/austincrft/sublime-gherkin-auto-complete-plus.git "Gherkin Auto-Complete Plus"

Windows

cd "C:\Users\<user>\AppData\Roaming\Sublime Text 3\Installed Packages"
git clone https://github.com/austincrft/sublime-gherkin-auto-complete-plus.git "Gherkin Auto-Complete Plus"

Credits

The accompanied *.tmLanguage files were taken from @drewda's cucumber-sublime-bundle repository.