feat!: make naming around package filters more consistent (#462)

.github/workflows/validate.yaml

@@ -47,7 +47,7 @@ jobs:
       - name: Install Tools
         run: ./.github/workflows/scripts/install-tools.sh
       - name: Check formatting
-        run: melos format-check
+        run: melos format:check
 
   test_linux:
     runs-on: ubuntu-latest

docs/commands/run.mdx

@@ -1,19 +1,22 @@
 ---
 title: Run Command
-description: "Learn more about the `run` command in Melos."
+description: 'Learn more about the `run` command in Melos.'
 ---
 
 # Run Command
 
-Run a [script](/configuration/scripts) by name defined in the workspace `melos.yaml` config file.
+Run a [script](/configuration/scripts) by name defined in the workspace
+`melos.yaml` config file.
 
 ```bash
 melos run <name>
 ```
 
 ## --no-select
 
-Skips the prompt to select a package (if defined in the script configuration). Filters defined in the scripts "select-package" options will however still be applied.
+Skips the prompt to select a package (if defined in the script configuration).
+Filters defined in the script's "packageFilters" options will however still be
+applied.
 
 ```bash
 melos run <name> --no-select

docs/configuration/overview.mdx

@@ -303,6 +303,11 @@ Package filters to match packages that should be included in the changelog.
 
 See [Filtering Packages](/filters) for all available filters.
 
+<Warning>
+  The filter names in `packageFilters` are camel cased. For example, for the
+  equivalent of the command line option `--file-exists` use `fileExists`.
+</Warning>
+
 ### `command/version/changelogs/description`
 
 > optional

docs/configuration/scripts.mdx

@@ -79,7 +79,7 @@ scripts:
       concurrency: 1
 ```
 
-See the [`select-package`](/configuration/scripts#scriptsselect-package) option
+See the [`packageFilters`](/configuration/scripts#scriptspackagefilters) option
 for filtering the packages to execute the command in.
 
 ## `scripts/*/exec/concurrency`
@@ -104,25 +104,30 @@ depend on each other. Defaults to `false`.
 
 A map of environment variables that will be passed to the executed command.
 
-## `scripts/*/select-package`
+## `scripts/*/packageFilters`
 
 The [`melos exec`](/commands/exec) command allows you to execute a command for
 multiple packages. When used in a script, you can declare filter options in the
-`select-packages` section.
+`packageFilters` section.
 
 The `hello_flutter` script below is only executed in Flutter packages:
 
 ```yaml
 scripts:
   hello_flutter:
     exec: echo 'Hello $(dirname $PWD)'
-    select-package:
+    packageFilters:
       flutter: true
 ```
 
 See the [global options](/filters) for a list of supported filters.
 
-When running a script that uses `select-package`, you will be prompted to select
+<Warning>
+  The filter names in `packageFilters` are camel cased. For example, for the
+  equivalent of the command line option `--file-exists` use `fileExists`.
+</Warning>
+
+When running a script that uses `packageFilters`, you will be prompted to select
 the package to execute the script in. If you want to skip this prompt and run
 the script in all packages, use the `--no-select` option.
 

docs/guides/migrations.mdx

@@ -66,3 +66,31 @@ command, like for all other commands.
 
 The new `preVersionCommmit` hook is executed before the version commit is
 created and is the equivalent of the previous `version` hook.
+
+### Package filters
+
+The `select-package` option for scripts has been renamed to `packageFilters`.
+This brings it in line with `command/version/changelogs/packageFilters`.
+
+The names of filters specified in `packageFilters` are now camel cased instead
+of kebab cased.
+
+For example, take the following `test` script configuration:
+
+```yaml
+scripts:
+  test:
+    exec: dart test
+    packageFilters:
+      dirExists: test
+```
+
+This would previously have been written as:
+
+```yaml
+scripts:
+  test:
+    exec: dart test
+    select-package:
+      dir-exists: test
+```

melos.yaml

@@ -21,7 +21,7 @@ scripts:
     description: Format Dart code.
     run: dart format .
 
-  format-check:
+  format:check:
     description: Check formatting of Dart code.
     run: dart format --output none --set-exit-if-changed .
 
@@ -34,8 +34,8 @@ scripts:
     run: dart test
     exec:
       concurrency: 1
-    select-package:
-      dir-exists:
+    packageFilters:
+      dirExists:
         - 'test/'
     # This tells Melos tests to ignore env variables passed to tests from `melos run test`
     # as they could change the behaviour of how tests filter packages.

packages/melos/lib/melos.dart

@@ -15,9 +15,9 @@ export 'src/global_options.dart' show GlobalOptions;
 export 'src/logging.dart' show MelosLogger, ToMelosLoggerExtension;
 export 'src/package.dart'
     show
-        InvalidPackageFilterException,
+        InvalidPackageFiltersException,
         Package,
-        PackageFilter,
+        PackageFilters,
         PackageMap,
         PackageType;
 export 'src/workspace.dart' show IdeWorkspace, MelosWorkspace;

packages/melos/lib/src/command_runner/base.dart

@@ -139,7 +139,7 @@ abstract class MelosCommand extends Command<void> {
     );
   }
 
-  PackageFilter parsePackageFilter(
+  PackageFilters parsePackageFilters(
     String workingDirPath, {
     bool diffEnabled = true,
   }) {
@@ -153,7 +153,7 @@ abstract class MelosCommand extends Command<void> {
     final scope = argResults![filterOptionScope] as List<String>? ?? [];
     final ignore = argResults![filterOptionIgnore] as List<String>? ?? [];
 
-    return PackageFilter(
+    return PackageFilters(
       scope: scope
           .map((e) => createGlob(e, currentDirectoryPath: workingDirPath))
           .toList(),

packages/melos/lib/src/command_runner/bootstrap.dart

@@ -42,7 +42,7 @@ class BootstrapCommand extends MelosCommand {
 
     return melos.bootstrap(
       global: global,
-      filter: parsePackageFilter(config.path),
+      packageFilters: parsePackageFilters(config.path),
     );
   }
 }

packages/melos/lib/src/command_runner/clean.dart

@@ -37,7 +37,7 @@ class CleanCommand extends MelosCommand {
 
     await melos.clean(
       global: global,
-      filter: parsePackageFilter(config.path),
+      packageFilters: parsePackageFilters(config.path),
     );
   }
 }

packages/melos/lib/src/command_runner/exec.dart

@@ -66,7 +66,7 @@ class ExecCommand extends MelosCommand {
 
     final melos = Melos(logger: logger, config: config);
 
-    final packageFilter = parsePackageFilter(config.path);
+    final packageFilters = parsePackageFilters(config.path);
     final concurrency = int.parse(argResults!['concurrency'] as String);
     final failFast = argResults!['fail-fast'] as bool;
     final orderDependents = argResults!['order-dependents'] as bool;
@@ -77,7 +77,7 @@ class ExecCommand extends MelosCommand {
       failFast: failFast,
       orderDependents: orderDependents,
       global: global,
-      filter: packageFilter,
+      packageFilters: packageFilters,
     );
   }
 }

packages/melos/lib/src/command_runner/list.dart

@@ -93,7 +93,7 @@ class ListCommand extends MelosCommand {
     return melos.list(
       long: long,
       global: global,
-      filter: parsePackageFilter(config.path),
+      packageFilters: parsePackageFilters(config.path),
       relativePaths: relative,
       kind: kind,
     );

packages/melos/lib/src/command_runner/publish.dart

@@ -57,11 +57,11 @@ class PublishCommand extends MelosCommand {
     final yes = argResults!['yes'] as bool || false;
 
     final melos = Melos(logger: logger, config: config);
-    final filter = parsePackageFilter(config.path);
+    final packageFilters = parsePackageFilters(config.path);
 
     return melos.publish(
       global: global,
-      filter: filter,
+      packageFilters: packageFilters,
       dryRun: dryRun,
       force: yes,
       gitTagVersion: gitTagVersion,

packages/melos/lib/src/command_runner/run.dart

@@ -24,7 +24,7 @@ class RunCommand extends MelosCommand {
       'no-select',
       negatable: false,
       help: 'Skips the prompt to select a package (if defined in the script '
-          'configuration). Filters defined in the scripts "select-package" '
+          """configuration). Filters defined in the script's "packageFilters" """
           'options will however still be applied.',
     );
   }

packages/melos/lib/src/command_runner/script.dart

@@ -28,7 +28,7 @@ class ScriptCommand extends MelosCommand {
       'no-select',
       negatable: false,
       help: 'Skips the prompt to select a package (if defined in the script '
-          'configuration). Filters defined in the scripts "select-package" '
+          """configuration). Filters defined in the script's "packageFilters" """
           'options will however still be applied.',
     );
   }

packages/melos/lib/src/command_runner/version.dart

@@ -192,7 +192,7 @@ class VersionCommand extends MelosCommand {
       return melos.version(
         // We only want to version the specified package and not all packages
         // that could be versioned.
-        filter: PackageFilter(scope: [Glob(packageName)]),
+        packageFilters: PackageFilters(scope: [Glob(packageName)]),
         manualVersions: {packageName: versionChange},
         force: force,
         gitTag: tag,
@@ -235,7 +235,7 @@ class VersionCommand extends MelosCommand {
 
       await melos.version(
         global: global,
-        filter: parsePackageFilter(config.path),
+        packageFilters: parsePackageFilters(config.path),
         force: force,
         gitTag: tag,
         releaseUrl: releaseUrl,

packages/melos/lib/src/commands/bootstrap.dart

@@ -1,8 +1,12 @@
 part of 'runner.dart';
 
 mixin _BootstrapMixin on _CleanMixin {
-  Future<void> bootstrap({GlobalOptions? global, PackageFilter? filter}) async {
-    final workspace = await createWorkspace(global: global, filter: filter);
+  Future<void> bootstrap({
+    GlobalOptions? global,
+    PackageFilters? packageFilters,
+  }) async {
+    final workspace =
+        await createWorkspace(global: global, packageFilters: packageFilters);
 
     return _runLifecycle(
       workspace,

packages/melos/lib/src/commands/clean.dart

@@ -1,8 +1,12 @@
 part of 'runner.dart';
 
 mixin _CleanMixin on _Melos {
-  Future<void> clean({GlobalOptions? global, PackageFilter? filter}) async {
-    final workspace = await createWorkspace(global: global, filter: filter);
+  Future<void> clean({
+    GlobalOptions? global,
+    PackageFilters? packageFilters,
+  }) async {
+    final workspace =
+        await createWorkspace(global: global, packageFilters: packageFilters);
 
     return _runLifecycle(
       workspace,

packages/melos/lib/src/commands/exec.dart

@@ -4,12 +4,13 @@ mixin _ExecMixin on _Melos {
   Future<void> exec(
     List<String> execArgs, {
     GlobalOptions? global,
-    PackageFilter? filter,
+    PackageFilters? packageFilters,
     int concurrency = 5,
     bool failFast = false,
     bool orderDependents = false,
   }) async {
-    final workspace = await createWorkspace(global: global, filter: filter);
+    final workspace =
+        await createWorkspace(global: global, packageFilters: packageFilters);
     final packages = workspace.filteredPackages.values;
 
     await _execForAllPackages(

packages/melos/lib/src/commands/list.dart

@@ -8,10 +8,11 @@ mixin _ListMixin on _Melos {
     GlobalOptions? global,
     bool long = false,
     bool relativePaths = false,
-    PackageFilter? filter,
+    PackageFilters? packageFilters,
     ListOutputKind kind = ListOutputKind.column,
   }) async {
-    final workspace = await createWorkspace(global: global, filter: filter);
+    final workspace =
+        await createWorkspace(global: global, packageFilters: packageFilters);
 
     switch (kind) {
       case ListOutputKind.graph:

packages/melos/lib/src/commands/publish.dart

@@ -3,13 +3,14 @@ part of 'runner.dart';
 mixin _PublishMixin on _ExecMixin {
   Future<void> publish({
     GlobalOptions? global,
-    PackageFilter? filter,
+    PackageFilters? packageFilters,
     bool dryRun = true,
     bool gitTagVersion = true,
     // yes
     bool force = false,
   }) async {
-    final workspace = await createWorkspace(global: global, filter: filter);
+    final workspace =
+        await createWorkspace(global: global, packageFilters: packageFilters);
 
     logger.command('melos publish${dryRun ? " --dry-run" : ''}');
     logger.child(targetStyle(workspace.path)).newLine();

packages/melos/lib/src/commands/run.dart

@@ -78,8 +78,8 @@ mixin _RunMixin on _Melos {
     final workspace = await MelosWorkspace.fromConfig(
       config,
       global: global,
-      filter: script.filter?.copyWithUpdatedIgnore([
-        ...script.filter!.ignore,
+      packageFilters: script.packageFilters?.copyWithUpdatedIgnore([
+        ...script.packageFilters!.ignore,
         ...config.ignore,
       ]),
       logger: logger,
@@ -94,14 +94,14 @@ mixin _RunMixin on _Melos {
       ...script.env,
     };
 
-    if (script.filter != null) {
+    if (script.packageFilters != null) {
       final packages = workspace.filteredPackages.values.toList();
 
       var choices = packages.map((e) => AnsiStyles.cyan(e.name)).toList();
 
       if (choices.isEmpty) {
         throw NoPackageFoundScriptException._(
-          script.filter,
+          script.packageFilters,
           script.name,
         );
       }
@@ -167,9 +167,9 @@ mixin _RunMixin on _Melos {
 }
 
 class NoPackageFoundScriptException implements MelosException {
-  NoPackageFoundScriptException._(this.filter, this.scriptName);
+  NoPackageFoundScriptException._(this.filters, this.scriptName);
 
-  final PackageFilter? filter;
+  final PackageFilters? filters;
   final String? scriptName;
 
   @override