# pickle-lint > A Gherkin linter/validator written in javascript Latest version **3.1.3** (published 2019-05-04) · ISC license · 0 weekly downloads ## Install ```sh npm install pickle-lint pnpm add pickle-lint yarn add pickle-lint bun add pickle-lint ``` Provides the command `pickle-lint`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 3.1.3 | | Published | 2019-05-04 | | First published | 2019-04-07 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 3 | | Unpacked size | 65.4 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 1 | | Author | Vasiliki Siakka | | Maintainers | xgbuils | | Keywords | gherkin, linter, cucumber | ## Links - npm: https://www.npmjs.com/package/pickle-lint - Repository: https://github.com/xgbuils/pickle-lint - Homepage: https://github.com/xgbuils/pickle-lint#readme - Issues: https://github.com/xgbuils/pickle-lint/issues - npm.io page: https://npm.io/package/pickle-lint ## Dependencies (3) - [glob](https://npm.io/package/glob.md) ^7.1.3 - [gherkin](https://npm.io/package/gherkin.md) 5.1.0 - [commander](https://npm.io/package/commander.md) 2.20.0 ## Alternatives - [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads - [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads - [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads - [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads - [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads ## Recent versions - 3.1.3 (latest) — 2019-05-04 - 3.1.2 — 2019-05-01 - 3.1.1 — 2019-04-20 - 3.1.0 — 2019-04-07 ## README # Pickle lint [![Travis CI][1]][2] [![Dependency Status][3]][4] [![Dev Dependency Status][5]][6] [![npm Version][7]][8] [![Coverage Status][9]][10] Uses [Gherkin](https://github.com/cucumber/gherkin-javascript) to parse feature files and runs linting against the default rules, and the optional rules you specified in your `.gherkin-lintrc` file. `pickle-lint` is forked from [gherkin-lint](https://www.npmjs.com/package/gherkin-lint) and aims to: - solve critical bugs of the project. - improve the code quality adding more tests and moving side effects(logging, file reading, etc) to the top of the application. - solve [issues](https://github.com/vsiakka/gherkin-lint/issues) that have been open for a long time. - improve the documentation. If `gherkin-lint` is maintained again, `pickle-lint` will try to be merged into [gherkin-lint](https://www.npmjs.com/package/gherkin-lint). ## Installation ``` npm install pickle-lint ``` ## Demo To see the output for all the errors that the linter can detect run: ``` git clone https://github.com/xgbuils/pickle-lint.git npm run demo ``` Or check this: ![console](http://i.imgur.com/YaH4Anu.png) ## Available rules | Name | Functionality | |---------------------------------------------|------------------------------------------------------------------------------------------| | `no-tags-on-backgrounds` * | Disallows tags on Background | | `one-feature-per-file` * | Disallows multiple Feature definitions in the same file | | `up-to-one-background-per-file` * | Disallows multiple Background definition in the same file | | `no-multiline-steps` * | Disallows mutiline Steps | | `no-examples-in-scenarios` | Disallow the use of "Examples" in scenarios | |   | | | [`allowed-tags`](#allowed-tags) | Just the listed tags are allowed | | [`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-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-file` | Disallows empty feature files | | `no-files-without-scenarios` | Disallows files with no scenarios | | `no-homogenous-tags` | Disallows tags present on every Scenario in a Feature, rather than on the Feature itself | | `no-multiple-empty-lines` | Disallows multiple empty lines | | `no-partially-commented-tag-lines` | Disallows partially commented tag lines | | [`no-restricted-tags`](#no-restricted-tags) | Disallow use of particular @tags | | `no-scenario-outlines-without-examples` | Disallows scenario outlines without examples | | `no-superfluous-tags` | Disallows tags present on a Feature and a Scenario in that Feature | | `no-trailing-spaces` | Disallows trailing spaces | | `no-unnamed-features` | Disallows empty Feature name | | `no-unnamed-scenarios` | Disallows empty Scenario name | | `no-unused-variables` | Disallows unused variables in scenario outlines | | `one-space-between-tags` | Tags on the same time must be separated by a single space | | `use-and` | Disallows repeated step names requiring use of And instead | \* These rules cannot be turned off because they detect undocumented cucumber functionality that causes the [gherkin](https://github.com/cucumber/gherkin-javascript) parser to crash. ## Rule Configuration The not-configurable rules are turned on by default and cannot be turned off. Configurable rules can be customized using a [file](#configuration-file). The configurable rules are off by default. To turn them on, you will need to create a json file, where you specify the name of each rule and its desired state (which can be "on" or "off"). Eg: ``` { "no-unnamed-features": "on" } ``` will turn on the `no-unnamed-features` rule. ### allowed-tags `allowed-tags` must be configured with list of tags for it to have any effect: ``` { "allowed-tags": ["on", {"tags": ["@watch", "@wip", "@todo"]}] } ``` Any tag not included in this list won't be allowed. ### indentation `indentation` can be configured in a more granular level and uses following rules by default: - Expected indentation for Feature, Background, Scenario, Examples heading: 0 spaces - Expected indentation for Steps and each example: 2 spaces You can override the defaults for `indentation` like this: ``` { "indentation" : [ "on", { "Feature": 0, "Background": 0, "Scenario": 0, "Step": 2, "Examples": 0, "example": 2, "given": 2, "when": 2, "then": 2, "and": 2, "but": 2, "feature tag": 0, "scenario tag": 0 } ] } ``` 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` can be configured separately for Feature, Scenario and Step names. The default is 70 characters for each of these: ``` { "name-length" : ["on", { "Feature": 70, "Scenario": 70, "Step": 70 }] } ``` ### new-line-at-eof `new-line-at-eof` can also be configured to enforcing or disallowing new lines at EOF. - To enforce new lines at EOF: ``` { "new-line-at-eof": ["on", "yes"] } ``` - To disallow new lines at EOF: ``` { "new-line-at-eof": ["on", "no"] } ``` ### no-restricted-tags `no-restricted-tags` must be configured with list of tags for it to have any effect: ``` { "no-restricted-tags": ["on", {"tags": ["@watch", "@wip", "@todo"]}] } ``` ## Configuration File The default name for the configuration file is `.gherkin-lintrc` and it's expected to be in your working directory. If you are using a file with a different name or a file in a different folder, you will need to specify the `-c` or `--config` option and pass in the relative path to your configuration file. Eg: `pickle-lint -c path/to/configuration/file.extention` You can find an example configuration file, that turns on all of the rules in the root of this repo (.gherkin-lintrc). ## Ignoring Feature Files There are 2 ways you can specify files that the linter should ignore: 1. Add a `.gherkin-lintignore` file in your working directory and specify one glob pattern per file line 1. Use the command line option`-i` or `--ignore`, pass in a comma separated list of glob patterns. If specified, the command line option will override the `.gherkin-lintignore` file. ## Custom rules You can specify one more more custom rules directories by using the `-r` or `--rulesdir` command line option. Rules in the given directories will be available additionally to the default rules. Example: ``` pickle-lint --rulesdir "/path/to/my/rulesdir" --rulesdir "from/cwd/rulesdir" ``` Paths can either be absolute or relative to the current working directory. Have a look at the `src/rules/` directory for examples; The `no-empty-file` rule is a good example to start with. [1]: https://travis-ci.org/xgbuils/pickle-lint.svg?branch=master [2]: https://travis-ci.org/xgbuils/pickle-lint [3]: https://david-dm.org/xgbuils/pickle-lint.svg [4]: https://david-dm.org/xgbuils/pickle-lint [5]: https://david-dm.org/xgbuils/pickle-lint/dev-status.svg [6]: https://david-dm.org/xgbuils/pickle-lint?type=dev [7]: https://img.shields.io/npm/v/pickle-lint.svg [8]: https://www.npmjs.com/package/pickle-lint [9]: https://coveralls.io/repos/github/xgbuils/pickle-lint/badge.svg?branch=master [10]: https://coveralls.io/github/xgbuils/pickle-lint?branch=master --- _Source: https://npm.io/package/pickle-lint · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._