Add gherkin lint in the project

Author: WarleyGabriel

.gherkin-lintrc.json

@@ -0,0 +1,41 @@
+{
+  "no-files-without-scenarios": "on",
+  "no-unnamed-features": "on",
+  "no-unnamed-scenarios": "on",
+  "no-dupe-scenario-names": ["on", "in-feature"],
+  "no-dupe-feature-names": "on",
+  "no-partially-commented-tag-lines": "on",
+  "indentation": [
+    "on",
+    {
+      "Feature": 0,
+      "Background": 4,
+      "Scenario": 4,
+      "given": 8,
+      "when": 8,
+      "then": 8,
+      "and": 12,
+      "feature tag": 0,
+      "scenario tag": 4,
+      "Examples": 8,
+      "example": 8
+    }
+  ],
+  "no-trailing-spaces": "on",
+  "new-line-at-eof": ["on", "yes"],
+  "no-multiple-empty-lines": "on",
+  "no-empty-file": "on",
+  "no-scenario-outlines-without-examples": "on",
+  "use-and": "on",
+  "no-duplicate-tags": "on",
+  "no-superfluous-tags": "on",
+  "no-homogenous-tags": "off",
+  "one-space-between-tags": "on",
+  "no-unused-variables": "on",
+  "no-background-only-scenario": "on",
+  "no-empty-background": "on",
+  "scenario-size": [
+    "on",
+    { "steps-length": { "Background": 10, "Scenario": 75 } }
+  ]
+}

.huskyrc.json

@@ -1,5 +1,5 @@
 {
   "hooks": {
-    "pre-commit": "npm run code:format && npm run build"
+    "pre-commit": "npm run code:format && npm run code:gherkin && npm run build"
   }
 }

README.md

@@ -19,7 +19,7 @@ npm install
 Run e2e tests:
 
 ```bash
-yarn tests:e2e
+npm run tests:e2e
 ```
 
 ## Spoken Languages
@@ -33,13 +33,13 @@ If you want to use another language in features files, you can see this [doc](ht
 Run this command to generate the allure report in the directory `./test-report/allure-report`:
 
 ```bash
-yarn report:generate
+npm run report:generate
 ```
 
 You can run this command to start a server on your machine and open the allure report on the browser:
 
 ```bash
-yarn report:open
+npm run report:open
 ```
 
 ### Time line reporter
@@ -51,5 +51,13 @@ You can see [Timeline report](https://github.com/QualityOps/wdio-timeline-report
 Run to format the code:
 
 ```bash
-yarn code:format
+npm run code:format
+```
+
+## Gherkin lint
+
+We use [Gherkin lint](https://github.com/vsiakka/gherkin-lint) to keep the feature files organized.
+
+```bash
+npm run code:gherkin
 ```

package-lock.json

@@ -9,6 +9,7 @@
   "scripts": {
     "build": "rm -rf ./dist && npx tsc && cp -R ./src/test/e2e/features ./dist/src/test/e2e",
     "code:format": "prettier --check \"src/**/*.ts*\" --write",
+    "code:gherkin": "npx gherkin-lint -c .gherkin-lintrc.json src/test/e2e/features",
     "report:generate": "npx allure generate --clean ./test-report/allure-result/ -o ./test-report/allure-report",
     "report:open": "npx allure open test-report/allure-report",
     "tests:e2e": "wdio ./dist/wdio.conf.js"
@@ -35,6 +36,7 @@
     "@types/node": "^14.6.4",
     "husky": "^4.3.0",
     "prettier": "^2.1.1",
+    "gherkin-lint": "^4.1.2",
     "ts-node": "^9.0.0",
     "typescript": "^4.0.2"
   }

package.json

@@ -1,9 +1,7 @@
 Feature: Performing a login
 
-    Background:
-        Given I'm on the login page
-
     Scenario: Login with a default user
+        Given I'm on the login page
         When I log in with a default user
         Then show a welcome message on the site
-        And show user name 'Leandro Nelson Gael Castro' on the site
+            And show user name 'Leandro Nelson Gael Castro' on the site

src/test/e2e/features/Login.feature

@@ -2,13 +2,13 @@ Feature: Sending message to customer service
 
     Scenario: Show the customer service label
         Given I'm on the login page
-        And I log in with a default user
+            And I log in with a default user
         When I'm on the contact page
         Then the system shows a customer service label
 
     Scenario: Attaching a document to the message to the customer
         Given I'm on the login page
-        And I log in with a default user
-        And I'm on the contact page
+            And I log in with a default user
+            And I'm on the contact page
         When I send a message with a document
         Then the system shows a successful message