chutney 3.12.4 → 3.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bef0309c872b30a632afd0d944493cc0ecba7e5eb5348e470ede52b44cad857
-  data.tar.gz: 30c86c817bc8167157bcbb1679ee619908d5d505e52e856e12d294fa0b7c9ed6
+  metadata.gz: 8f2cf6323ca7856c5f58637ddc7ea3a4dd74222099a0dcb0a9b0768d95569bb5
+  data.tar.gz: bae06f03776f2c4d0be16f2a5bbd2f142e0a1259822076801924e0c02ee11e09
 SHA512:
-  metadata.gz: e97e7afee0915e9fcd16f2af9f713a0fa31832cdf01dab3a57c351d09592c54f27a57c0f053667d82e707f1a94be41ca1fc1e12deb3640c687b25f752a704a28
-  data.tar.gz: c62aacc66844003019511c285a7ab2bf5728383dcaf2c19b2e3f2859e1a2395a4d7b8690e8b619f1967a0ed677727a928f8177c8023b20d03aec94ed613c8cd0
+  metadata.gz: 2c9461d317783650437e56da8bada9a15e3cf28974d6f28aec466c28b7fd066ec7eda520cfb2f419710c81b6f78ab94e8cb3aa403dcd28fa0f725d9aa03c19e6
+  data.tar.gz: 6e313a2aab39d318b2415c5d50e4df6a9ba373b4d00d07525dea132c3ea4d2610a5fea0469439d81d6cc6f513f6972a5a2356af35cbd647e76469981a6e86e71

data/config/chutney_defaults.yml

@@ -74,6 +74,9 @@ TooManyTags:
 TooLongStep:
   Enabled: true
   MaxLength: 80
+TooShortTag:
+  Enabled: true
+  MinLength: 2
 UniqueScenarioNames:
   Enabled: true
 UnknownVariable:

data/lib/chutney/linter/too_short_tag.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Chutney
+  # service class to lint for tags that are too short, such as @t
+  class TooShortTag < Linter
+    def lint
+      scenarios do |feature, scenario|
+        tags = tags_for(feature) + tags_for(scenario)
+        next unless tags.any? { |tag| tag.length < min_length }
+
+        add_issue(
+          I18n.t('linters.too_short_tag', min_length:, tags:),
+          feature
+        )
+      end
+    end
+
+    def min_length
+      configuration['MinLength']&.to_i || 2
+    end
+  end
+end

data/lib/chutney/version.rb

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

data/lib/chutney.rb

@@ -40,6 +40,7 @@ require 'chutney/linter/too_long_step'
 require 'chutney/linter/too_many_different_tags'
 require 'chutney/linter/too_many_steps'
 require 'chutney/linter/too_many_tags'
+require 'chutney/linter/too_short_tag'
 require 'chutney/linter/unique_scenario_names'
 require 'chutney/linter/unknown_variable'
 require 'chutney/linter/unused_variable'

data/lib/config/locales/en.yml

@@ -108,6 +108,8 @@ en:
       There are too many steps in this feature. There are %{count} and the maximum is %{max}.
     too_many_tags: >-
       There are too many tags in this feature. There are %{count} and the maximum is %{max}.
+    too_short_tag: >-
+      Your tag is too short: %{tags}. The minimum length of a tag is %{min_length}. Tags should have meaning.
     unique_scenario_names: >-
       The scenario name '%{name}' is duplicated, first used at line %{line}, column %{column}.
     unknown_variable: >-

data/usechutney.com.site/site/src/docs/rules/index.page.md

@@ -36,6 +36,7 @@
 * [Too Many Different Tags](/docs/rules/too-many-different-tags)
 * [Too Many Steps](/docs/rules/too-many-steps)
 * [Too Many Tags](/docs/rules/too-many-tags)
+* [Too Short Tag](/docs/rules/too_short_tag)
 * [Unique Scenario Names](/docs/rules/unique-scenario-names)
 * [Unknown Variable](/docs/rules/unknown-variable)
 * [Unused Variable](/docs/rules/unused-variable)

data/usechutney.com.site/site/src/docs/rules/too_short_tag.page.md

@@ -0,0 +1,25 @@
+# Too Short Tag
+
+If you have used a tag that is too short, you have probably done it while locally testing. This is a bad practice because it makes your tests harder to read and maintain.
+
+It is much better to use tags that relate to the test, such as a ticket number to connect the development work you are testing
+
+## Bad
+
+```gherkin
+@t
+Scenario: Log in with valid credentials
+Given I have visited the website
+When I log in with "user1" and "pass1"
+Then I will see my account
+```
+
+## Good
+
+```gherkin
+@QE-0001
+Scenario: Log in with valid credentials
+  Given I have visited the website
+  When I log in with "user1" and "pass1"
+  Then I will see my account
+```

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chutney
 version: !ruby/object:Gem::Version
-  version: 3.12.4
+  version: 3.13.0
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
@@ -10,7 +10,7 @@ authors:
 - John Gluck
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amatch
@@ -212,6 +212,7 @@ files:
 - lib/chutney/linter/too_many_different_tags.rb
 - lib/chutney/linter/too_many_steps.rb
 - lib/chutney/linter/too_many_tags.rb
+- lib/chutney/linter/too_short_tag.rb
 - lib/chutney/linter/unique_scenario_names.rb
 - lib/chutney/linter/unknown_variable.rb
 - lib/chutney/linter/unused_variable.rb
@@ -280,6 +281,7 @@ files:
 - usechutney.com.site/site/src/docs/rules/too-many-different-tags.page.md
 - usechutney.com.site/site/src/docs/rules/too-many-steps.page.md
 - usechutney.com.site/site/src/docs/rules/too-many-tags.page.md
+- usechutney.com.site/site/src/docs/rules/too_short_tag.page.md
 - usechutney.com.site/site/src/docs/rules/unique-scenario-names.page.md
 - usechutney.com.site/site/src/docs/rules/unknown-variable.page.md
 - usechutney.com.site/site/src/docs/rules/unused-variable.page.md