chutney 3.7.0 → 3.8.1

data/usechutney.com/docs/rules/unknown-variable/index.md

@@ -0,0 +1,38 @@
+---
+title: "Unknown Variable"
+layout: single
+permalink: /docs/rules/unknown-variable/
+---
+
+You are referencing a variable which does not appear to be defined in the example table. This is probably an accident and your test might not be doing what you expect. This rule will check that all variables used in a scenario are defined in the example table.
+
+## Bad
+
+```gherkin
+Feature: logging in
+
+  Scenario Outline: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>" and "<admin>"
+    Then I will see my account
+    Then I will see my account
+
+    Examples:
+      | username | password |
+      | user1    | password |
+```
+
+## Good
+
+```gherkin
+Feature: logging in
+
+  Scenario Outline: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>" and "<admin>"
+    Then I will see my account
+
+    Examples:
+      | username | password | admin |
+      | user1    | password | true  |
+```

data/usechutney.com/docs/rules/unused-variable/index.md

@@ -0,0 +1,37 @@
+---
+title: "Unused Variable"
+layout: single
+permalink: /docs/rules/unused-variable/
+---
+
+You have defined a variable in your example table but you are not using it. This is probably an accident and your test might not be doing what you expect. This rule will check that all variables defined in the example table are used in the scenario.
+
+## Bad
+
+```gherkin
+Feature: logging in
+
+  Scenario Outline: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+
+    Examples:
+      | username | password | admin |
+      | user1    | password | true  |
+```
+
+## Good
+
+```gherkin
+Feature: logging in
+
+  Scenario Outline: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+
+    Examples:
+      | username | password |
+      | user1    | password |
+```

data/usechutney.com/docs/rules/use-background/index.md

@@ -0,0 +1,40 @@
+---
+title: "Use Background"
+layout: single
+permalink: /docs/rules/use-background/
+---
+
+You have multiple scenarios that all have the same setup steps. This is a sign that you should use a background to define the common setup steps once and reuse them in each scenario. This rule will check that you are using a background when you have multiple scenarios with the same setup steps.
+
+## Bad
+
+```gherkin
+Feature: logging in
+
+  Scenario: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+
+  Scenario: logging out
+    Given I have visited the website
+    When I log out
+    Then I will see the login page
+```
+
+## Good
+
+```gherkin
+Feature: logging in
+
+  Background:
+    Given I have visited the website
+
+  Scenario: logging in
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+
+  Scenario: logging out
+    When I log out
+    Then I will see the login page
+```

data/usechutney.com/docs/rules/use-outline/index.md

@@ -0,0 +1,39 @@
+---
+title: "Use Outline"
+layout: single
+permalink: /docs/rules/use-outline/
+---
+
+You have multiple scenarios that are almost identical. This is a sign that you should use a scenario outline to define the common steps once and reuse them with different inputs. This rule will check that you are using a scenario outline when you have multiple scenarios that are almost identical.
+
+## Bad
+
+```gherkin
+Feature: logging in
+
+  Scenario: logging in with user1
+    Given I have visited the website
+    When I log in with "user1" and "password"
+    Then I will see my account
+
+  Scenario: logging in with user2
+    Given I have visited the website
+    When I log in with "user2" and "password"
+    Then I will see my account
+```
+
+## Good
+
+```gherkin
+Feature: logging in
+
+  Scenario Outline: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+
+    Examples:
+      | username | password |
+      | user1    | password |
+      | user2    | password |
+```

data/usechutney.com/docs/running/index.md

@@ -0,0 +1,33 @@
+---
+title: "Running Chutney"
+layout: single
+permalink: /docs/running/
+---
+
+Once you have [installed Chutney](/docs/installing/), you can run it from the command line.
+
+```bash
+chutney
+```
+
+This will run Chutney in the current directory where it will look for a folder called `features` and check all the `.feature` files in it. If you want to run Chutney on a specific file, you can specify that on the command line:
+
+```bash
+chutney path/to/your/file.feature
+```
+
+## Results
+
+Chutney will output a list of any issues it finds in your feature files. If it finds no issues, it will output a message that all your features are delicious.
+
+For example:
+
+```text
+foo.feature
+  MissingTestAction
+    Your test has no action step. All scenarios should have a 'When' step indicating the action being taken.
+    foo.feature:13
+  MissingScenarioName
+    This scenario is unnamed. You should name all scenarios.
+    foo.feature:13
+```

data/usechutney.com/pages/404.html

@@ -0,0 +1,25 @@
+---
+permalink: /404.html
+layout: default
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+  <p>The requested page could not be found.</p>
+</div>

data/usechutney.com/pages/about/index.md

@@ -0,0 +1,22 @@
+---
+title: "About"
+layout: single
+permalink: /pages/about/
+author_profile: true
+---
+
+Chutney is originally a fork of the abandoned [gherkin_lint](https://github.com/funkwerk/gherkin_lint). The original authors remain credited in the gemspec. It has been reworked and extended to support more rules and to be more flexible.
+
+It is much beloved by me. Although it's a personal project, it's used extensively by my employer and influenced by the needs of my colleagues. I hope it will be useful to you as well. I am very open to ideas, feedback and contributions.
+
+Chutney is licenced under the [MIT licence](https://raw.githubusercontent.com/BillyRuffian/chutney/refs/heads/master/LICENSE.txt). Do with it what you will and have fun.
+
+A huge hat tip to Eric Kessler for his work on [cuke_modeler](https://github.com/enkessler/cuke_modeler) which is used to parse the Gherkin files (he also publishes the gherkin linter [cuke_linter](https://github.com/enkessler/cuke_linter) if chutney does not fit your needs).
+
+### What's the Billy Ruffian thing?
+
+HMS Bellerophon was a 74-gun third-rate ship of the line of the Royal Navy. Launched in 1786, she served during the French Revolutionary and Napoleonic Wars, mostly on blockades or convoy escort duties. She fought in three fleet actions: the Glorious First of June, the Battle of the Nile and the Battle of Trafalgar. She became famous as the ship upon which Napoleon surrendered and which transported him into exile in 1815.
+
+Her sailors, not being educated in the Classics, struggled to pronounce her name and so she became known as the Billy Ruffian and her crew as the "Billy Ruffians". The name stuck and was used as a nickname for the ship for the rest of her career.
+
+Since no one in coffee shops can spell my name, I adopted 'Billy' which turned into 'Billy Ruffian'. It's also a bloody good story.

data/usechutney.com/pages/index.markdown

@@ -0,0 +1,40 @@
+---
+# Feel free to add content and custom Front Matter to this file.
+# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+
+# layout: single
+layout: splash
+permalink: /
+author_profile: false
+
+feature_row:
+  - image_path: /assets/images/mr_pickle.png
+    alt: "A happy jar of pickles smiling at you"
+    title: "Best Practice Cucumber"
+    excerpt: "Love your documentation, and your documentation will love you back."
+    url: "/docs/installing/"
+    btn_label: "Get Started"
+    btn_class: "btn btn--success"
+---
+
+{% include feature_row type="center" %}
+
+You’re trying to follow BDD or ATDD principles, you’re writing executable specifications in gherkin using Cucumber, you’re trying to do the *right thing* but are you doing the *thing right?*
+
+# Tests are your documentation
+
+Requirements are your longest-lived asset. Your implementation might change, your tests might change, but your requirements (specifications) continue to exist. They should be clear, concise, and easy to understand. They should be easy to read, easy to write, and easy to maintain. They should be your documentation.
+
+Cucumber makes it easy to write requirements in a human-readable format. It doesn't need any tool other than a text editor to write and read. It's a great tool to write requirements in a way that everyone can understand and that can be versioned and stored in a version control system with the rest of your code.
+
+# When cucumbers go bad
+
+Cucumber specifications can be a great asset, but they can also be a liability. In the exchange between business language and the language of testers and software developers, it's easy to lose the meaning of the requirements. It's easy to write specifications that are hard to read, hard to write, and hard to maintain.
+
+Chutney helps you write better Cucumber specifications. It helps you write specifications that are clear, concise, and easy to understand. It helps you write specifications that are easy to read, easy to write, and easy to maintain. Be kind to your future self and your team. Love your documentation, and your documentation will love you back.
+
+# What is Chutney?
+
+Chutney is a Ruby tool that reads your Cucumber feature files and tells you how you can make them better. It's a linter for Cucumber. It will help you avoid common pitfalls and anti-patterns in your Cucumber feature files. It will help you write better Cucumber specifications.
+
+Chutney is able to lint feature files in any spoken language supported by Cucumber.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chutney
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.8.1
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-07 00:00:00.000000000 Z
+date: 2024-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amatch
@@ -33,14 +33,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.21'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -62,145 +62,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.15.0
 - !ruby/object:Gem::Dependency
-  name: pastel
+  name: language_server-protocol
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '3.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '3.17'
 - !ruby/object:Gem::Dependency
-  name: tty-pie
+  name: pastel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: cucumber
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '7.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '7.0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rerun
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-- !ruby/object:Gem::Dependency
-  name: rspec-expectations
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.50.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.50.2
+        version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: tty-pie
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
-  type: :development
+        version: '0.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '0.3'
 description: A linter for your Cucumber features. Making sure you have nice, expressible
   Gherkin is essential is making sure you have a readable test-base. Chutney is designed
   to sniff out smells in your feature files. It supports any spoken language Cucumber
@@ -209,6 +111,7 @@ email:
 - nigel@brookes-thomas.co.uk
 executables:
 - chutney
+- chutney-lsp
 extensions: []
 extra_rdoc_files: []
 files:
@@ -239,8 +142,10 @@ files:
 - docs/usage/selective_enablement.md
 - examples/emoji.feature
 - exe/chutney
+- exe/chutney-lsp
 - img/chutney.svg
 - img/formatters.png
+- img/happy_chutney.png
 - lib/chutney.rb
 - lib/chutney/.DS_Store
 - lib/chutney/configuration.rb
@@ -289,10 +194,67 @@ files:
 - lib/chutney/linter/use_background.rb
 - lib/chutney/linter/use_outline.rb
 - lib/chutney/locator.rb
+- lib/chutney/lsp.rb
+- lib/chutney/lsp/result.rb
+- lib/chutney/lsp/server.rb
 - lib/chutney/version.rb
 - lib/config/locales/en.yml
 - spec/chutney_spec.rb
 - spec/spec_helper.rb
+- usechutney.com/.gitignore
+- usechutney.com/Gemfile
+- usechutney.com/_config.yml
+- usechutney.com/_data/navigation.yml
+- usechutney.com/_data/ui-text.yml
+- usechutney.com/_posts/2024-09-23-welcome-to-jekyll.markdown
+- usechutney.com/assets/images/mr_pickle.png
+- usechutney.com/assets/images/pug.png
+- usechutney.com/docs/configuration/index.md
+- usechutney.com/docs/disabling-rules/index.md
+- usechutney.com/docs/installing/index.md
+- usechutney.com/docs/language-server/index.md
+- usechutney.com/docs/rules/avoid-full-stops/index.md
+- usechutney.com/docs/rules/avoid-outline-for-single-example/index.md
+- usechutney.com/docs/rules/avoid-scripting/index.md
+- usechutney.com/docs/rules/avoid-splat-steps-in-background/index.md
+- usechutney.com/docs/rules/avoid-splat-steps-in-scenarios/index.md
+- usechutney.com/docs/rules/avoid-typographers-quotes/index.md
+- usechutney.com/docs/rules/background-does-more-than-setup/index.md
+- usechutney.com/docs/rules/background-requires-multiple-scenarios/index.md
+- usechutney.com/docs/rules/bad-scenario-name/index.md
+- usechutney.com/docs/rules/empty-feature-file/index.md
+- usechutney.com/docs/rules/file-name-differs-feature-name/index.md
+- usechutney.com/docs/rules/givens-after-background/index.md
+- usechutney.com/docs/rules/inconsistent-quoting/index.md
+- usechutney.com/docs/rules/invalid-step-flow/index.md
+- usechutney.com/docs/rules/invalid_file_name/index.md
+- usechutney.com/docs/rules/missing-example-name/index.md
+- usechutney.com/docs/rules/missing-example-table/index.md
+- usechutney.com/docs/rules/missing-feature-description/index.md
+- usechutney.com/docs/rules/missing-feature-name/index.md
+- usechutney.com/docs/rules/missing-scenario-name/index.md
+- usechutney.com/docs/rules/missing-scenario-outline/index.md
+- usechutney.com/docs/rules/missing-test-action/index.md
+- usechutney.com/docs/rules/missing-test-verification/index.md
+- usechutney.com/docs/rules/required-tag-starts-with/index.md
+- usechutney.com/docs/rules/same-tag-different-case/index.md
+- usechutney.com/docs/rules/same-tag-for-all-scenarios/index.md
+- usechutney.com/docs/rules/scenario-names-match/index.md
+- usechutney.com/docs/rules/tag-used-multiple-times/index.md
+- usechutney.com/docs/rules/too-clumsy/index.md
+- usechutney.com/docs/rules/too-long-step/index.md
+- usechutney.com/docs/rules/too-many-different-tags/index.md
+- usechutney.com/docs/rules/too-many-steps/index.md
+- usechutney.com/docs/rules/too-many-tags/index.md
+- usechutney.com/docs/rules/unique-scenario-names/index.md
+- usechutney.com/docs/rules/unknown-variable/index.md
+- usechutney.com/docs/rules/unused-variable/index.md
+- usechutney.com/docs/rules/use-background/index.md
+- usechutney.com/docs/rules/use-outline/index.md
+- usechutney.com/docs/running/index.md
+- usechutney.com/pages/404.html
+- usechutney.com/pages/about/index.md
+- usechutney.com/pages/index.markdown
 homepage: https://billyruffian.github.io/chutney/
 licenses:
 - MIT
@@ -308,14 +270,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A linter for multi-lingual Gherkin