From c5f06cdf8802b6d71a61d1452b8fc627466fd995 Mon Sep 17 00:00:00 2001 From: Anne Brouwers Date: Tue, 28 Jun 2022 17:20:19 +0200 Subject: [PATCH] Add Gherkin page to docs --- docs/_data/sidebars/pmd_sidebar.yml | 3 +++ docs/pages/pmd/languages/gherkin.md | 15 +++++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 docs/pages/pmd/languages/gherkin.md diff --git a/docs/_data/sidebars/pmd_sidebar.yml b/docs/_data/sidebars/pmd_sidebar.yml index 81d095e3980..f7ab16ddb0d 100644 --- a/docs/_data/sidebars/pmd_sidebar.yml +++ b/docs/_data/sidebars/pmd_sidebar.yml @@ -382,6 +382,9 @@ entries: - title: HTML url: /pmd_languages_html.html output: web, pdf + - title: Gherkin + url: /pmd_languages_gherkin.html + output: web, pdf - title: Developer Documentation output: web, pdf folderitems: diff --git a/docs/pages/pmd/languages/gherkin.md b/docs/pages/pmd/languages/gherkin.md new file mode 100644 index 00000000000..6ab5b6f688b --- /dev/null +++ b/docs/pages/pmd/languages/gherkin.md @@ -0,0 +1,15 @@ +--- +title: Gherkin +permalink: pmd_languages_gherkin.html +--- + +The [Gherkin](https://cucumber.io/docs/gherkin/) language is used to define test cases for the [Cucumber](https://cucumber.io/) testing tool for behavior-driven development. The Gherkin syntax is designed to be +non-technical, making it human-readable for a wide audience. + +## Support in PMD +Starting from version 6.48.0, Gherkin support was added to CPD. + +### Limitations +- Support for Gherkin only extends to CPD to detect code duplication in Cucumber test cases. +- While Gherkin keywords have been translated into various +languages, CPD currently supports only the English version of the Gherkin language.