added information about language hint from the feature file name to t…

…he language flag description
hedhyw · Jun 20, 2024 · bdbcbb3 · bdbcbb3
1 parent ef24c9f
commit bdbcbb3
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -205,7 +205,10 @@ Usage of gherkingen [FEATURE_FILE]:
   -help
         print usage
   -language string
-        natural language for the feature (default "en")
+        Specifies the natural language used to describe the feature.
+        This flag is optional if language information is included in the feature file name.
+        The file name should be formatted as follows: <description>.<language_hint>.feature if language hint is included, or <description>.feature if it is not.
+        When provided, the 'language' flag takes precedence over the language hint from the file name. (default "en")
   -languages
         list supported natural feature languages
   -list

diff --git a/internal/app/app.go b/internal/app/app.go
@@ -77,7 +77,11 @@ func Run(arguments []string, out io.Writer, version string) (err error) {
 	language := flagSet.String(
 		"language",
 		defaultLanguage,
-		"natural language for the feature",
+		"Specifies the natural language used to describe the feature.\n"+
+			"This flag is optional if language information is included in the feature file name.\n"+
+			"The file name should be formatted as follows: <description>.<language_hint>.feature if language hint is included, "+
+			"or <description>.feature if it is not.\n"+
+			"When provided, the 'language' flag takes precedence over the language hint from the file name.",
 	)
 	listLanguages := flagSet.Bool(
 		"languages",