Update README and configuration to support custom step folder paths

Author: olexale

README.md

@@ -429,6 +429,15 @@ targets:
 
 Since Patrol version 3.0.0, `IntegrationTestWidgetsFlutterBinding.ensureInitialized` must not be called. Set `includeIntegrationTestBinding` to `false`.
 
+### I don't like that the plugin creates steps under `test` folder. How to change that?
+
+You may set a relative path in the `build.yaml` file (see the `example` folder):
+```yaml
+relativeToTestFolder: false
+stepFolderName: integration_test/steps # if you want to have steps in the integration_test folder
+hookFolderName: integration_test/bdd_hooks # if you want to have hooks in the integration_test folder
+```
+
 ## Contributing
 
 If you find a bug or would like to request a new feature, just [open an issue](https://github.com/olexale/bdd_widget_test/issues/new). Your contributions are always welcome!

example/build.yaml

@@ -10,7 +10,7 @@ targets:
         options:
           includeIntegrationTestBinding: false # if false, integration test will not include binding; default is true
           stepFolderName: step # this trick is required to share steps between widget and integration tests
-          # stepFolderIsUnderTestFolder: false # if false, steps will be generated in the root of the package; default is true
+          # relativeToTestFolder: false # if false, steps will be generated in the root of the package; default is true
           # testMethodName: customTestMethodName
           include: package:bdd_widget_test/bdd_options.yaml # you may add defaul external steps with this line
           externalSteps:                                    # or list only steps that you need

lib/src/generator_options.dart

@@ -13,15 +13,15 @@ class GeneratorOptions {
     String? testMethodName,
     List<String>? externalSteps,
     String? stepFolderName,
-    bool? stepFolderIsUnderTestFolder,
+    bool? relativeToTestFolder,
     String? testerType,
     String? testerName,
     bool? addHooks,
     String? hookFolderName,
     this.include,
     bool? includeIntegrationTestBinding,
   })  : stepFolder = stepFolderName ?? _stepFolderName,
-        stepFolderIsUnderTestFolder = stepFolderIsUnderTestFolder ?? true,
+        relativeToTestFolder = relativeToTestFolder ?? true,
         testMethodName = testMethodName ?? _defaultTestMethodName,
         testerType = testerType ?? _defaultTesterType,
         testerName = testerName ?? _defaultTesterName,
@@ -37,8 +37,7 @@ class GeneratorOptions {
         testerName: json['testerName'] as String?,
         externalSteps: (json['externalSteps'] as List?)?.cast<String>(),
         stepFolderName: json['stepFolderName'] as String?,
-        stepFolderIsUnderTestFolder:
-            json['stepFolderIsUnderTestFolder'] as bool?,
+        relativeToTestFolder: json['relativeToTestFolder'] as bool?,
         addHooks: json['addHooks'] as bool?,
         hookFolderName: json['hookFolderName'] as String?,
         include: json['include'] is String
@@ -49,7 +48,7 @@ class GeneratorOptions {
       );
 
   final String stepFolder;
-  final bool stepFolderIsUnderTestFolder;
+  final bool relativeToTestFolder;
   final String testMethodName;
   final String testerType;
   final String testerName;
@@ -101,8 +100,7 @@ GeneratorOptions merge(GeneratorOptions a, GeneratorOptions b) =>
           a.testerName != _defaultTesterName ? a.testerName : b.testerName,
       stepFolderName:
           a.stepFolder != _stepFolderName ? a.stepFolder : b.stepFolder,
-      stepFolderIsUnderTestFolder:
-          a.stepFolderIsUnderTestFolder && b.stepFolderIsUnderTestFolder,
+      relativeToTestFolder: a.relativeToTestFolder && b.relativeToTestFolder,
       externalSteps: [...a.externalSteps, ...b.externalSteps],
       addHooks: a.addHooks || b.addHooks,
       hookFolderName: a.hookFolderName != _hookFolderName

lib/src/util/get_test_folder_name.dart

@@ -5,7 +5,7 @@ const _testFolderName = 'test';
 
 /// Returns the folder where step folder is located.
 String getPathToStepFolder(GeneratorOptions options) {
-  if (options.stepFolderIsUnderTestFolder) {
+  if (options.relativeToTestFolder) {
     return _testFolderName;
   }
   return fs.currentDirectory.path;

test/feature_generator_test.dart

@@ -59,7 +59,7 @@ void main() {
   test('existing step outside test folder should be found', () async {
     const bddOptions = '''
 stepFolderName: my_steps
-stepFolderIsUnderTestFolder: false
+relativeToTestFolder: false
 ''';
     fs.file('bdd_options.yaml')
       ..createSync()

test/step_folder_name_test.dart

@@ -102,7 +102,7 @@ void main() {
       input: featureFile,
       generatorOptions: const GeneratorOptions(
         stepFolderName: 'custom_steps',
-        stepFolderIsUnderTestFolder: false,
+        relativeToTestFolder: false,
       ),
     );
     expect(feature.dartContent, expectedFeatureDart);