feat: add experimental support for positional arguments

Author: gonuit

lib/commands/run_command.dart

@@ -40,9 +40,9 @@ class RunCommand {
     for (final command in commands.whereType<ExecutableCommand>()) {
       stdout.writeln('${applyBoldGreen('>')} ${command.path}');
       stdout.writeln(
-        '${applyBoldGreen(r'$')} ${applyBold(command.command!)}\n',
+        '${applyBoldGreen(r'$')} ${applyBold(command.command)}\n',
       );
-      final exitCode = await bindings.execute(command.command!);
+      final exitCode = await bindings.execute(command.command);
 
       if (exitCode > 0) {
         throw RpsException('Command ended with a non zero exit code.');

lib/pubspec.dart

@@ -1,4 +1,7 @@
 import 'dart:io';
+import 'dart:math' as math;
+import 'package:equatable/equatable.dart';
+import 'package:meta/meta.dart';
 import 'package:path/path.dart' as p;
 import 'package:rps/rps_exception.dart';
 import 'package:yaml/yaml.dart';
@@ -9,6 +12,7 @@ class ScriptContext {
   final List<String> path;
   String get stringPath => path.join(' ');
 
+  /// List of remaining arguments
   List<String> get rest => arguments.sublist(position + 1);
 
   final int position;
@@ -43,66 +47,104 @@ class ScriptContext {
   }
 }
 
+@immutable
 abstract class PubspecCommand {
-  final String path;
-  final String? command;
+  String get path;
+  String? get command;
 
   /// Whether this command should be executed
   bool get executable;
+}
 
-  PubspecCommand(this.path, this.command);
-
-  @override
-  bool operator ==(Object other) {
-    return other is PubspecCommand &&
-        other.command == command &&
-        other.path == path;
-  }
+class PositionalArgument {
+  final int position;
+  final int start;
+  final int end;
 
-  @override
-  int get hashCode => Object.hash(path, command, runtimeType);
+  PositionalArgument(this.position, this.start, this.end);
 }
 
-class ExecutableCommand extends PubspecCommand {
+class ExecutableCommand extends PubspecCommand with EquatableMixin {
   @override
   bool get executable => true;
 
-  ExecutableCommand(super.path, super.command);
-
   @override
-  bool operator ==(Object other) {
-    return other is ExecutableCommand &&
-        other.command == command &&
-        other.path == path;
-  }
-
+  final String command;
   @override
-  int get hashCode => Object.hash(path, command, runtimeType);
+  final String path;
+
+  static final _positionalArgumentsRegexp = RegExp(r'\$\{\s{0,}[0-9]+\s{0,}\}');
+
+  ExecutableCommand._(this.command, this.path);
+
+  factory ExecutableCommand(String path, String command, List<String> rest) {
+    final argumentsInCommand = _positionalArgumentsRegexp.allMatches(command);
+
+    if (argumentsInCommand.isNotEmpty) {
+      final usedArguments = <int>{};
+      final filledCommand = command.replaceAllMapped(
+        _positionalArgumentsRegexp,
+        (match) {
+          final content = match.group(0)!;
+          final value = content.substring(2, content.length - 1).trim();
+          final argumentIndex = int.tryParse(value);
+          if (argumentIndex == null) {
+            throw RpsException(
+              "Bad argument script ($content). "
+              "Only positional arguments are supported.",
+            );
+          } else if (argumentIndex >= rest.length) {
+            throw RpsException(
+              'The script "$path" defines a positional argument $content, '
+              'but ${rest.length} positional argument(s) are given.',
+            );
+          } else {
+            usedArguments.add(argumentIndex);
+            return rest[argumentIndex];
+          }
+        },
+      );
+
+      final lastUsed = usedArguments.reduce(math.max);
+      if (lastUsed > usedArguments.length) {
+        final unusedArguments = List<int>.generate(lastUsed, (index) => index)
+            .where((e) => !usedArguments.contains(e));
+
+        throw RpsException(
+          'The script defines unused positional argument(s): '
+          '${unusedArguments.map((a) => '\${$a}').join(', ')}',
+        );
+      }
+
+      return ExecutableCommand._(
+        [filledCommand, ...rest.sublist(lastUsed + 1)].join(' '),
+        path,
+      );
+    } else {
+      return ExecutableCommand._([command, ...rest].join(' '), path);
+    }
+  }
 
   @override
-  String toString() => 'ExecutableCommand("$path": "$command")';
+  List<Object?> get props => [command, path];
 }
 
 /// Indicates that reference was made to the command
-class RefCommand extends PubspecCommand {
-  RefCommand(String path) : super(path, null);
-
+class RefCommand extends PubspecCommand with EquatableMixin {
   /// This command is only a trace mark, nothing to call here.
   @override
   bool get executable => false;
 
   @override
-  bool operator ==(Object other) {
-    return other is RefCommand &&
-        other.command == command &&
-        other.path == path;
-  }
+  Null get command => null;
 
   @override
-  int get hashCode => Object.hash(path, runtimeType);
+  final String path;
+
+  RefCommand(this.path);
 
   @override
-  String toString() => 'HookCommand("$path")';
+  List<Object?> get props => [path];
 }
 
 class Pubspec {
@@ -177,8 +219,9 @@ class Pubspec {
       );
     } else if (value is String) {
       yield* _examinateCommand(
-        command: [value, ...context.rest].join(' '),
+        command: value,
         path: context.stringPath,
+        rest: context.rest,
       );
     } else if (value is Map) {
       yield* _getHookCommands(
@@ -190,7 +233,11 @@ class Pubspec {
       if (_hasScriptKey(value)) {
         final script = value[scriptKey];
         if (script is String) {
-          yield* _examinateCommand(command: script, path: context.stringPath);
+          yield* _examinateCommand(
+            command: script,
+            path: context.stringPath,
+            rest: context.rest,
+          );
         } else if (script is Map) {
           final platformKey = '\$${Platform.operatingSystem}';
           final command = script[platformKey] ?? script[defaultScriptKey];
@@ -205,7 +252,8 @@ class Pubspec {
           } else {
             yield* _examinateCommand(
               command: command,
-              path: [context.stringPath, ...context.rest].join(' '),
+              path: context.stringPath,
+              rest: context.rest,
             );
           }
         }
@@ -234,12 +282,13 @@ class Pubspec {
   Iterable<PubspecCommand> _examinateCommand({
     required String command,
     required String path,
+    required List<String> rest,
   }) sync* {
     if (command.startsWith(r'$')) {
       yield RefCommand(path);
       yield* getCommands(command.substring(1).split(RegExp(r'\s+')));
     } else {
-      yield ExecutableCommand(path, command);
+      yield ExecutableCommand(path, command, rest);
     }
   }
 
@@ -261,6 +310,9 @@ class Pubspec {
       yield* _examinateCommand(
         path: [...context.path, key].join(' '),
         command: value,
+
+        /// TODO? ignore for hooks
+        rest: [],
       );
     }
   }

pubspec.lock

@@ -45,10 +45,10 @@ packages:
     dependency: transitive
     description:
       name: collection
-      sha256: "4a07be6cb69c84d677a6c3096fcf960cc3285a8330b4603e0d463d15d9bd934c"
+      sha256: f092b211a4319e98e5ff58223576de6c2803db36221657b46c82574721240687
       url: "https://pub.dev"
     source: hosted
-    version: "1.17.1"
+    version: "1.17.2"
   convert:
     dependency: transitive
     description:
@@ -73,6 +73,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "3.0.2"
+  equatable:
+    dependency: "direct main"
+    description:
+      name: equatable
+      sha256: c2b87cb7756efdf69892005af546c56c0b5037f54d2a88269b4f347a505e3ca2
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.0.5"
   ffi:
     dependency: "direct main"
     description:
@@ -170,13 +178,13 @@ packages:
     source: hosted
     version: "0.12.14"
   meta:
-    dependency: transitive
+    dependency: "direct main"
     description:
       name: meta
-      sha256: "12307e7f0605ce3da64cf0db90e5fcab0869f3ca03f76be6bb2991ce0a55e82b"
+      sha256: "3c74dbf8763d36539f114c799d8a2d87343b5067e9d796ca22b5eb8437090ee3"
       url: "https://pub.dev"
     source: hosted
-    version: "1.9.0"
+    version: "1.9.1"
   mime:
     dependency: transitive
     description:
@@ -386,4 +394,4 @@ packages:
     source: hosted
     version: "3.1.1"
 sdks:
-  dart: ">=2.19.4 <3.0.0"
+  dart: ">=2.19.4 <4.0.0"

pubspec.yaml

@@ -1,6 +1,6 @@
 name: rps
 description: rps (Run Pubspec Script) allows you to define and run scripts from pubspec.yaml.
-version: 0.7.0
+version: 0.8.0-dev.1
 repository: https://github.com/gonuit/rps
 homepage: https://github.com/gonuit/rps
 issue_tracker: https://github.com/gonuit/rps/issues
@@ -9,12 +9,14 @@ executables:
   rps:
 
 environment:
-  sdk: ">=2.19.4 <3.0.0"
+  sdk: ">=2.19.4 <4.0.0"
 
 dependencies:
   yaml: ^3.1.1
   path: ^1.8.2
   ffi: ^2.0.1
+  equatable: ^2.0.5
+  meta: ^1.9.1
 
 dev_dependencies:
   flutter_lints: ^2.0.1