chore!: move from yargs to node:util (#871)

BREAKING CHANGE: The shorthand flag for `--input-file` in the `call` command has been changed from `-if` to `-f`.

Our argument parsing was changed from yargs to the built-in one from nodejs. This does come with some caveats (specifically aliases like `-if` will be interpreted as setting the flags `-i` and `-f` (if both are defined) or as `f` as the value of the `-i` flag.).

Author: vladfrangu

features/test-implementations/1.setup.ts

@@ -243,6 +243,8 @@ Given<TestWorld>(/the local actor is pushed to the Apify platform/i, { timeout:
 		pushedActorIds.push(this.testActor.name);
 	} else {
 		// This throws on errors
-		result.unwrap();
+		const err = result.unwrapErr();
+
+		throw new Error(`Failed to push actor: ${err.message}`);
 	}
 });

package.json

@@ -110,8 +110,7 @@
         "tiged": "~2.12.7",
         "which": "^5.0.0",
         "widest-line": "^5.0.0",
-        "wrap-ansi": "^9.0.0",
-        "yargs": "^17.7.2"
+        "wrap-ansi": "^9.0.0"
     },
     "devDependencies": {
         "@apify/eslint-config": "^1.0.0",
@@ -135,7 +134,6 @@
         "@types/node": "^22.0.0",
         "@types/semver": "^7.5.8",
         "@types/which": "^3.0.4",
-        "@types/yargs": "^17.0.33",
         "@yarnpkg/core": "^4.1.2",
         "apify": "^3.2.4",
         "chai": "^4.4.1",

src/commands/_register.ts

@@ -57,6 +57,9 @@ export const apifyCommands = [
 	RunCommand,
 	ValidateInputSchemaCommand,
 	HelpCommand,
+
+	// test commands
+	// (await import('./_testCommands/_FlagTests.js')).FlagTest,
 ] as const satisfies (typeof BuiltApifyCommand)[];
 
 export const actorCommands = [

src/commands/_testCommands/_FlagTests.ts

@@ -0,0 +1,47 @@
+import { ApifyCommand } from '../../lib/command-framework/apify-command.js';
+import { Flags } from '../../lib/command-framework/flags.js';
+
+export class FlagTest extends ApifyCommand<typeof FlagTest> {
+	static override name = '_flag';
+
+	static override flags = {
+		foo: Flags.string({
+			description: 'Foo flag',
+			// required: true,
+		}),
+		bar: Flags.string({
+			description: 'Bar flag',
+		}),
+		fooBar: Flags.string({
+			description: 'Foo bar flag',
+			// required: true,
+		}),
+		'spaced message': Flags.string({
+			description: 'Spaced message flag',
+		}),
+		choice: Flags.string({
+			description: 'Choices flag',
+			aliases: ['alias1'],
+			choices: ['1', '2', '3'],
+		}),
+		int: Flags.integer({
+			exclusive: ['foo'],
+		}),
+		'space me': Flags.string({
+			description: 'Space message flag',
+			exclusive: ['lines-in'],
+		}),
+		'lines-in': Flags.integer({
+			description: 'Lines in flag',
+			exclusive: ['space me'],
+		}),
+		fooBar2: Flags.boolean({
+			description: 'Foo bar flag',
+			exclusive: ['lines-in'],
+		}),
+	};
+
+	override async run() {
+		console.log(this.flags);
+	}
+}

src/commands/actors/call.ts

@@ -42,7 +42,7 @@ export class ActorsCallCommand extends ApifyCommand<typeof ActorsCallCommand> {
 			exclusive: ['input-file'],
 		}),
 		'input-file': Flags.string({
-			aliases: ['if'],
+			char: 'f',
 			description:
 				'Optional path to a file with JSON input to be given to the Actor. The file must be a valid JSON file. You can also specify `-` to read from standard input.',
 			required: false,

src/commands/cli-management/upgrade.ts

@@ -77,6 +77,11 @@ export class UpgradeCommand extends ApifyCommand<typeof UpgradeCommand> {
 		const { installMethod } = useCLIMetadata();
 
 		if (!result.shouldUpdate || result.currentVersion === DEVELOPMENT_VERSION_MARKER) {
+			cliDebugPrint('[upgrade] no update needed', {
+				shouldUpdate: result.shouldUpdate,
+				currentVersion: result.currentVersion,
+			});
+
 			// Always print, unless the command was called automatically by the CLI for a version check
 			if (!this.flags.internalAutomaticCall) {
 				info({ message: `${this.cliName} is up to date 👍 \n` });