Support directories containing square brackets

Related to #1196 [1].

[1] #1196

Author: badeball

CHANGELOG.md

@@ -20,6 +20,8 @@ Other changees:
 
 - Generate a temporary messages report in case of `JsonFormatter` errors, relates to [#1161](https://github.com/badeball/cypress-cucumber-preprocessor/issues/1161).
 
+- Support project directories containing square brackets, EG. `/home/[foo] my project/`, relates to [#1196](https://github.com/badeball/cypress-cucumber-preprocessor/discussions/1196).
+
 ## v20.1.2
 
 - Updated all dependencies, including esbuild, relates to [#1068](https://github.com/badeball/cypress-cucumber-preprocessor/issues/1068).

features/issues/1196 [foo].feature

@@ -0,0 +1,17 @@
+# https://github.com/badeball/cypress-cucumber-preprocessor/discussions/1196
+
+Feature: square brackets in directory name
+  Scenario:
+    Given a file named "cypress/e2e/a.feature" with:
+      """
+      Feature: a feature
+        Scenario: a scenario
+          Given a step
+      """
+    And a file named "cypress/support/step_definitions/steps.js" with:
+      """
+      const { Given } = require("@badeball/cypress-cucumber-preprocessor");
+      Given("a step", function() {})
+      """
+    When I run cypress
+    Then it passes

features/support/hooks.ts

@@ -9,6 +9,14 @@ const projectPath = path.join(__dirname, "..", "..");
 Before(async function ({ gherkinDocument, pickle }) {
   assert(gherkinDocument.uri, "Expected gherkinDocument.uri to be present");
 
+  /**
+   * Using the URI as the directory name of the temporary project, is imperative for the test of
+   * #1196 to actually test directory names containing square brackets. Consider this before
+   * changing the following line.
+   *
+   * @see features/issues/1196 [foo].feature
+   * @see https://github.com/badeball/cypress-cucumber-preprocessor/discussions/1196
+   */
   const relativeUri = path.relative(process.cwd(), gherkinDocument.uri);
 
   const { line } = formatterHelpers.PickleParser.getPickleLocation({

lib/diagnostics/diagnose.ts

@@ -115,6 +115,7 @@ export async function diagnose(configuration: {
     );
 
     const stepDefinitions = await getStepDefinitionPaths(
+      configuration.cypress.projectRoot,
       stepDefinitionPatterns,
     );
 

lib/step-definitions.ts

@@ -15,15 +15,19 @@ import {
   IPreprocessorConfiguration,
 } from "./preprocessor-configuration";
 
-import { ensureIsAbsolute } from "./helpers/paths";
-
 export async function getStepDefinitionPaths(
+  prjectRoot: string,
   stepDefinitionPatterns: string[],
 ): Promise<string[]> {
   return (
     await Promise.all(
       stepDefinitionPatterns.map((pattern) =>
-        glob.glob(pattern, { nodir: true, windowsPathsNoEscape: true }),
+        glob.glob(pattern, {
+          cwd: prjectRoot,
+          absolute: true,
+          nodir: true,
+          windowsPathsNoEscape: true,
+        }),
       ),
     )
   ).reduce((acum, el) => acum.concat(el), []);
@@ -84,24 +88,22 @@ export function getStepDefinitionPatterns(
 
   const stepDefinitions = [configuration.preprocessor.stepDefinitions].flat();
 
-  return stepDefinitions
-    .flatMap((pattern) => {
-      if (pattern.includes("[filepath]") && pattern.includes("[filepart]")) {
-        throw new Error(
-          `Pattern cannot contain both [filepath] and [filepart], but got ${util.inspect(
-            pattern,
-          )}`,
-        );
-      } else if (pattern.includes("[filepath]")) {
-        return pattern.replace("[filepath]", filepathReplacement);
-      } else if (pattern.includes("[filepart]")) {
-        return [
-          ...parts.map((part) => pattern.replace("[filepart]", part)),
-          path.normalize(pattern.replace("[filepart]", ".")),
-        ];
-      } else {
-        return pattern;
-      }
-    })
-    .map((pattern) => ensureIsAbsolute(projectRoot, pattern));
+  return stepDefinitions.flatMap((pattern) => {
+    if (pattern.includes("[filepath]") && pattern.includes("[filepart]")) {
+      throw new Error(
+        `Pattern cannot contain both [filepath] and [filepart], but got ${util.inspect(
+          pattern,
+        )}`,
+      );
+    } else if (pattern.includes("[filepath]")) {
+      return pattern.replace("[filepath]", filepathReplacement);
+    } else if (pattern.includes("[filepart]")) {
+      return [
+        ...parts.map((part) => pattern.replace("[filepart]", part)),
+        path.normalize(pattern.replace("[filepart]", ".")),
+      ];
+    } else {
+      return pattern;
+    }
+  });
 }

lib/template.ts

@@ -93,19 +93,16 @@ export async function compile(
       preprocessor,
     },
     uri,
-  );
+  ).map((pattern) => ensureIsRelative(configuration.projectRoot, pattern));
 
   debug(
     `for ${inspect(
       ensureIsRelative(configuration.projectRoot, uri),
-    )} yielded patterns ${inspect(
-      stepDefinitionPatterns.map((pattern) =>
-        ensureIsRelative(configuration.projectRoot, pattern),
-      ),
-    )}`,
+    )} yielded patterns ${inspect(stepDefinitionPatterns)}`,
   );
 
   const stepDefinitionPaths = await getStepDefinitionPaths(
+    configuration.projectRoot,
     stepDefinitionPatterns,
   );