gherkin-lint
Advanced tools
gherkin-lint - npm Package Compare versions
Comparing version 2.13.0 to 2.13.1
| { | ||
| "name": "gherkin-lint", | ||
| "version": "2.13.0", | ||
| "version": "2.13.1", | ||
| "description": "A Gherkin linter/validator written in javascript", | ||
@@ -5,0 +5,0 @@ "author": "Vasiliki Siakka", |
@@ -38,9 +38,10 @@ # Gherkin lint | ||
| | [`indentation`](#indentation) | Allows the user to specify indentation rules | | ||
| | [`max-scenarios-per-file`](#max-scenarios-per-file)| Allows the user to specify the max number of scenarios per feature file | | ||
| | [`name-length`](#name-length) | Allows restricting length of Feature/Scenario/Step names | | ||
| | [`new-line-at-eof`](#new-line-at-eof) | Disallows/enforces new line at EOF | | ||
| | `no-background-only-scenario` | Disallows background when there is just one scenario | | ||
| | `no-background-only-scenario` | Disallows background when there is just one scenario | | ||
| | `no-dupe-feature-names` | Disallows duplicate Feature names | | ||
| | `no-dupe-scenario-names` | Disallows duplicate Scenario names | | ||
| | `no-duplicate-tags` | Disallows duplicate tags on the same Feature or Scenario | | ||
| | `no-empty-background` | Disallows features with backgrounds without steps | | ||
| | `no-empty-background` | Disallows features with backgrounds without steps | | ||
| | `no-empty-file` | Disallows empty feature files | | ||
@@ -74,3 +75,3 @@ | `no-files-without-scenarios` | Disallows files with no scenarios | | ||
| ### `allowed-tags` | ||
| ### allowed-tags | ||
@@ -87,4 +88,5 @@ `allowed-tags` must be configured with list of tags for it to have any effect: | ||
| ### `indentation` | ||
| ### indentation | ||
| `indentation` can be configured in a more granular level and uses following rules by default: | ||
@@ -115,9 +117,20 @@ - Expected indentation for Feature, Background, Scenario, Examples heading: 0 spaces | ||
| } | ||
| ``` | ||
| There is no need to override all the defaults, as is done above, instead they can be overriden only where required. `Step` will be used as a fallback if the keyword of the step, eg. 'given', is not specified. If `feature tag` is not set then `Feature` is used as a fallback, and if `scenario tag` is not set then `Scenario` is used as a fallback. | ||
| This feature is able to handle all localizations of the gherkin steps. | ||
| ### max-scenarios-per-file | ||
| `max-scenarios-per-file` rule can be configured to set the number of max scenarios per file. The configuration looks like this: | ||
| ``` | ||
| { | ||
| "max-scenarios-per-file": {"on", {"maxScenarios": 10}} | ||
| } | ||
| ``` | ||
| The default value is 10. | ||
| ### `name-length` | ||
| ### name-length | ||
| `name-length` can be configured separately for Feature, Scenario and Step names. | ||
@@ -132,4 +145,5 @@ The default is 70 characters for each of these: | ||
| ### `new-line-at-eof` | ||
| ### new-line-at-eof | ||
| `new-line-at-eof` can also be configured to enforcing or disallowing new lines at EOF. | ||
@@ -149,4 +163,5 @@ - To enforce new lines at EOF: | ||
| ### `no-restricted-tags` | ||
| ### no-restricted-tags | ||
| `no-restricted-tags` must be configured with list of tags for it to have any effect: | ||
@@ -160,2 +175,3 @@ | ||
| ## Configuration File | ||
@@ -162,0 +178,0 @@ The default name for the configuration file is `.gherkin-lintrc` and it's expected to be in your working directory. |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.76%
51294
- Number of lines in readme file
- increased by9.04%
193