@remotion/cli 4.0.88 → 4.0.89

package/dist/benchmark.js

@@ -125,6 +125,8 @@ const benchmarkCommand = async (remotionRoot, args, logLevel) => {
             (0, cleanup_before_quit_1.registerCleanupJob)(() => renderer_1.RenderInternals.deleteDirectory(dir));
         },
         quietProgress: false,
+        quietFlag: (0, parse_command_line_1.quietFlagProvided)(),
+        outDir: null,
     });
     (0, cleanup_before_quit_1.registerCleanupJob)(() => cleanupBundle());
     const puppeteerInstance = await browserInstance;

package/dist/bundle.d.ts

@@ -0,0 +1,2 @@
+import type { LogLevel } from '@remotion/renderer';
+export declare const bundleCommand: (remotionRoot: string, args: string[], logLevel: LogLevel) => Promise<void>;

package/dist/bundle.js

@@ -0,0 +1,110 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bundleCommand = void 0;
+const bundler_1 = require("@remotion/bundler");
+const studio_1 = require("@remotion/studio");
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const chalk_1 = require("./chalk");
+const entry_point_1 = require("./entry-point");
+const get_cli_options_1 = require("./get-cli-options");
+const log_1 = require("./log");
+const parse_command_line_1 = require("./parse-command-line");
+const setup_cache_1 = require("./setup-cache");
+const should_use_non_overlaying_logger_1 = require("./should-use-non-overlaying-logger");
+const yes_or_no_1 = require("./yes-or-no");
+const bundleCommand = async (remotionRoot, args, logLevel) => {
+    const { file, reason } = (0, entry_point_1.findEntryPoint)(args, remotionRoot, logLevel);
+    const explicitlyPassed = args[0];
+    if (explicitlyPassed &&
+        reason !== 'argument passed' &&
+        reason !== 'argument passed - found in cwd' &&
+        reason !== 'argument passed - found in root') {
+        log_1.Log.error(`Entry point was specified as ${chalk_1.chalk.bold(explicitlyPassed)}, but it was not found.`);
+        process.exit(1);
+    }
+    const updatesDontOverwrite = (0, should_use_non_overlaying_logger_1.shouldUseNonOverlayingLogger)({ logLevel });
+    if (!file) {
+        log_1.Log.error('No entry point found.');
+        log_1.Log.error('Pass another argument to the command specifying the entry point.');
+        log_1.Log.error('See: https://www.remotion.dev/docs/terminology#entry-point');
+        process.exit(1);
+    }
+    const { publicDir } = await (0, get_cli_options_1.getCliOptions)({
+        isLambda: false,
+        type: 'get-compositions',
+        remotionRoot,
+        logLevel,
+    });
+    const outputPath = parse_command_line_1.parsedCli['out-dir']
+        ? path_1.default.resolve(process.cwd(), parse_command_line_1.parsedCli['out-dir'])
+        : path_1.default.join(remotionRoot, 'build');
+    const gitignoreFolder = bundler_1.BundlerInternals.findClosestFolderWithFile(outputPath, '.gitignore');
+    const existed = (0, fs_1.existsSync)(outputPath);
+    if (existed) {
+        if (!(0, fs_1.existsSync)(path_1.default.join(outputPath, 'index.html'))) {
+            log_1.Log.error(`The folder at ${outputPath} already exists, and needs to be deleted before a new bundle can be created.`);
+            log_1.Log.error('However, it does not look like the folder was created by `npx remotion bundle` (no index.html).');
+            log_1.Log.error('Aborting to prevent accidental data loss.');
+            process.exit(1);
+        }
+        (0, fs_1.rmSync)(outputPath, { recursive: true });
+    }
+    const output = await (0, setup_cache_1.bundleOnCli)({
+        fullPath: file,
+        logLevel,
+        onDirectoryCreated: () => { },
+        bundlingStep: 0,
+        indent: false,
+        quietProgress: updatesDontOverwrite,
+        publicDir,
+        steps: 1,
+        remotionRoot,
+        onProgressCallback: ({ bundling, copying }) => {
+            // Handle floating point inaccuracies
+            if (bundling.progress < 0.99999) {
+                if (updatesDontOverwrite) {
+                    log_1.Log.info(`Bundling ${Math.round(bundling.progress * 100)}%`);
+                }
+            }
+            if (copying.doneIn === null) {
+                if (updatesDontOverwrite) {
+                    return `Copying public dir ${studio_1.StudioInternals.formatBytes(copying.bytes)}`;
+                }
+            }
+        },
+        quietFlag: (0, parse_command_line_1.quietFlagProvided)(),
+        outDir: outputPath,
+    });
+    log_1.Log.infoAdvanced({ indent: false, logLevel }, chalk_1.chalk.blue(`${existed ? '○' : '+'} ${output}`));
+    if (!gitignoreFolder) {
+        return;
+    }
+    // Non-interactive terminal
+    if (!process.stdout.isTTY) {
+        return;
+    }
+    const gitignorePath = path_1.default.join(gitignoreFolder, '.gitignore');
+    const gitIgnoreContents = (0, fs_1.readFileSync)(gitignorePath, 'utf-8');
+    const relativePathToGitIgnore = path_1.default.relative(gitignoreFolder, outputPath);
+    const isInGitIgnore = gitIgnoreContents
+        .split('\n')
+        .includes(relativePathToGitIgnore);
+    if (isInGitIgnore) {
+        return;
+    }
+    const answer = await (0, yes_or_no_1.yesOrNo)({
+        defaultValue: true,
+        question: `Recommended: Add ${chalk_1.chalk.bold(relativePathToGitIgnore)} to your ${chalk_1.chalk.bold('.gitignore')} file? (Y/n)`,
+    });
+    if (!answer) {
+        return;
+    }
+    const newGitIgnoreContents = gitIgnoreContents + '\n' + relativePathToGitIgnore;
+    (0, fs_1.writeFileSync)(gitignorePath, newGitIgnoreContents);
+    log_1.Log.infoAdvanced({ indent: false, logLevel }, chalk_1.chalk.blue(`Added to .gitignore!`));
+};
+exports.bundleCommand = bundleCommand;

package/dist/compositions.js

@@ -8,6 +8,7 @@ const preview_server_1 = require("./config/preview-server");
 const entry_point_1 = require("./entry-point");
 const get_cli_options_1 = require("./get-cli-options");
 const log_1 = require("./log");
+const parse_command_line_1 = require("./parse-command-line");
 const print_compositions_1 = require("./print-compositions");
 const setup_cache_1 = require("./setup-cache");
 const listCompositionsCommand = async (remotionRoot, args, logLevel) => {
@@ -38,6 +39,8 @@ const listCompositionsCommand = async (remotionRoot, args, logLevel) => {
             (0, cleanup_before_quit_1.registerCleanupJob)(() => renderer_1.RenderInternals.deleteDirectory(dir));
         },
         quietProgress: false,
+        quietFlag: (0, parse_command_line_1.quietFlagProvided)(),
+        outDir: null,
     });
     (0, cleanup_before_quit_1.registerCleanupJob)(() => cleanupBundle());
     const compositions = await renderer_1.RenderInternals.internalGetCompositions({

package/dist/entry-point.d.ts

@@ -1,6 +1,8 @@
 import type { LogLevel } from '@remotion/renderer';
+type FoundReason = 'argument passed - found in cwd' | 'argument passed - found in root' | 'argument passed' | 'config file' | 'common paths' | 'none found';
 export declare const findEntryPoint: (args: string[], remotionRoot: string, logLevel: LogLevel) => {
     file: string | null;
     remainingArgs: string[];
-    reason: string;
+    reason: FoundReason;
 };
+export {};

package/dist/index.d.ts

@@ -169,6 +169,7 @@ export declare const CliInternals: {
         browser: string;
         "browser-args": string;
         "user-agent": string;
+        "out-dir": string;
         repro: boolean;
         "number-of-gif-loops": number;
         "offthreadvideo-cache-size-in-bytes": number | null;
@@ -205,7 +206,7 @@ export declare const CliInternals: {
     findEntryPoint: (args: string[], remotionRoot: string, logLevel: "verbose" | "info" | "warn" | "error") => {
         file: string | null;
         remainingArgs: string[];
-        reason: string;
+        reason: "argument passed - found in cwd" | "argument passed - found in root" | "argument passed" | "config file" | "common paths" | "none found";
     };
     getVideoImageFormat: ({ codec, uiImageFormat, }: {
         codec: import("@remotion/renderer").CodecOrUndefined;

package/dist/index.js

@@ -8,6 +8,7 @@ const renderer_1 = require("@remotion/renderer");
 const studio_1 = require("@remotion/studio");
 const minimist_1 = __importDefault(require("minimist"));
 const benchmark_1 = require("./benchmark");
+const bundle_1 = require("./bundle");
 const chalk_1 = require("./chalk");
 const cleanup_before_quit_1 = require("./cleanup-before-quit");
 const cloudrun_command_1 = require("./cloudrun-command");
@@ -69,7 +70,10 @@ const cli = async () => {
     const logLevel = await (0, initialize_cli_1.initializeCli)(remotionRoot);
     (0, cleanup_before_quit_1.handleCtrlC)({ indent: false, logLevel });
     try {
-        if (command === 'compositions') {
+        if (command === 'bundle') {
+            await (0, bundle_1.bundleCommand)(remotionRoot, args, logLevel);
+        }
+        else if (command === 'compositions') {
             await (0, compositions_1.listCompositionsCommand)(remotionRoot, args, logLevel);
         }
         else if (isStudio) {

package/dist/parse-command-line.d.ts

@@ -122,6 +122,7 @@ type CommandLineOptions = {
     ['browser']: string;
     ['browser-args']: string;
     ['user-agent']: string;
+    ['out-dir']: string;
     [deleteAfterOption.cliFlag]: string | undefined;
     [folderExpiryOption.cliFlag]: boolean | undefined;
     [enableMultiprocessOnLinuxOption.cliFlag]: boolean;

package/dist/print-help.js

@@ -8,10 +8,10 @@ const versions_1 = require("./versions");
 const packagejson = require('../package.json');
 const printHelp = () => {
     log_1.Log.info(`@remotion/cli ${packagejson.version}`);
-    log_1.Log.info(`© ${new Date().getFullYear()} The Remotion AG`);
+    log_1.Log.info(`© ${new Date().getFullYear()} Remotion AG`);
     log_1.Log.info();
     log_1.Log.info('Available commands:');
-    log_1.Log.info('');
+    log_1.Log.info();
     log_1.Log.info(chalk_1.chalk.blue('remotion studio') + chalk_1.chalk.gray(' <entry-point.ts>'));
     log_1.Log.info('Start the Remotion studio.');
     log_1.Log.info(chalk_1.chalk.gray('https://www.remotion.dev/docs/cli/studio'));
@@ -26,6 +26,10 @@ const printHelp = () => {
     log_1.Log.info('Render a still frame and save it as an image.');
     log_1.Log.info(chalk_1.chalk.gray('https://www.remotion.dev/docs/cli/still'));
     log_1.Log.info();
+    log_1.Log.info(chalk_1.chalk.blue('remotion bundle') + chalk_1.chalk.gray(' <entry-point.ts>'));
+    log_1.Log.info('Create a Remotion bundle to be deployed to the web.');
+    log_1.Log.info(chalk_1.chalk.gray('https://www.remotion.dev/docs/cli/bundle'));
+    log_1.Log.info();
     log_1.Log.info(chalk_1.chalk.blue('remotion compositions') + chalk_1.chalk.gray(' <index-file.ts>'));
     log_1.Log.info('Prints the available compositions.');
     log_1.Log.info(chalk_1.chalk.gray('https://www.remotion.dev/docs/cli/compositions'));

package/dist/render-flows/render.js

@@ -118,6 +118,8 @@ const renderVideoFlow = async ({ remotionRoot, fullEntryPoint, indent, logLevel,
             addCleanupCallback(() => renderer_1.RenderInternals.deleteDirectory(dir));
         },
         quietProgress: updatesDontOverwrite,
+        quietFlag: (0, parse_command_line_1.quietFlagProvided)(),
+        outDir: null,
     });
     addCleanupCallback(() => cleanupBundle());
     const onDownload = (0, make_on_download_1.makeOnDownload)({

package/dist/render-flows/still.js

@@ -82,6 +82,8 @@ const renderStillFlow = async ({ remotionRoot, fullEntryPoint, entryPointReason,
             });
         },
         quietProgress: updatesDontOverwrite,
+        quietFlag: (0, parse_command_line_1.quietFlagProvided)(),
+        outDir: null,
     });
     const server = await renderer_1.RenderInternals.prepareServer({
         concurrency: 1,

package/dist/setup-cache.d.ts

@@ -1,6 +1,6 @@
 import type { LogLevel } from '@remotion/renderer';
 import type { BundlingState, CopyingState } from '@remotion/studio';
-export declare const bundleOnCliOrTakeServeUrl: ({ fullPath, remotionRoot, publicDir, onProgress, indentOutput, logLevel, bundlingStep, steps, onDirectoryCreated, quietProgress, }: {
+export declare const bundleOnCliOrTakeServeUrl: ({ fullPath, remotionRoot, publicDir, onProgress, indentOutput, logLevel, bundlingStep, steps, onDirectoryCreated, quietProgress, quietFlag, outDir, }: {
     fullPath: string;
     remotionRoot: string;
     publicDir: string | null;
@@ -14,7 +14,26 @@ export declare const bundleOnCliOrTakeServeUrl: ({ fullPath, remotionRoot, publi
     steps: number;
     onDirectoryCreated: (path: string) => void;
     quietProgress: boolean;
+    quietFlag: boolean;
+    outDir: string | null;
 }) => Promise<{
     urlOrBundle: string;
     cleanup: () => void;
 }>;
+export declare const bundleOnCli: ({ fullPath, remotionRoot, publicDir, onProgressCallback, indent, logLevel, bundlingStep, steps, onDirectoryCreated, quietProgress, quietFlag, outDir, }: {
+    fullPath: string;
+    remotionRoot: string;
+    publicDir: string | null;
+    onProgressCallback: (params: {
+        bundling: BundlingState;
+        copying: CopyingState;
+    }) => void;
+    indent: boolean;
+    logLevel: LogLevel;
+    bundlingStep: number;
+    steps: number;
+    onDirectoryCreated: (path: string) => void;
+    quietProgress: boolean;
+    quietFlag: boolean;
+    outDir: string | null;
+}) => Promise<string>;

package/dist/setup-cache.js

@@ -1,14 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.bundleOnCliOrTakeServeUrl = void 0;
+exports.bundleOnCli = exports.bundleOnCliOrTakeServeUrl = void 0;
 const bundler_1 = require("@remotion/bundler");
 const renderer_1 = require("@remotion/renderer");
 const config_1 = require("./config");
 const log_1 = require("./log");
-const parse_command_line_1 = require("./parse-command-line");
 const progress_bar_1 = require("./progress-bar");
 const should_use_non_overlaying_logger_1 = require("./should-use-non-overlaying-logger");
-const bundleOnCliOrTakeServeUrl = async ({ fullPath, remotionRoot, publicDir, onProgress, indentOutput, logLevel, bundlingStep, steps, onDirectoryCreated, quietProgress, }) => {
+const bundleOnCliOrTakeServeUrl = async ({ fullPath, remotionRoot, publicDir, onProgress, indentOutput, logLevel, bundlingStep, steps, onDirectoryCreated, quietProgress, quietFlag, outDir, }) => {
     if (renderer_1.RenderInternals.isServeUrl(fullPath)) {
         onProgress({
             bundling: {
@@ -25,7 +24,7 @@ const bundleOnCliOrTakeServeUrl = async ({ fullPath, remotionRoot, publicDir, on
             cleanup: () => Promise.resolve(undefined),
         };
     }
-    const bundled = await bundleOnCli({
+    const bundled = await (0, exports.bundleOnCli)({
         fullPath,
         remotionRoot,
         publicDir,
@@ -36,6 +35,8 @@ const bundleOnCliOrTakeServeUrl = async ({ fullPath, remotionRoot, publicDir, on
         steps,
         onDirectoryCreated,
         quietProgress,
+        quietFlag,
+        outDir,
     });
     return {
         urlOrBundle: bundled,
@@ -43,7 +44,7 @@ const bundleOnCliOrTakeServeUrl = async ({ fullPath, remotionRoot, publicDir, on
     };
 };
 exports.bundleOnCliOrTakeServeUrl = bundleOnCliOrTakeServeUrl;
-const bundleOnCli = async ({ fullPath, remotionRoot, publicDir, onProgressCallback, indent, logLevel, bundlingStep, steps, onDirectoryCreated, quietProgress, }) => {
+const bundleOnCli = async ({ fullPath, remotionRoot, publicDir, onProgressCallback, indent, logLevel, bundlingStep, steps, onDirectoryCreated, quietProgress, quietFlag, outDir, }) => {
     var _a;
     const shouldCache = config_1.ConfigInternals.getWebpackCaching();
     const symlinkState = {
@@ -112,7 +113,7 @@ const bundleOnCli = async ({ fullPath, remotionRoot, publicDir, onProgressCallba
     }
     const bundleStartTime = Date.now();
     const bundlingProgress = (0, progress_bar_1.createOverwriteableCliOutput)({
-        quiet: quietProgress || (0, parse_command_line_1.quietFlagProvided)(),
+        quiet: quietProgress || quietFlag,
         cancelSignal: null,
         updatesDontOverwrite: (0, should_use_non_overlaying_logger_1.shouldUseNonOverlayingLogger)({ logLevel }),
         indent,
@@ -131,6 +132,7 @@ const bundleOnCli = async ({ fullPath, remotionRoot, publicDir, onProgressCallba
             updateProgress(false);
         },
         onDirectoryCreated,
+        outDir: outDir !== null && outDir !== void 0 ? outDir : undefined,
         ...options,
     });
     bundlingState = {
@@ -154,3 +156,4 @@ const bundleOnCli = async ({ fullPath, remotionRoot, publicDir, onProgressCallba
     }
     return bundled;
 };
+exports.bundleOnCli = bundleOnCli;

package/dist/yes-or-no.d.ts

@@ -0,0 +1,4 @@
+export declare const yesOrNo: ({ question, defaultValue, }: {
+    question: string;
+    defaultValue: boolean;
+}) => Promise<boolean>;

package/dist/yes-or-no.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.yesOrNo = void 0;
+const readline_1 = __importDefault(require("readline"));
+const options = {
+    yes: ['yes', 'y'],
+    no: ['no', 'n'],
+};
+function defaultInvalidHandler({ yesValues, noValues, }) {
+    process.stdout.write('\nInvalid Response.\n');
+    process.stdout.write('Answer either yes : (' + yesValues.join(', ') + ') \n');
+    process.stdout.write('Or no: (' + noValues.join(', ') + ') \n\n');
+}
+const yesOrNo = ({ question, defaultValue, }) => {
+    const invalid = defaultInvalidHandler;
+    const yesValues = options.yes.map((v) => v.toLowerCase());
+    const noValues = options.no.map((v) => v.toLowerCase());
+    const rl = readline_1.default.createInterface({
+        input: process.stdin,
+        output: process.stdout,
+    });
+    return new Promise((resolve) => {
+        rl.question(question + ' ', async (answer) => {
+            rl.close();
+            const cleaned = answer.trim().toLowerCase();
+            if (cleaned === '' && defaultValue !== null)
+                return resolve(defaultValue);
+            if (yesValues.indexOf(cleaned) >= 0)
+                return resolve(true);
+            if (noValues.indexOf(cleaned) >= 0)
+                return resolve(false);
+            invalid({ question, yesValues, noValues });
+            const result = await (0, exports.yesOrNo)({
+                question,
+                defaultValue,
+            });
+            resolve(result);
+        });
+    });
+};
+exports.yesOrNo = yesOrNo;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remotion/cli",
-  "version": "4.0.88",
+  "version": "4.0.89",
   "description": "CLI for Remotion",
   "main": "dist/index.js",
   "sideEffects": false,
@@ -31,12 +31,12 @@
     "dotenv": "9.0.2",
     "minimist": "1.2.6",
     "prompts": "2.4.2",
-    "@remotion/bundler": "4.0.88",
-    "@remotion/media-utils": "4.0.88",
-    "@remotion/renderer": "4.0.88",
-    "remotion": "4.0.88",
-    "@remotion/studio": "4.0.88",
-    "@remotion/player": "4.0.88"
+    "@remotion/player": "4.0.89",
+    "@remotion/media-utils": "4.0.89",
+    "@remotion/bundler": "4.0.89",
+    "@remotion/renderer": "4.0.89",
+    "remotion": "4.0.89",
+    "@remotion/studio": "4.0.89"
   },
   "peerDependencies": {
     "react": ">=16.8.0",
@@ -61,8 +61,8 @@
     "react-dom": "18.2.0",
     "vitest": "0.31.1",
     "zod": "^3.22.3",
-    "@remotion/zod-types": "4.0.88",
-    "@remotion/tailwind": "4.0.88"
+    "@remotion/zod-types": "4.0.89",
+    "@remotion/tailwind": "4.0.89"
   },
   "keywords": [
     "remotion",