chutney 3.8.2 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d591126bb019a5a5805ea5ee0678e19e848e3c6dd6f36baf48ea398f5bd2832
-  data.tar.gz: 4d2579c84397ff586ca987f5824432958deffdcaa08a429eccaff8c8ab29ec51
+  metadata.gz: 6734d8a322d5394f40d363d0ad93def2424ea97be81f4a13cd7bb92c91ade597
+  data.tar.gz: 0146772a58c64cfa3aa8f7ab05861c94945d37abec3ff10c93bd3f653c9784b4
 SHA512:
-  metadata.gz: f71bbc66a6a5c9d81b240d08e4bc6817a0c9b98ec9a8c80f31f71a4a0104239e4b674f303453761bcab8c4785fc6bd12ba8c15e64963e466f8dea3b7bea0a635
-  data.tar.gz: c6a8ae299506b6f1519275f2aa9f5e962c6191958265e154e51e98625aa8825f0869cc4e580cef7340708dd15416241aa81f2eff94423022dae2ce9ecf9e85f9
+  metadata.gz: 9f869fc17e30cee78412fab391049971c81316937148e73dcd6111afb6d55a5c60e9ac5db24d36917b9be63556dd8ee63ea4b1d082f8fd4a8b3edb3bae037ba4
+  data.tar.gz: 87f372ffc4bcef3f514aef73ae971d8a5dd8545d6bd7897770e7c69808c11fd7f0740afd0befe271ef49274720e91da5a92a4913cd108737bf2e1fbe99f1dd5e

data/config/chutney_defaults.yml

@@ -1,80 +1,84 @@
+AvoidColonsAtStartOfNames:
+  Enabled: true
+AvoidCommaInTags:
+  Enabled: true
 AvoidOutlineForSingleExample:
-    Enabled: true
+  Enabled: true
 AvoidFullStop:
-    Enabled: true
+  Enabled: true
 AvoidScripting:
-    Enabled: true
+  Enabled: true
 AvoidSplatStepsInBackground:
-    Enabled: true
+  Enabled: true
 AvoidSplatStepsInScenarios:
-    Enabled: true
+  Enabled: true
 AvoidTypographersQuotes:
-    Enabled: true
+  Enabled: true
 BackgroundDoesMoreThanSetup:
-    Enabled: true
+  Enabled: true
 BackgroundRequiresMultipleScenarios:
-    Enabled: true
+  Enabled: true
 BadScenarioName:
-    Enabled: true
+  Enabled: true
 EmptyFeatureFile:
-    Enabled: true
+  Enabled: true
 FileNameDiffersFeatureName:
-    Enabled: true
+  Enabled: true
 GivensAfterBackground:
-    Enabled: true
+  Enabled: true
 MissingExampleName:
-    Enabled: true
+  Enabled: true
 MissingExampleTable:
-    Enabled: true
+  Enabled: true
 MissingFeatureDescription:
-    Enabled: true
+  Enabled: true
 MissingFeatureName:
-    Enabled: true
+  Enabled: true
 MissingScenarioName:
-    Enabled: true
+  Enabled: true
 MissingScenarioOutline:
-    Enabled: true
+  Enabled: true
 MissingTestAction:
-    Enabled: true
+  Enabled: true
 MissingVerification:
-    Enabled: true
+  Enabled: true
 InconsistentQuoting:
-    Enabled: true
+  Enabled: true
 InvalidFileName:
-    Enabled: true
+  Enabled: true
 InvalidStepFlow:
-    Enabled: true
+  Enabled: true
 RequiredTagsStartsWith:
-    Enabled: false
+  Enabled: false
 SameTagDifferentCase:
-    Enabled: true
+  Enabled: true
 SameTagForAllScenarios:
-    Enabled: true
+  Enabled: true
 ScenarioNamesMatch:
-    Enabled: false
+  Enabled: false
 TagUsedMultipleTimes:
-    Enabled: true
+  Enabled: true
 TooClumsy:
-    Enabled: true
+  Enabled: true
 TooManyDifferentTags:
-    Enabled: true
-    MaxCount: 3
+  Enabled: true
+  MaxCount: 3
 TooManySteps:
-    Enabled: true
-    MaxCount: 10
+  Enabled: true
+  MaxCount: 10
 TooManyTags:
-    Enabled: true
-    MaxCount: 3
+  Enabled: true
+  MaxCount: 3
 TooLongStep:
-    Enabled: true
-    MaxLength: 80
+  Enabled: true
+  MaxLength: 80
 UniqueScenarioNames:
-    Enabled: true
+  Enabled: true
 UnknownVariable:
-    Enabled: true
+  Enabled: true
 UnusedVariable:
-    Enabled: true
+  Enabled: true
 UseBackground:
-    Enabled: true
+  Enabled: true
 UseOutline:
-    Enabled: true
+  Enabled: true

data/lib/chutney/linter/avoid_colons_at_start_of_names.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Chutney
+  # service class to lint for avoiding colons at the start of names
+  class AvoidColonsAtStartOfNames < Linter
+    def lint
+      add_issue(I18n.t('linters.avoid_colons_at_start_of_names'), feature) if feature.name.start_with? ':'
+
+      scenarios do |_feature, scenario|
+        if scenario.name.start_with? ':'
+          add_issue(I18n.t('linters.avoid_colons_at_start_of_names'), feature,
+                    scenario)
+        end
+      end
+    end
+  end
+end

data/lib/chutney/linter/avoid_comma_in_tags.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Chutney
+  # service class to lint for too many tags
+  class AvoidCommaInTags < Linter
+    def lint
+      scenarios do |feature, scenario|
+        tags = tags_for(feature) + tags_for(scenario)
+        next unless tags.any? { |tag| tag.include?(',') }
+
+        add_issue(
+          I18n.t('linters.avoid_comma_in_tags'),
+          feature
+        )
+      end
+    end
+  end
+end

data/lib/chutney/lsp/server.rb

@@ -134,6 +134,8 @@ module Chutney
       end
 
       def to_range(location)
+        return { start: { character: 0, line: 0 }, end: { character: 0, line: 0 } } unless location
+
         {
           start: { character: location.fetch(:column, 1) - 1, line: location.fetch(:line, 1) - 1 },
           end: { character: 0, line: location.fetch(:line, 1) }

data/lib/chutney/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chutney
-  VERSION = '3.8.2'
+  VERSION = '3.10.0'
 end

data/lib/chutney.rb

@@ -4,6 +4,8 @@ require 'amatch'
 
 require 'chutney/configuration'
 require 'chutney/linter'
+require 'chutney/linter/avoid_colons_at_start_of_names'
+require 'chutney/linter/avoid_comma_in_tags'
 require 'chutney/linter/avoid_full_stop'
 require 'chutney/linter/avoid_outline_for_single_example'
 require 'chutney/linter/avoid_scripting'

data/lib/config/locales/en.yml

@@ -3,6 +3,10 @@
 # God save the Queen, etc. etc.
 en:
   linters:
+    avoid_colons_at_start_of_names: >-
+      Avoid using colons at the start of names, it can make them hard to read or find.
+    avoid_comma_in_tags: >-
+      Avoid using commas in tags. Tags should be separated by spaces.
     avoid_full_stop: >- # https://en.wikipedia.org/wiki/Full_stop
       Avoid using a full-stop in steps so that it is easier to re-use them.
     avoid_outline_for_single_example: >-

data/usechutney.com/_config.yml

@@ -74,7 +74,7 @@ masthead_title: # overrides the website title displayed in the masthead, use " "
 breadcrumbs: # true, false (default)
 words_per_minute: 200
 enable_copy_code_button: true # true, false (default)
-copyright: # "copyright" name, defaults to site.title
+copyright: Nigel Brookes-Thomas # "copyright" name, defaults to site.title
 copyright_url: # "copyright" URL, defaults to site.url
 comments:
   provider: # false (default), "disqus", "discourse", "facebook", "staticman", "staticman_v2", "utterances", "giscus", "custom"

data/usechutney.com/_data/navigation.yml

@@ -29,6 +29,10 @@ sidebar:
 
   - title: "Rules"
     children:
+      - title: "Avoid colons at start of names"
+        url: /docs/rules/avoid-colons-at-start-of-names/
+      - title: "Avoid comma in tags"
+        url: /docs/rules/avoid-comma-in-tags/
       - title: "Avoid full stops"
         url: /docs/rules/avoid-full-stops/
       - title: "Avoid outline for single example"

data/usechutney.com/docs/rules/avoid-colons-at-start-of-names/index.md

@@ -0,0 +1,28 @@
+---
+title: "Avoid Colons at Start of Names"
+layout: single
+permalink: /docs/rules/avoid-colons-at-start-of-names/
+---
+
+Don't have colons at the start of feature or scenario names. It's probably a mistake if you have them from double typing the colon after the `Feature` or `Scenario` keyword.
+
+
+## Bad
+
+```gherkin
+Feature: :My Feature
+  Scenario: :My Scenario
+    Given I have visited the website
+    When I log in
+    Then I will see my account
+```
+
+## Good
+
+```gherkin
+Feature: My Feature
+  Scenario: My Scenario
+    Given I have visited the website
+    When I log in
+    Then I will see my account
+```

data/usechutney.com/docs/rules/avoid-comma-in-tags/index.md

@@ -0,0 +1,26 @@
+---
+title: "Avoid Comma in Tags"
+layout: single
+permalink: /docs/rules/avoid-comma-in-tags/
+---
+
+Don't put a comma in tags. It's probably a mistake if you have them from trying write a list of tags but the comma will form part of the name and makes it hard to include or exclude the tag from a Cucumber run.
+
+
+## Bad
+
+```gherkin
+@web, @login
+Given I have visited the website
+When I log in.
+Then I will see my account
+```
+
+## Good
+
+```gherkin
+@web @login
+Given I have visited the website
+When I log in
+Then I will see my account
+```

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chutney
 version: !ruby/object:Gem::Version
-  version: 3.8.2
+  version: 3.10.0
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-10 00:00:00.000000000 Z
+date: 2024-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amatch
@@ -155,6 +155,8 @@ files:
 - lib/chutney/formatter/rainbow_formatter.rb
 - lib/chutney/issue.rb
 - lib/chutney/linter.rb
+- lib/chutney/linter/avoid_colons_at_start_of_names.rb
+- lib/chutney/linter/avoid_comma_in_tags.rb
 - lib/chutney/linter/avoid_full_stop.rb
 - lib/chutney/linter/avoid_outline_for_single_example.rb
 - lib/chutney/linter/avoid_scripting.rb
@@ -213,6 +215,8 @@ files:
 - 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-colons-at-start-of-names/index.md
+- usechutney.com/docs/rules/avoid-comma-in-tags/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
@@ -277,7 +281,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: A linter for multi-lingual Gherkin