All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Nothing yet...

• New linters

  • TestNameWithTooManyCharactersLinter

• Linters that are impacted by Rule elements in Gherkin have been updated, now that Rules models are available in CukeModeler

  • FeatureWithoutScenariosLinter

• Updated the minimum required Ruby version to 2.1. The gem has never had 2.0 compatible code (due to using named parameters without default values), so it's easier to just officially drop 2.0 'support' than to change the API to enable a use case that was never used anyway.

• Ruby 3.x is now supported

• Now compatible with CukeModeler 3.x

• Replaced some code that was not valid with earlier versions of Ruby 2.x, with which this gem is specified as being compatible.

• No longer including every file in the Git repository as part of the gem. Only the files needed for using the linter (and the informative ones like the README) will be packaged into the released gem.

• Added the ability to configure relevant keywords for linters whose behavior is impacted by the dialect in which feature files are written.
  • BackgroundDoesMoreThanSetupLinter
  • TestWithActionStepAsFinalStepLinter
  • TestWithNoActionStepLinter
  • TestWithNoVerificationStepLinter
  • TestWithSetupStepAfterActionStepLinter
  • TestWithSetupStepAfterVerificationStepLinter
  • TestWithSetupStepAsFinalStepLinter

• TestShouldUseBackgroundLinter no longer suggests moving steps to the background if they have an outline parameter.

• New linters

  • ElementWithCommonTagsLinter
  • ElementWithDuplicateTagsLinter
  • FeatureFileWithMismatchedNameLinter

• Now compatible with CukeModeler 2.x

• Fixed the Pretty formatter so that it can handle linting problems whose locations do not have a line number.

• New linters
  • FeatureFileWithInvalidNameLinter
  • TestWithBadNameLinter

• New linters
  • FeatureWithTooManyDifferentTagsLinter
  • TestShouldUseBackgroundLinter
  • TestWithActionStepAsFinalStepLinter
  • TestWithSetupStepAfterActionStepLinter
  • TestWithSetupStepAfterVerificationStepLinter
  • TestWithSetupStepAsFinalStepLinter

• Improved some of the documentation and linting messages so that it is more clear what the problem is.

• Linters can now be temporarily enabled/disabled within arbitrary portions of a feature file, in order to allow for exceptions to the otherwise blanket set of linting rules.

• The exit codes used by the CLI have been changed in order to better facilitate taking additional actions based on them.
  • 0 - No linting problems found
  • 1 - Linting problems found
  • 2 - Some other problem (e.g. incorrect CLI usage)

• Linters can now be configured en masse instead of having to configure the same property for all of them individually.

• New linters

  • ElementWithTooManyTagsLinter
  • FeatureWithoutNameLinter
  • TestWithNoActionStepLinter
  • TestWithNoNameLinter
  • TestWithNoVerificationStepLinter

• File paths can now be provided for linting without the user first having to turn them into models themselves.
• Option flags have been added to the command line interface. This will allow more flexibility when running from the command line and thereby reduce the need for writing a Ruby script for even basic usages of the gem.

• Linting is now done using a collection of model trees instead of taking only a single model tree.

• Fixed a bug in the 'pretty' formatter that was causing problems to be ordered by line number instead of being ordered by file (and then by line number within those files).
• Added a missing require statement that is needed if no other code in the runtime environment has loaded the needed library already.
• Fixed a bug where enabling/disabling a linter would trigger additional configuration of the linter, even for linters that could not be configured.

• New linters
  • BackgroundDoesMoreThanSetupLinter
  • FeatureWithoutDescriptionLinter
  • SingleTestBackgroundLinter
  • StepWithEndPeriodLinter
  • StepWithTooManyCharactersLinter

• A base linter class has been added that can be used to create custom linters more easily by providing common boilerplate code that every linter would need.

• Linters now return only a single problem instead of returning a collection of problems.

• Now declaring required Ruby version. It's always been 2.x but now the gem actually says it officially.

• Linter configuration: linters can now be configured (turned on/off, conditions changed, etc.) instead of having to always use the default settings

• New linters
  • ExampleWithoutNameLinter
  • OutlineWithSingleExampleRowLinter
  • TestWithTooManyStepsLinter

• Custom linters, formatters, and command line usability