Failure count on format

Author: kieran-ryan

.gitignore

@@ -1 +1,2 @@
 /.idea
+/.vscode

README.md

@@ -54,29 +54,42 @@ Gherkin Utils is [available on Maven Central](https://central.sonatype.com/artif
 
 ## Command line
 
+```bash
+-> npx @cucumber/gherkin-utils format features
+❌ 7 files failed to format
+🥒 14 files left unchanged
+🥒 25 files reformatted
+```
+
 To run Gherkin Utils as a formatter, try any of the following:
 
-```console
+```bash
 # Format `file.feature`
 npx @cucumber/gherkin-utils format features/file.feature
+# Format `one.feature` and `two.feature`
+npx @cucumber/gherkin-utils format features/one.feature features/two.feature
 # Format all feature files in `features/` (and any subdirectories)
 npx @cucumber/gherkin-utils format features/
+# Format all feature files ending with `_test.feature` in `features`
+npx @cucumber/gherkin-utils format features/**/*_test.feature
 # Check files that would be reformatted in `features/`
 npx @cucumber/gherkin-utils format --check features/
 # Check files that would be reformatted in `features/` and output the diff
 npx @cucumber/gherkin-utils format --diff features/
 ```
 
-The following example translates all `.feature` files to `.feature.md` files and then deletes the `.feature` files (see [Markdown with Gherkin](https://github.com/cucumber/common/blob/main/gherkin/MARKDOWN_WITH_GHERKIN.md)).
-**Note**: Globs must be quoted to prevent the shell from expanding the globs.
+To convert to [Markdown with Gherkin](https://github.com/cucumber/common/blob/main/gherkin/MARKDOWN_WITH_GHERKIN.md) or feature files while formatting, try the following:
 
-```console
-npx @cucumber/gherkin-utils format --move "features/**/*.feature" "features/**/*.feature.md"
+```bash
+# Format all feature files in `features/` (and any subdirectories) and convert to gherkin markdown
+npx @cucumber/gherkin-utils format --to-syntax=markdown features/
+# Format all feature files in `features/` (and any subdirectories) and convert to gherkin
+npx @cucumber/gherkin-utils format --to-syntax=gherkin features/
 ```
 
 For more details on usage, see the help menu.
 
-```console
+```bash
 npx @cucumber/gherkin-utils --help
 ```
 
@@ -89,35 +102,31 @@ This module can also be used as a library. It provides two main utilities, `pret
 This function takes a GherkinDocument as input and returns a pretty-printed representation in Gherkin or Markdown.
 
 ```javascript
-import {
-  AstBuilder,
-  GherkinClassicTokenMatcher,
-  Parser,
-} from "@cucumber/gherkin";
-import { pretty } from "@cucumber/gherkin-utils";
-import { IdGenerator } from "@cucumber/messages";
+import { AstBuilder, GherkinClassicTokenMatcher,Parser } from "@cucumber/gherkin";
+import { pretty } from "@cucumber/gherkin-utils"
+import { IdGenerator } from "@cucumber/messages"
 
-const uuidFn = IdGenerator.uuid();
+const uuidFn = IdGenerator.uuid()
 
-const builder = new AstBuilder(uuidFn);
-const matcher = new GherkinClassicTokenMatcher();
-const parser = new Parser(builder, matcher);
+const builder = new AstBuilder(uuidFn)
+const matcher = new GherkinClassicTokenMatcher()
+const parser = new Parser(builder, matcher)
 
 const feature = `Feature:
 Scenario:
-Given step text`;
+Given step text`
 
-const gherkinDocument = parser.parse(feature);
+const gherkinDocument = parser.parse(feature)
 
-const formattedGherkinFeature = pretty(gherkinDocument);
+const formattedGherkinFeature = pretty(gherkinDocument)
 /*
 Feature:
 
   Scenario:
     Given step text
 
 */
-const formattedGherkinMarkdownFeature = pretty(gherkinDocument, "markdown");
+const formattedGherkinMarkdownFeature = pretty(gherkinDocument, "markdown")
 /*
 # Feature:
 
@@ -147,16 +156,13 @@ By default, all elements are accepted, which means that if you want to do filter
 Here's an example:
 
 ```typescript
-import {
-  GherkinDocumentWalker,
-  rejectAllFilters,
-} from "@cucumber/gherkin-utils";
+import { GherkinDocumentWalker, rejectAllFilters } from "@cucumber/gherkin-utils"
 
 // Only keeps scenarios which name include 'magic'
 const filter = new GherkinDocumentWalker({
   ...rejectAllFilters,
   ...{ acceptScenario: (scenario) => scenario.name.includes("magic") },
-});
+})
 
 // Makes a list with all the scenario names
 const allScenarioNames: string[] = [];
@@ -165,7 +171,7 @@ const scenarioNameFinder = new GherkinDocumentWalker(
   {
     handleScenario: (scenario) => allScenarioNames.push(scenario.name),
   }
-);
+)
 ```
 
 ## Feedback

javascript/features/file.feature

@@ -0,0 +1,4 @@
+Feature:
+
+  Scenario:
+    Given something

javascript/features/fqile.feature

@@ -0,0 +1,4 @@
+Feature:
+
+  Scenario:
+    Given something

javascript/src/cli.ts

@@ -6,10 +6,15 @@ import { formatCommand, FormatOptions } from './commands/formatCommand'
 const program = new Command()
 program.version(version)
 
-// TODO: Default to running against the `features` directory
+const fileFormats = ['gherkin', 'markdown']
+
+// TODO: Default to running against the `features` directory?
 program
   .command('format')
-  .arguments('[paths...]')
+  .argument(
+    '[paths...]',
+    'One or more .feature or .feature.md files, or directories containing such files'
+  )
   .option(
     '--check',
     'Avoid writing any formatted files back; instead, exit with a non-zero status code if any files would have been modified, and zero otherwise'
@@ -19,15 +24,11 @@ program
     'Avoid writing any formatted files back; instead, output a diff of changes that would be made and exit with a non-zero status code if any files would have been modified, and zero otherwise'
   )
   .option('-l, --language <ISO 639-1>', 'specify the language (dialect) of the source')
-  .addOption(new Option('-f, --from-syntax <syntax>', 'from syntax').choices(['gherkin', 'markdown']))
-  .addOption(new Option('-t, --to-syntax <syntax>', 'to syntax').choices(['gherkin', 'markdown'])
-  )
+  // TODO: Deprecate `--from-syntax`
+  .addOption(new Option('-f, --from-syntax <syntax>', 'from syntax').choices(fileFormats))
+  .addOption(new Option('-t, --to-syntax <syntax>', 'to syntax').choices(fileFormats))
   .description(
-    `Formats one or more files or directories. STDIN is formatted and written to STDOUT (assuming gherkin syntax by default)`,
-    {
-      paths:
-        'One or more .feature or .feature.md files, or directories containing such files',
-    }
+    `Formats one or more files or directories. STDIN is formatted and written to STDOUT (assuming gherkin syntax by default)`
   )
   .action(async (files: string[], options: FormatOptions) => {
     await formatCommand(files, process.stdin.isTTY ? null : process.stdin, process.stdout, options)

javascript/src/commands/formatCommand.ts

@@ -5,11 +5,12 @@ import {
   Parser,
 } from '@cucumber/gherkin'
 import * as messages from '@cucumber/messages'
+import * as diff from 'diff'
 import fs, { unlink as unlinkCb } from 'fs'
 import path from 'path'
 import { Readable, Writable } from 'stream'
 import { promisify } from 'util'
-import * as diff from 'diff'
+
 import pretty, { Syntax } from '../pretty'
 
 const unlink = promisify(unlinkCb)
@@ -31,6 +32,8 @@ type FileFormat = {
 }
 
 // TODO: Support `.md` files
+// TODO: Support globs
+// TODO: Ignore conversion failures
 function getFeatureFiles(filePath: string): string[] {
   const stat = fs.statSync(filePath)
   let files: string[] = []
@@ -82,17 +85,31 @@ export async function formatCommand(
 
   let unchangedCount = 0
   let reformatCount = 0
+  let failuresCount = 0
 
   for (const fileFormat of fileFormats) {
-    const wouldBeReformatted = await convert(fileFormat, options.language, options)
-    wouldBeReformatted ? reformatCount++ : unchangedCount++
+    try {
+      const wouldBeReformatted = await convert(fileFormat, options.language, options)
+      wouldBeReformatted ? reformatCount++ : unchangedCount++
+    } catch (error) {
+      // TODO: Include file path
+      failuresCount++
+      console.error(`Failed to convert file: ${error.message}`)
+    }
+  }
+
+  if (failuresCount > 0) {
+    console.error(`❌ ${failuresCount} file${getPlural(failuresCount)} failed to format`)
   }
   if (unchangedCount > 0) {
-    console.log(`${unchangedCount} file${getPlural(unchangedCount)} left unchanged`)
+    console.log(`🥒 ${unchangedCount} file${getPlural(unchangedCount)} left unchanged`)
   }
   if (reformatCount > 0) {
     const tense = options.check ? 'would be ' : ''
-    console.log(`${reformatCount} file${getPlural(reformatCount)} ${tense}reformatted`)
+    console.log(`🥒 ${reformatCount} file${getPlural(reformatCount)} ${tense}reformatted`)
+    process.exit(1)
+  }
+  if (failuresCount > 0) {
     process.exit(1)
   }
 }
@@ -106,7 +123,7 @@ async function convert(fileFormat: FileFormat, language: string, options: Format
     parse(output, fileFormat.writableSyntax, gherkinDocument.feature?.language)
   } catch (err) {
     err.message += `The generated output is not parseable. This is a bug.
-Please report a bug at https://github.com/cucumber/common/issues/new
+Please report a bug at https://github.com/cucumber/gherkin/issues
 
 --- Generated ${fileFormat.writableSyntax} source ---
 ${output}
@@ -127,6 +144,7 @@ ${output}
   if (options.diff) {
     const differences = diff.createPatch('filename.feature', source, output)
     console.log(differences)
+    return true
   }
 
   const writable = fileFormat.writable()