Merge branch 'master' into chore/command-suggestions

vladfrangu · web-flow · commit b6c7d9de63e4 · 2025-06-12T18:56:11.000+03:00
diff --git a/.bun-version b/.bun-version
@@ -1 +1 @@
-1.2.15
+1.2.16
diff --git a/.github/workflows/check.yaml b/.github/workflows/check.yaml
@@ -18,7 +18,7 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                os: [ubuntu-latest, windows-latest]
+                os: [ubuntu-latest, windows-2025]
                 node-version: [18, 20, 22, 24]
 
         steps:
@@ -52,15 +52,15 @@ jobs:
                   APIFY_CLI_DISABLE_TELEMETRY: 1
               run: yarn test
 
-            - name: Ensure the reference documentation builds
-              run: yarn update-docs
+            # - name: Ensure the reference documentation builds
+            #   run: yarn update-docs
 
     test_python_support:
         name: Test Python template support
         strategy:
             fail-fast: false
             matrix:
-                os: [ubuntu-latest, windows-latest]
+                os: [ubuntu-latest, windows-2025]
                 python-version: ["3.9", "3.10", "3.11", "3.12"]
         runs-on: ${{ matrix.os }}
 
diff --git a/.github/workflows/cucumber.yaml b/.github/workflows/cucumber.yaml
@@ -16,9 +16,9 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                os: [ubuntu-latest, windows-latest]
+                os: [ubuntu-latest, windows-2025]
                 # We only test LTS for now
-                node-version: [20]
+                node-version: [22]
 
         runs-on: ${{ matrix.os }}
 
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -58,7 +58,7 @@ jobs:
                   APIFY_SIGNING_TOKEN: ${{ secrets.APIFY_SIGNING_TOKEN }}
 
             - name: Commit the updated package(-lock).json
-              uses: stefanzweifel/git-auto-commit-action@v5
+              uses: stefanzweifel/git-auto-commit-action@v6
               with:
                   commit_message: "chore: Automatic theme updating workflow [skip ci]"
                   file_pattern: "website/package*.json website/yarn.lock"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@ All notable changes to this project will be documented in this file.
 ### 🚀 Features
 
 - Upgrade command, install shell script ([#810](https://github.com/apify/apify-cli/pull/810)) ([51ef00a](https://github.com/apify/apify-cli/commit/51ef00ad32a6835c48781b99c6233113cf58d8a4)) by [@vladfrangu](https://github.com/vladfrangu)
+- [**breaking**] Make storage purging default, add `--resurrect` ([#729](https://github.com/apify/apify-cli/pull/729)) ([8dff93a](https://github.com/apify/apify-cli/commit/8dff93a2d769997a96d4a7750fb36c2770b9a61c)) by [@vladfrangu](https://github.com/vladfrangu), closes [#590](https://github.com/apify/apify-cli/issues/590)
 
 ### 🐛 Bug Fixes
 
diff --git a/docs/reference.md b/docs/reference.md
@@ -178,21 +178,20 @@ DESCRIPTION
   NOTE: For Node.js Actors, customize behavior by modifying the 'start' script in package.json file.
 
 USAGE
-  $ apify run [--entrypoint <value>] [-i <value> | --input-file <value>] [-p] [--purge-dataset] [--purge-key-value-store] [--purge-queue]
+  $ apify run [--entrypoint <value>] [-i <value> | --input-file <value>] [-p | --resurrect]
 
 FLAGS
-      --entrypoint=<value>     Optional entrypoint for running with injected environment variables.
-                               For Python, it is the module name, or a path to a file.
-                               For node.js, it is the npm script name, or a path to a JS/MJS file. You can also pass in a directory name, provided that
-                               directory contains an "index.js" file.
-  -i, --input=<value>          Optional JSON input to be given to the Actor.
-      --input-file=<value>     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.
-  -p, --purge                  Shortcut that combines the --purge-queue, --purge-dataset and --purge-key-value-store options.
-      --purge-dataset          Deletes the local directory containing the default dataset before the run starts.
-      --purge-key-value-store  Deletes all records from the default key-value store in the local directory before the run starts,
-                               except for the "INPUT" key.
-      --purge-queue            Deletes the local directory containing the default request queue before the run starts.
+      --entrypoint=<value>  Optional entrypoint for running with injected environment variables.
+                            For Python, it is the module name, or a path to a file.
+                            For Node.js, it is the npm script name, or a path to a JS/MJS file. You can also pass in a directory name, provided that
+                            directory contains an "index.js" file.
+  -i, --input=<value>       Optional JSON input to be given to the Actor.
+      --input-file=<value>  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.
+  -p, --purge               Whether to purge the default request queue, dataset and key-value store before the run starts.
+                            For crawlee projects, this is the default behavior, and the flag is optional.
+                            Use `--no-purge` to keep the storage folder intact.
+      --resurrect           Whether to keep the default request queue, dataset and key-value store before the run starts.
 ```
 
 ##### `apify validate-schema`
diff --git a/package.json b/package.json
@@ -107,7 +107,6 @@
         "which": "^5.0.0",
         "widest-line": "^5.0.0",
         "wrap-ansi": "^9.0.0",
-        "yargonaut": "^1.1.4",
         "yargs": "^17.7.2"
     },
     "devDependencies": {
diff --git a/scripts/documentation-renderer/doc-building.ts b/scripts/documentation-renderer/doc-building.ts
@@ -6,7 +6,7 @@ import {
 	registerCommandForHelpGeneration,
 	selectiveRenderHelpForCommand,
 } from '../../src/lib/command-framework/help.js';
-import type { BaseCommandRenderer } from '../../src/lib/command-framework/help/_BaseCommandRenderer';
+import type { BaseCommandRenderer } from '../../src/lib/command-framework/help/_BaseCommandRenderer.js';
 import { Commands } from './commands.js';
 
 export interface CommandsInCategory extends Partial<Parameters<BaseCommandRenderer['selectiveRender']>[0]> {
diff --git a/scripts/install/install.sh b/scripts/install/install.sh
@@ -217,6 +217,20 @@ if [[ $quoted_install_dir = \"$HOME/* ]]; then
     quoted_install_dir=${quoted_install_dir/$HOME\//\$HOME/}
 fi
 
+if [[ -d $HOME/.local/bin ]]; then
+    # First, remove the symlinks if they exist
+    rm -f $HOME/.local/bin/apify
+    rm -f $HOME/.local/bin/actor
+    rm -f $HOME/.local/bin/apify-cli
+
+    # Symlink the three executables to /usr/local/bin
+    ln -s "$bin_dir/apify" $HOME/.local/bin/apify
+    ln -s "$bin_dir/actor" $HOME/.local/bin/actor
+    ln -s "$bin_dir/apify-cli" $HOME/.local/bin/apify-cli
+
+    info "Symlinked apify, actor, and apify-cli to $HOME/.local/bin"
+fi
+
 echo
 
 case $(basename "$SHELL") in
@@ -344,6 +358,3 @@ fi
 
 info_bold "  apify --help"
 echo
-
-# Not ideal but its the only way to refresh the shell (this also means if you type exit / CTRL+D, you'll need to do it twice)
-sh -c $SHELL
diff --git a/src/commands/_register.ts b/src/commands/_register.ts
@@ -66,4 +66,5 @@ export const actorCommands = [
 	ActorGetInputCommand,
 	ActorChargeCommand,
 	HelpCommand,
+	UpgradeCommand,
 ] as const satisfies (typeof BuiltApifyCommand)[];
diff --git a/src/commands/run.ts b/src/commands/run.ts
@@ -60,29 +60,25 @@ export class RunCommand extends ApifyCommand<typeof RunCommand> {
 		purge: Flags.boolean({
 			char: 'p',
 			description:
-				'Shortcut that combines the --purge-queue, --purge-dataset and --purge-key-value-store options.',
+				'Whether to purge the default request queue, dataset and key-value store before the run starts.\nFor crawlee projects, this is the default behavior, and the flag is optional.\nUse `--no-purge` to keep the storage folder intact.',
 			required: false,
+			default: true,
+			exclusive: ['resurrect'],
 		}),
-		'purge-queue': Flags.boolean({
-			description: 'Deletes the local directory containing the default request queue before the run starts.',
-			required: false,
-		}),
-		'purge-dataset': Flags.boolean({
-			description: 'Deletes the local directory containing the default dataset before the run starts.',
-			required: false,
-		}),
-		'purge-key-value-store': Flags.boolean({
+		resurrect: Flags.boolean({
 			description:
-				'Deletes all records from the default key-value store in the local directory before the run starts, except for the "INPUT" key.',
+				'Whether to keep the default request queue, dataset and key-value store before the run starts.',
 			required: false,
+			default: false,
+			exclusive: ['purge'],
 		}),
 		entrypoint: Flags.string({
 			description: [
 				'Optional entrypoint for running with injected environment variables.',
 				'\n',
 				'For Python, it is the module name, or a path to a file.',
 				'\n',
-				'For node.js, it is the npm script name, or a path to a JS/MJS file.',
+				'For Node.js, it is the npm script name, or a path to a JS/MJS file.',
 				'You can also pass in a directory name, provided that directory contains an "index.js" file.',
 			].join(' '),
 			required: false,
@@ -215,42 +211,25 @@ export class RunCommand extends ApifyCommand<typeof RunCommand> {
 
 		let CRAWLEE_PURGE_ON_START = '0';
 
+		// Mark resurrect as a special case of --no-purge
+		if (this.flags.resurrect) {
+			this.flags.purge = false;
+		}
+
 		// Purge stores
-		// TODO: this needs to be cleaned up heavily - ideally logic should be in the project analyzers
 		if (this.flags.purge) {
 			CRAWLEE_PURGE_ON_START = '1';
 
 			if (crawleeVersion.isNone()) {
 				await Promise.all([purgeDefaultQueue(), purgeDefaultKeyValueStore(), purgeDefaultDataset()]);
 				info({ message: 'All default local stores were purged.' });
 			}
-
-			// This might not be needed for python and scrapy projects
-			// if (type === ProjectLanguage.Python || type === ProjectLanguage.Scrapy) {
-			// 	await Promise.all([purgeDefaultQueue(), purgeDefaultKeyValueStore(), purgeDefaultDataset()]);
-			// 	info({ message: 'All default local stores were purged.' });
-			// }
-		}
-
-		// TODO: deprecate these flags
-		if (this.flags.purgeQueue && !this.flags.purge) {
-			await purgeDefaultQueue();
-			info({ message: 'Default local request queue was purged.' });
-		}
-
-		if (this.flags.purgeDataset && !this.flags.purge) {
-			await purgeDefaultDataset();
-			info({ message: 'Default local dataset was purged.' });
-		}
-
-		if (this.flags.purgeKeyValueStore && !this.flags.purge) {
-			await purgeDefaultKeyValueStore();
-			info({ message: 'Default local key-value store was purged.' });
 		}
 
 		if (!this.flags.purge) {
 			const isStorageEmpty = await checkIfStorageIsEmpty();
-			if (!isStorageEmpty) {
+
+			if (!isStorageEmpty && !this.flags.resurrect) {
 				warning({
 					message:
 						'The storage directory contains a previous state, the Actor will continue where it left off. ' +
diff --git a/src/entrypoints/_shared.ts b/src/entrypoints/_shared.ts
@@ -1,7 +1,6 @@
 import process from 'node:process';
 
 import chalk from 'chalk';
-import yargonaut from 'yargonaut';
 // eslint-disable-next-line import/extensions
 import yargs from 'yargs/yargs';
 
@@ -22,12 +21,6 @@ import { cliDebugPrint } from '../lib/utils/cliDebugPrint.js';
 
 export const cachedStdinInput = await readStdin();
 
-yargonaut //
-	.style('blue')
-	.style('yellow', 'required')
-	.helpStyle('green')
-	.errorsStyle('red');
-
 export const cli = yargs()
 	.version(false)
 	.help(false)
diff --git a/src/lib/command-framework/apify-command.ts b/src/lib/command-framework/apify-command.ts
@@ -312,6 +312,8 @@ export abstract class ApifyCommand<T extends typeof BuiltApifyCommand = typeof B
 					});
 
 					return;
+				} else if (typeof builderData.hasDefault !== 'undefined') {
+					this.flags[camelCasedName] = builderData.hasDefault;
 				}
 			}
 		}
@@ -452,7 +454,7 @@ export abstract class ApifyCommand<T extends typeof BuiltApifyCommand = typeof B
 
 					// yargs handles "no-" flags by negating the flag, so we need to handle that differently if we register a flag with a "no-" prefix
 					if (flagKey.startsWith('no-')) {
-						finalYargs = internalBuilderData.builder(finalYargs, flagKey.slice(3), [], true);
+						finalYargs = internalBuilderData.builder(finalYargs, flagKey.slice(3));
 					} else {
 						finalYargs = internalBuilderData.builder(finalYargs, flagKey);
 					}
diff --git a/src/lib/command-framework/flags.ts b/src/lib/command-framework/flags.ts
@@ -42,7 +42,7 @@ export interface TaggedFlagBuilder<
 	HasDefault = false,
 > {
 	flagTag: Tag;
-	builder: (args: Argv, objectName: string, extraArgs?: string[], invertDefaultIfSet?: boolean) => Argv;
+	builder: (args: Argv, objectName: string, extraArgs?: string[]) => Argv;
 	choicesType: ChoicesType;
 	required: Required;
 	hasDefault: HasDefault;
@@ -67,7 +67,7 @@ function stringFlag<const Choices extends string[], const T extends StringFlagOp
 ): TaggedFlagBuilder<'string', Choices, T['default'] extends string ? true : T['required'], T['default']> {
 	return {
 		flagTag: 'string',
-		builder: (args, objectName, extraAliases, invertDefaultIfSet = false) => {
+		builder: (args, objectName, extraAliases) => {
 			const allAliases = new Set([...(options.aliases ?? []), ...(extraAliases ?? [])]);
 
 			if (options.char) {
@@ -82,7 +82,6 @@ function stringFlag<const Choices extends string[], const T extends StringFlagOp
 				alias: [...allAliases].map((alias) => kebabCaseString(camelCaseToKebabCase(alias))),
 				hidden: options.hidden ?? false,
 				conflicts: options.exclusive,
-				default: invertDefaultIfSet ? !options.default : options.default,
 				choices: options.choices,
 				string: true,
 				// we only require something be passed in if we don't have a default or read from stdin
@@ -107,7 +106,7 @@ function booleanFlag<const T extends BooleanFlagOptions>(
 ): TaggedFlagBuilder<'boolean', never, T['default'] extends boolean ? true : T['required'], T['default']> {
 	return {
 		flagTag: 'boolean',
-		builder: (args, objectName, extraAliases, invertDefaultIfSet = false) => {
+		builder: (args, objectName, extraAliases) => {
 			const allAliases = new Set([...(options.aliases ?? []), ...(extraAliases ?? [])]);
 
 			if (options.char) {
@@ -122,7 +121,6 @@ function booleanFlag<const T extends BooleanFlagOptions>(
 				alias: [...allAliases].map((alias) => kebabCaseString(camelCaseToKebabCase(alias))),
 				hidden: options.hidden ?? false,
 				conflicts: options.exclusive,
-				default: invertDefaultIfSet ? !options.default : options.default,
 				boolean: true,
 			});
 		},
@@ -144,7 +142,7 @@ function integerFlag<const T extends IntegerFlagOptions>(
 ): TaggedFlagBuilder<'integer', never, T['default'] extends number ? true : T['required'], T['default']> {
 	return {
 		flagTag: 'integer',
-		builder: (args, objectName, extraAliases, invertDefaultIfSet = false) => {
+		builder: (args, objectName, extraAliases) => {
 			const allAliases = new Set([...(options.aliases ?? []), ...(extraAliases ?? [])]);
 
 			if (options.char) {
@@ -159,7 +157,6 @@ function integerFlag<const T extends IntegerFlagOptions>(
 				alias: [...allAliases].map((alias) => kebabCaseString(camelCaseToKebabCase(alias))),
 				hidden: options.hidden ?? false,
 				conflicts: options.exclusive,
-				default: invertDefaultIfSet ? !options.default : options.default,
 				choices: options.choices,
 				string: true,
 				nargs: 1,
diff --git a/src/lib/yargonaut.d.ts b/src/lib/yargonaut.d.ts
diff --git a/vitest.config.ts b/vitest.config.ts
@@ -1,6 +1,8 @@
+// eslint-disable-next-line import/extensions
 import { defineConfig } from 'vitest/config';
 
 const isWindows = process.platform === 'win32';
+const multiplierFactor = isWindows ? 4 : 1;
 
 export default defineConfig({
 	esbuild: {
@@ -10,8 +12,8 @@ export default defineConfig({
 	test: {
 		globals: true,
 		restoreMocks: true,
-		testTimeout: 60_000 * (isWindows ? 2 : 1),
-		hookTimeout: 60_000 * (isWindows ? 2 : 1),
+		testTimeout: 60_000 * multiplierFactor,
+		hookTimeout: 60_000 * multiplierFactor,
 		include: ['**/*.{test,spec}.?(c|m)[jt]s?(x)'],
 		passWithNoTests: true,
 		silent: !process.env.NO_SILENT_TESTS,
diff --git a/website/yarn.lock b/website/yarn.lock
diff --git a/yarn.lock b/yarn.lock
