@remotion/cli 4.0.0-alpha.4 → 4.0.0-alpha11

package/dist/index.js

@@ -13,108 +13,134 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CliInternals = exports.overrideRemotion = exports.ConfigInternals = exports.cli = void 0;
+exports.CliInternals = exports.cli = void 0;
 const renderer_1 = require("@remotion/renderer");
+const minimist_1 = __importDefault(require("minimist"));
+const benchmark_1 = require("./benchmark");
 const chalk_1 = require("./chalk");
-const check_version_1 = require("./check-version");
+const cleanup_before_quit_1 = require("./cleanup-before-quit");
 const compositions_1 = require("./compositions");
-const index_1 = require("./config/index");
+const config_1 = require("./config");
+const determine_image_format_1 = require("./determine-image-format");
 const download_progress_1 = require("./download-progress");
-const find_closest_package_json_1 = require("./find-closest-package-json");
+const entry_point_1 = require("./entry-point");
+const ffmpeg_1 = require("./ffmpeg");
 const format_bytes_1 = require("./format-bytes");
 const get_cli_options_1 = require("./get-cli-options");
+const get_composition_with_dimension_override_1 = require("./get-composition-with-dimension-override");
 const get_config_file_name_1 = require("./get-config-file-name");
+const get_final_output_codec_1 = require("./get-final-output-codec");
 const handle_common_errors_1 = require("./handle-common-errors");
-const initialize_render_cli_1 = require("./initialize-render-cli");
+const image_formats_1 = require("./image-formats");
+const initialize_cli_1 = require("./initialize-cli");
 const lambda_command_1 = require("./lambda-command");
-const load_config_1 = require("./load-config");
+const list_of_remotion_packages_1 = require("./list-of-remotion-packages");
 const log_1 = require("./log");
 const make_progress_bar_1 = require("./make-progress-bar");
 const parse_command_line_1 = require("./parse-command-line");
-const preview_1 = require("./preview");
+const print_compositions_1 = require("./print-compositions");
 const print_help_1 = require("./print-help");
 const progress_bar_1 = require("./progress-bar");
 const render_1 = require("./render");
+const should_use_non_overlaying_logger_1 = require("./should-use-non-overlaying-logger");
 const still_1 = require("./still");
+const studio_1 = require("./studio");
 const upgrade_1 = require("./upgrade");
 const versions_1 = require("./versions");
 const cli = async () => {
-    (0, index_1.overrideRemotion)();
-    const args = process.argv;
-    const command = args[2];
+    const [command, ...args] = parse_command_line_1.parsedCli._;
     if (parse_command_line_1.parsedCli.help) {
         (0, print_help_1.printHelp)();
         process.exit(0);
     }
-    const remotionRoot = (0, find_closest_package_json_1.findRemotionRoot)();
-    // To check node version and to warn if node version is <12.10.0
-    (0, check_version_1.checkNodeVersion)();
+    const remotionRoot = renderer_1.RenderInternals.findRemotionRoot();
     if (command !== versions_1.VERSIONS_COMMAND) {
         await (0, versions_1.validateVersionsBeforeCommand)(remotionRoot);
     }
     const errorSymbolicationLock = renderer_1.RenderInternals.registerErrorSymbolicationLock();
+    (0, cleanup_before_quit_1.handleCtrlC)();
+    await (0, initialize_cli_1.initializeCli)(remotionRoot);
     try {
         if (command === 'compositions') {
-            await (0, compositions_1.listCompositionsCommand)(remotionRoot);
+            await (0, compositions_1.listCompositionsCommand)(remotionRoot, args);
         }
-        else if (command === 'preview') {
-            await (0, preview_1.previewCommand)(remotionRoot);
+        else if (command === 'preview' || command === 'studio') {
+            await (0, studio_1.studioCommand)(remotionRoot, args);
         }
         else if (command === 'lambda') {
-            await (0, lambda_command_1.lambdaCommand)(remotionRoot);
+            await (0, lambda_command_1.lambdaCommand)(remotionRoot, args);
         }
         else if (command === 'render') {
-            await (0, render_1.render)(remotionRoot);
+            await (0, render_1.render)(remotionRoot, args);
         }
         else if (command === 'still') {
-            await (0, still_1.still)(remotionRoot);
+            await (0, still_1.still)(remotionRoot, args);
+        }
+        else if (command === 'ffmpeg') {
+            (0, ffmpeg_1.ffmpegCommand)(remotionRoot, process.argv.slice(3));
+        }
+        else if (command === 'ffprobe') {
+            (0, ffmpeg_1.ffprobeCommand)(remotionRoot, process.argv.slice(3));
         }
         else if (command === 'upgrade') {
-            await (0, upgrade_1.upgrade)(remotionRoot);
+            await (0, upgrade_1.upgrade)(remotionRoot, parse_command_line_1.parsedCli['package-manager']);
         }
         else if (command === versions_1.VERSIONS_COMMAND) {
             await (0, versions_1.versionsCommand)(remotionRoot);
         }
+        else if (command === 'benchmark') {
+            await (0, benchmark_1.benchmarkCommand)(remotionRoot, args);
+        }
         else if (command === 'help') {
             (0, print_help_1.printHelp)();
             process.exit(0);
         }
         else {
-            log_1.Log.error(`Command ${command} not found.`);
+            if (command) {
+                log_1.Log.error(`Command ${command} not found.`);
+            }
             (0, print_help_1.printHelp)();
             process.exit(1);
         }
     }
     catch (err) {
         log_1.Log.info();
-        await (0, handle_common_errors_1.handleCommonError)(err);
+        await (0, handle_common_errors_1.handleCommonError)(err, config_1.ConfigInternals.Logging.getLogLevel());
+        (0, cleanup_before_quit_1.cleanupBeforeQuit)();
         process.exit(1);
     }
     finally {
         renderer_1.RenderInternals.unlockErrorSymbolicationLock(errorSymbolicationLock);
+        (0, cleanup_before_quit_1.cleanupBeforeQuit)();
     }
 };
 exports.cli = cli;
-var index_2 = require("./config/index");
-Object.defineProperty(exports, "ConfigInternals", { enumerable: true, get: function () { return index_2.ConfigInternals; } });
-Object.defineProperty(exports, "overrideRemotion", { enumerable: true, get: function () { return index_2.overrideRemotion; } });
 __exportStar(require("./render"), exports);
 exports.CliInternals = {
     createOverwriteableCliOutput: progress_bar_1.createOverwriteableCliOutput,
     chalk: chalk_1.chalk,
     makeProgressBar: make_progress_bar_1.makeProgressBar,
     Log: log_1.Log,
-    loadConfigFile: load_config_1.loadConfigFile,
     getCliOptions: get_cli_options_1.getCliOptions,
-    parseCommandLine: parse_command_line_1.parseCommandLine,
     loadConfig: get_config_file_name_1.loadConfig,
-    initializeRenderCli: initialize_render_cli_1.initializeRenderCli,
+    initializeCli: initialize_cli_1.initializeCli,
     BooleanFlags: parse_command_line_1.BooleanFlags,
     quietFlagProvided: parse_command_line_1.quietFlagProvided,
     parsedCli: parse_command_line_1.parsedCli,
     handleCommonError: handle_common_errors_1.handleCommonError,
     formatBytes: format_bytes_1.formatBytes,
     getFileSizeDownloadBar: download_progress_1.getFileSizeDownloadBar,
-    findRemotionRoot: find_closest_package_json_1.findRemotionRoot,
+    determineFinalStillImageFormat: determine_image_format_1.determineFinalStillImageFormat,
+    minimist: minimist_1.default,
+    findEntryPoint: entry_point_1.findEntryPoint,
+    getVideoImageFormat: image_formats_1.getVideoImageFormat,
+    printCompositions: print_compositions_1.printCompositions,
+    getFinalOutputCodec: get_final_output_codec_1.getFinalOutputCodec,
+    listOfRemotionPackages: list_of_remotion_packages_1.listOfRemotionPackages,
+    shouldUseNonOverlayingLogger: should_use_non_overlaying_logger_1.shouldUseNonOverlayingLogger,
+    getCompositionWithDimensionOverride: get_composition_with_dimension_override_1.getCompositionWithDimensionOverride,
 };

package/dist/initialize-cli.d.ts

@@ -0,0 +1 @@
+export declare const initializeCli: (remotionRoot: string) => Promise<void>;

package/dist/{initialize-render-cli.js → initialize-cli.js}

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initializeRenderCli = void 0;
+exports.initializeCli = void 0;
 const get_config_file_name_1 = require("./get-config-file-name");
 const log_1 = require("./log");
 const parse_command_line_1 = require("./parse-command-line");
-const initializeRenderCli = async (remotionRoot, type) => {
+const initializeCli = async (remotionRoot) => {
     const appliedName = await (0, get_config_file_name_1.loadConfig)(remotionRoot);
-    (0, parse_command_line_1.parseCommandLine)(type);
+    (0, parse_command_line_1.parseCommandLine)();
     // Only now Log.verbose is available
     log_1.Log.verbose('Remotion root directory:', remotionRoot);
     if (remotionRoot !== process.cwd()) {
@@ -19,4 +19,4 @@ const initializeRenderCli = async (remotionRoot, type) => {
         log_1.Log.verbose('No config file loaded.');
     }
 };
-exports.initializeRenderCli = initializeRenderCli;
+exports.initializeCli = initializeCli;

package/dist/install.d.ts

@@ -0,0 +1,2 @@
+export declare const INSTALL_COMMAND: "install";
+export declare const installCommand: (remotionRoot: string, args: string[]) => Promise<void>;

package/dist/install.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.installCommand = exports.INSTALL_COMMAND = void 0;
+const renderer_1 = require("@remotion/renderer");
+const log_1 = require("./log");
+exports.INSTALL_COMMAND = 'install';
+const installCommand = async (remotionRoot, args) => {
+    const firstArg = args[0];
+    if (firstArg === 'ffmpeg') {
+        const { wasAlreadyInstalled } = await (0, renderer_1.ensureFfmpeg)({ remotionRoot });
+        if (wasAlreadyInstalled) {
+            log_1.Log.info('FFmpeg is already installed');
+        }
+        else {
+            log_1.Log.info('Successfully installed FFmpeg');
+        }
+        return;
+    }
+    if (firstArg === 'ffprobe') {
+        const { wasAlreadyInstalled } = await (0, renderer_1.ensureFfprobe)({ remotionRoot });
+        if (wasAlreadyInstalled) {
+            log_1.Log.info('FFmpeg is already installed');
+        }
+        else {
+            log_1.Log.info('Successfully installed FFmpeg');
+        }
+        return;
+    }
+    log_1.Log.error('Please specify either "ffmpeg" or "ffprobe" as the first argument to the install command');
+    log_1.Log.error();
+    log_1.Log.info('Example Usage: ');
+    log_1.Log.info(' remotion install ffmpeg');
+    log_1.Log.info(' remotion install ffprobe');
+    process.exit(1);
+};
+exports.installCommand = installCommand;

package/dist/lambda-command.d.ts

@@ -1 +1 @@
-export declare const lambdaCommand: (remotionRoot: string) => Promise<never>;
+export declare const lambdaCommand: (remotionRoot: string, args: string[]) => Promise<never>;

package/dist/lambda-command.js

@@ -1,29 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.lambdaCommand = void 0;
-const initialize_render_cli_1 = require("./initialize-render-cli");
 const log_1 = require("./log");
-const parse_command_line_1 = require("./parse-command-line");
 const get_package_manager_1 = require("./preview-server/get-package-manager");
 const update_available_1 = require("./preview-server/update-available");
-const lambdaCommand = async (remotionRoot) => {
+const lambdaCommand = async (remotionRoot, args) => {
     try {
         const path = require.resolve('@remotion/lambda', {
             paths: [remotionRoot],
         });
         const { LambdaInternals } = require(path);
-        await (0, initialize_render_cli_1.initializeRenderCli)(remotionRoot, 'lambda');
-        await LambdaInternals.executeCommand(parse_command_line_1.parsedCli._.slice(1));
+        await LambdaInternals.executeCommand(args, remotionRoot);
         process.exit(0);
     }
     catch (err) {
-        const manager = (0, get_package_manager_1.getPackageManager)(remotionRoot);
+        const manager = (0, get_package_manager_1.getPackageManager)(remotionRoot, undefined);
         const installCommand = manager === 'unknown' ? 'npm i' : manager.installCommand;
         log_1.Log.error(err);
         log_1.Log.error('Remotion Lambda is not installed.');
         log_1.Log.info('');
         log_1.Log.info('You can install it using:');
-        log_1.Log.info(`${installCommand} i @remotion/lambda@${(0, update_available_1.getRemotionVersion)()}`);
+        log_1.Log.info(`${installCommand} @remotion/lambda@${(0, update_available_1.getRemotionVersion)()}`);
         process.exit(1);
     }
 };

package/dist/list-of-remotion-packages.d.ts

@@ -0,0 +1 @@
+export declare const listOfRemotionPackages: string[];

package/dist/list-of-remotion-packages.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listOfRemotionPackages = void 0;
+// Keep in sync with create-video
+exports.listOfRemotionPackages = [
+    '@remotion/bundler',
+    '@remotion/cli',
+    '@remotion/eslint-config',
+    '@remotion/eslint-plugin',
+    '@remotion/renderer',
+    '@remotion/skia',
+    '@remotion/lottie',
+    '@remotion/media-utils',
+    '@remotion/motion-blur',
+    '@remotion/google-fonts',
+    '@remotion/noise',
+    '@remotion/paths',
+    '@remotion/babel-loader',
+    '@remotion/lambda',
+    '@remotion/player',
+    '@remotion/preload',
+    '@remotion/three',
+    '@remotion/rive',
+    '@remotion/gif',
+    '@remotion/shapes',
+    '@remotion/zod-types',
+    '@remotion/tailwind',
+    'remotion',
+];

package/dist/load-config.js

@@ -5,38 +5,29 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadConfigFile = void 0;
 const bundler_1 = require("@remotion/bundler");
-const fs_1 = __importDefault(require("fs"));
-const os_1 = __importDefault(require("os"));
-const path_1 = __importDefault(require("path"));
-const worker_threads_1 = require("worker_threads");
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const node_worker_threads_1 = require("node:worker_threads");
 const log_1 = require("./log");
 const loadConfigFile = async (remotionRoot, configFileName, isJavascript) => {
-    const resolved = path_1.default.resolve(remotionRoot, configFileName);
-    const tsconfigJson = path_1.default.join(remotionRoot, 'tsconfig.json');
-    if (!isJavascript && !fs_1.default.existsSync(tsconfigJson)) {
+    const resolved = node_path_1.default.resolve(remotionRoot, configFileName);
+    const tsconfigJson = node_path_1.default.join(remotionRoot, 'tsconfig.json');
+    if (!isJavascript && !node_fs_1.default.existsSync(tsconfigJson)) {
         log_1.Log.error('Could not find a tsconfig.json file in your project. Did you delete it? Create a tsconfig.json in the root of your project. Copy the default file from https://github.com/remotion-dev/template-helloworld/blob/main/tsconfig.json.');
         log_1.Log.error('The root directory is:', remotionRoot);
         process.exit(1);
     }
-    const out = path_1.default.join(await fs_1.default.promises.mkdtemp(path_1.default.join(os_1.default.tmpdir(), 'remotion-')), 'bundle.js');
+    const virtualOutfile = 'bundle.js';
     const result = await bundler_1.BundlerInternals.esbuild.build({
         platform: 'node',
-        target: 'node14',
+        target: 'node16',
         bundle: true,
         entryPoints: [resolved],
         tsconfig: isJavascript ? undefined : tsconfigJson,
         absWorkingDir: remotionRoot,
-        outfile: out,
-        external: [
-            'remotion',
-            // Dependencies of babel-loader that trigger a warning when used
-            'react-refresh/babel',
-            '@babel/plugin-proposal-class-properties',
-            '@babel/preset-typescript',
-            '@babel/preset-react',
-            'babel-loader',
-            '@babel/preset-env',
-        ],
+        outfile: virtualOutfile,
+        write: false,
+        packages: 'external',
     });
     if (result.errors.length > 0) {
         log_1.Log.error('Error in remotion.config.ts file');
@@ -45,19 +36,18 @@ const loadConfigFile = async (remotionRoot, configFileName, isJavascript) => {
         }
         process.exit(1);
     }
-    const file = await fs_1.default.promises.readFile(out, 'utf8');
+    const str = new TextDecoder().decode(result.outputFiles[0].contents);
     const currentCwd = process.cwd();
     // The config file is always executed from the Remotion root, if `process.cwd()` is being used. We cannot enforce this in worker threads used for testing
-    if (worker_threads_1.isMainThread) {
+    if (node_worker_threads_1.isMainThread) {
         process.chdir(remotionRoot);
     }
     // Exectute the contents of the config file
     // eslint-disable-next-line no-eval
-    eval(file);
-    if (worker_threads_1.isMainThread) {
+    eval(str);
+    if (node_worker_threads_1.isMainThread) {
         process.chdir(currentCwd);
     }
-    await fs_1.default.promises.unlink(out);
     return resolved;
 };
 exports.loadConfigFile = loadConfigFile;

package/dist/log.d.ts

@@ -1,6 +1,20 @@
 export declare const Log: {
     verbose: (message?: any, ...optionalParams: any[]) => void;
+    verboseAdvanced: (options: {
+        indent: boolean;
+        logLevel: "verbose" | "info" | "warn" | "error";
+    } & {
+        tag?: string | undefined;
+    }, message?: any, ...optionalParams: any[]) => void;
     info: (message?: any, ...optionalParams: any[]) => void;
+    infoAdvanced: (options: {
+        indent: boolean;
+        logLevel: "verbose" | "info" | "warn" | "error";
+    }, message?: any, ...optionalParams: any[]) => void;
     warn: (message?: any, ...optionalParams: any[]) => void;
+    warnAdvanced: (options: {
+        indent: boolean;
+        logLevel: "verbose" | "info" | "warn" | "error";
+    }, message?: any, ...optionalParams: any[]) => void;
     error: (message?: any, ...optionalParams: any[]) => void;
 };

package/dist/log.js

@@ -3,27 +3,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Log = void 0;
 /* eslint-disable no-console */
 const renderer_1 = require("@remotion/renderer");
-const chalk_1 = require("./chalk");
-const config_1 = require("./config");
-exports.Log = {
-    verbose: (...args) => {
-        if (renderer_1.RenderInternals.isEqualOrBelowLogLevel(config_1.ConfigInternals.Logging.getLogLevel(), 'verbose')) {
-            return console.log(...args.map((a) => chalk_1.chalk.blueBright(a)));
-        }
-    },
-    info: (...args) => {
-        if (renderer_1.RenderInternals.isEqualOrBelowLogLevel(config_1.ConfigInternals.Logging.getLogLevel(), 'info')) {
-            return console.log(...args);
-        }
-    },
-    warn: (...args) => {
-        if (renderer_1.RenderInternals.isEqualOrBelowLogLevel(config_1.ConfigInternals.Logging.getLogLevel(), 'warn')) {
-            return console.warn(...args.map((a) => chalk_1.chalk.yellow(a)));
-        }
-    },
-    error: (...args) => {
-        if (renderer_1.RenderInternals.isEqualOrBelowLogLevel(config_1.ConfigInternals.Logging.getLogLevel(), 'error')) {
-            return console.error(...args.map((a) => chalk_1.chalk.red(a)));
-        }
-    },
-};
+exports.Log = renderer_1.RenderInternals.Log;

package/dist/make-progress-bar.js

@@ -1,9 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeProgressBar = void 0;
+const full = '─';
+const half = '╴';
 const makeProgressBar = (percentage) => {
     const totalBars = 20;
     const barsToShow = Math.floor(percentage * totalBars);
-    return `[${'='.repeat(barsToShow).padEnd(totalBars, ' ')}]`;
+    const extraBar = (percentage * totalBars) % barsToShow;
+    const base = full.repeat(barsToShow) + (extraBar > 0.5 ? half : '');
+    if (percentage === 0) {
+        return `${' '.repeat(totalBars + 1)}`;
+    }
+    if (percentage > 0 && barsToShow < 1) {
+        return `╷${' '.repeat(totalBars)}`;
+    }
+    if (percentage >= 1) {
+        return `╭${base.substring(0, base.length - 1)}╮`;
+    }
+    return `╭${base.padEnd(totalBars, ' ')}`;
 };
 exports.makeProgressBar = makeProgressBar;

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

@@ -1,11 +1,8 @@
-import type { BrowserExecutable, Codec, FfmpegExecutable, ImageFormat, OpenGlRenderer, PixelFormat, ProResProfile } from '@remotion/renderer';
-import minimist from 'minimist';
-export declare type CommandLineOptions = {
+import type { AudioCodec, BrowserExecutable, Codec, OpenGlRenderer, PixelFormat, ProResProfile, StillImageFormat, VideoImageFormat } from '@remotion/renderer';
+declare type CommandLineOptions = {
     ['browser-executable']: BrowserExecutable;
-    ['ffmpeg-executable']: FfmpegExecutable;
-    ['ffprobe-executable']: FfmpegExecutable;
     ['pixel-format']: PixelFormat;
-    ['image-format']: ImageFormat;
+    ['image-format']: VideoImageFormat | StillImageFormat;
     ['prores-profile']: ProResProfile;
     ['bundle-cache']: string;
     ['env-file']: string;
@@ -13,16 +10,23 @@ export declare type CommandLineOptions = {
     ['disable-web-security']: string;
     ['every-nth-frame']: number;
     ['number-of-gif-loops']: number;
+    ['number-of-shared-audio-tags']: number;
     codec: Codec;
     concurrency: number;
     timeout: number;
     config: string;
+    ['public-dir']: string;
+    ['audio-bitrate']: string;
+    ['video-bitrate']: string;
+    ['audio-codec']: AudioCodec;
     crf: number;
     force: boolean;
+    output: string;
     overwrite: boolean;
     png: boolean;
     props: string;
     quality: number;
+    ['jpeg-quality']: number;
     frames: string | number;
     scale: number;
     sequence: boolean;
@@ -33,9 +37,25 @@ export declare type CommandLineOptions = {
     port: number;
     frame: string | number;
     ['disable-headless']: boolean;
+    ['disable-keyboard-shortcuts']: boolean;
+    muted: boolean;
+    height: number;
+    width: number;
+    runs: number;
+    concurrencies: string;
+    ['enforce-audio-track']: boolean;
     gl: OpenGlRenderer;
+    ['package-manager']: string;
+    ['webpack-poll']: number;
+    ['no-open']: boolean;
+    ['browser']: string;
+    ['browser-args']: string;
+    ['user-agent']: string;
 };
 export declare const BooleanFlags: string[];
-export declare const parsedCli: CommandLineOptions & minimist.ParsedArgs;
-export declare const parseCommandLine: (type: 'still' | 'sequence' | 'lambda' | 'preview' | 'versions') => void;
+export declare const parsedCli: CommandLineOptions & {
+    _: string[];
+};
+export declare const parseCommandLine: () => void;
 export declare const quietFlagProvided: () => boolean;
+export {};