https://github.com/gplint/gplint
A Gherkin/Pickle linter written in javascript
https://github.com/gplint/gplint
cucumber gherkin lint linter linting pickle testing
Last synced: 2 months ago
JSON representation
A Gherkin/Pickle linter written in javascript
- Host: GitHub
- URL: https://github.com/gplint/gplint
- Owner: gplint
- License: isc
- Created: 2021-09-22T11:51:37.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-15T02:58:18.000Z (2 months ago)
- Last Synced: 2025-04-15T16:38:35.076Z (2 months ago)
- Topics: cucumber, gherkin, lint, linter, linting, pickle, testing
- Language: TypeScript
- Homepage: https://gplint.github.io
- Size: 2.88 MB
- Stars: 6
- Watchers: 1
- Forks: 3
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# GPLint (Gherkin/Pickle Linter)
[](https://github.com/gplint/gplint/actions/workflows/test.yml)
[](https://codecov.io/gh/gplint/gplint)
[](https://www.npmjs.com/package/gplint)
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 `.gplintrc` file.
Forked from [gherkin-lint](https://github.com/vsiakka/gherkin-lint)
## Documentation
Access to the documentation site to know how to use GPLint: https://gplint.github.io/
## Quickstart
We encourage to check the site for complete documentation, but as quick start you can follow this:
### Installation
Install as development dependency:
```shell
npm install --save-dev gplint
```
### Create basic configuration
Set some basic rules to validate your gherkin files, to do that, create a file called `.gplintrc` with the following
content:
#### **`.gplintrc`**
```json
{
"allow-all-caps": [
"error",
{
"Global": false,
"Description": false,
"ExampleHeader": true,
"ExampleBody": true
}
],
"allow-all-lowercase": [
"error",
{
"Global": false,
"Description": false,
"Step": true,
"ExampleHeader": true,
"ExampleBody": true
}
],
"file-name": [
"warn",
{
"style": "camelCase",
"allowAcronyms": true
}
],
"keywords-in-logical-order": [
"error",
{
"detectMissingKeywords": true
}
],
"no-superfluous-tags": "warn",
"no-unnamed-features": "error",
"no-unnamed-scenarios": "error",
"no-unused-variables": "warn"
}
```
### Run it!
Run it, checking the Gherkin files you have on `test/features` folder.
```shell
gplint tests/features
```