create-video 4.0.0-webhook.27 → 4.1.0-alpha2

package/dist/patch-readme.js

@@ -4,12 +4,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.patchReadmeMd = void 0;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
 const pkg_managers_1 = require("./pkg-managers");
-const patchReadmeMd = (projectRoot, packageManager) => {
-    const fileName = path_1.default.join(projectRoot, 'README.md');
-    const contents = fs_1.default.readFileSync(fileName, 'utf8');
+const patchReadmeMd = (projectRoot, packageManager, template) => {
+    const fileName = node_path_1.default.join(projectRoot, 'README.md');
+    const contents = node_fs_1.default.readFileSync(fileName, 'utf8');
     const newContents = contents
         .split('\n')
         .map((c) => {
@@ -17,17 +17,17 @@ const patchReadmeMd = (projectRoot, packageManager) => {
             return (0, pkg_managers_1.getInstallCommand)(packageManager);
         }
         if (c.startsWith('npm start')) {
-            return (0, pkg_managers_1.getStartCommand)(packageManager);
+            return (0, pkg_managers_1.getDevCommand)(packageManager, template);
         }
         if (c.startsWith('npm run build')) {
             return (0, pkg_managers_1.getRenderCommand)(packageManager);
         }
-        if (c.startsWith('npm run upgrade')) {
-            return (0, pkg_managers_1.getUpgradeCommand)(packageManager);
+        if (c.startsWith('npm run ')) {
+            return (0, pkg_managers_1.getRunCommand)(packageManager) + c.replace('npm run', '');
         }
         return c;
     })
         .join('\n');
-    fs_1.default.writeFileSync(fileName, newContents);
+    node_fs_1.default.writeFileSync(fileName, newContents);
 };
 exports.patchReadmeMd = patchReadmeMd;

package/dist/pkg-managers.d.ts

@@ -1,6 +1,10 @@
-export declare type PackageManager = 'npm' | 'yarn' | 'pnpm';
+import type { Template } from './templates';
+export type PackageManager = 'npm' | 'yarn' | 'pnpm';
 export declare const selectPackageManager: () => PackageManager;
 export declare const getInstallCommand: (manager: PackageManager) => "yarn" | "npm i" | "pnpm i" | undefined;
-export declare const getStartCommand: (manager: PackageManager) => "npm start" | "yarn start" | "pnpm start" | undefined;
+export declare const getDevCommand: (manager: PackageManager, template: Template) => string | undefined;
+export declare const getRenderCommandForTemplate: (manager: PackageManager, template: Template) => string | undefined;
 export declare const getRenderCommand: (manager: PackageManager) => "npm run build" | "yarn build" | "pnpm build" | undefined;
-export declare const getUpgradeCommand: (manager: PackageManager) => "npm run upgrade" | "yarn run upgrade" | "pnpm run upgrade" | undefined;
+export declare const getRunCommand: (manager: PackageManager) => "npm run" | "yarn run" | "pnpm run";
+export declare const getPackageManagerVersion: (manager: PackageManager) => Promise<string>;
+export declare const getPackageManagerVersionOrNull: (manager: PackageManager) => Promise<string | null>;

package/dist/pkg-managers.js

@@ -3,15 +3,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getUpgradeCommand = exports.getRenderCommand = exports.getStartCommand = exports.getInstallCommand = exports.selectPackageManager = void 0;
-const path_1 = __importDefault(require("path"));
+exports.getPackageManagerVersionOrNull = exports.getPackageManagerVersion = exports.getRunCommand = exports.getRenderCommand = exports.getRenderCommandForTemplate = exports.getDevCommand = exports.getInstallCommand = exports.selectPackageManager = void 0;
+const node_child_process_1 = require("node:child_process");
+const node_path_1 = __importDefault(require("node:path"));
 const shouldUseYarn = () => {
     var _a, _b;
     return Boolean(((_a = process.env.npm_execpath) === null || _a === void 0 ? void 0 : _a.includes('yarn.js')) ||
         ((_b = process.env.npm_config_user_agent) === null || _b === void 0 ? void 0 : _b.includes('yarn')));
 };
 const shouldUsePnpm = () => {
-    if (__dirname.includes(path_1.default.join('.pnpm', 'create-video'))) {
+    if (__dirname.includes(node_path_1.default.join('.pnpm', 'create-video'))) {
         return true;
     }
     if (!process.env.npm_config_argv) {
@@ -47,6 +48,23 @@ const getInstallCommand = (manager) => {
     }
 };
 exports.getInstallCommand = getInstallCommand;
+const getDevCommand = (manager, template) => {
+    if (template.cliId === 'remix' || template.cliId === 'next') {
+        return `${(0, exports.getRunCommand)(manager)} dev`;
+    }
+    return getStartCommand(manager);
+};
+exports.getDevCommand = getDevCommand;
+const getRenderCommandForTemplate = (manager, template) => {
+    if (template.cliId === 'remix' || template.cliId === 'next') {
+        return `${(0, exports.getRunCommand)(manager)} remotion:render`;
+    }
+    if (template.cliId === 'still') {
+        return `${(0, exports.getRunCommand)(manager)} render`;
+    }
+    return (0, exports.getRenderCommand)(manager);
+};
+exports.getRenderCommandForTemplate = getRenderCommandForTemplate;
 const getStartCommand = (manager) => {
     if (manager === 'npm') {
         return `npm start`;
@@ -58,7 +76,6 @@ const getStartCommand = (manager) => {
         return `pnpm start`;
     }
 };
-exports.getStartCommand = getStartCommand;
 const getRenderCommand = (manager) => {
     if (manager === 'npm') {
         return `npm run build`;
@@ -71,15 +88,44 @@ const getRenderCommand = (manager) => {
     }
 };
 exports.getRenderCommand = getRenderCommand;
-const getUpgradeCommand = (manager) => {
+const getRunCommand = (manager) => {
     if (manager === 'npm') {
-        return `npm run upgrade`;
+        return `npm run`;
     }
     if (manager === 'yarn') {
-        return `yarn run upgrade`;
+        return `yarn run`;
     }
     if (manager === 'pnpm') {
-        return `pnpm run upgrade`;
+        return `pnpm run`;
+    }
+    throw new TypeError('unknown package manager');
+};
+exports.getRunCommand = getRunCommand;
+const getPackageManagerVersion = (manager) => {
+    const cmd = `${manager} -v`;
+    return new Promise((resolve, reject) => {
+        (0, node_child_process_1.exec)(cmd, (error, stdout, stderr) => {
+            if (error) {
+                reject(error);
+                return;
+            }
+            if (stderr) {
+                reject(stderr);
+                return;
+            }
+            resolve(stdout.trim());
+        });
+    });
+};
+exports.getPackageManagerVersion = getPackageManagerVersion;
+const getPackageManagerVersionOrNull = async (manager) => {
+    try {
+        const version = await (0, exports.getPackageManagerVersion)(manager);
+        return version;
+    }
+    catch (err) {
+        console.warn(`Could not determine the version of ${manager}.`);
+        return null;
     }
 };
-exports.getUpgradeCommand = getUpgradeCommand;
+exports.getPackageManagerVersionOrNull = getPackageManagerVersionOrNull;

package/dist/prompts.d.ts

@@ -1,10 +1,10 @@
 import type { Options, PromptObject } from 'prompts';
 import prompts from 'prompts';
-export declare type Question<V extends string = string> = PromptObject<V> & {
+export type Question<V extends string = string> = PromptObject<V> & {
     optionsPerPage?: number;
 };
-export declare type NamelessQuestion = Omit<Question<'value'>, 'name' | 'type'>;
-declare type PromptOptions = {
+export type NamelessQuestion = Omit<Question<'value'>, 'name' | 'type'>;
+type PromptOptions = {
     nonInteractiveHelp?: string;
 } & Options;
 declare function prompt(questions: Question | Question[], { nonInteractiveHelp, ...options }?: PromptOptions): Promise<prompts.Answers<string>>;

package/dist/resolve-project-root.js

@@ -5,8 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveProjectRoot = void 0;
 const chalk_1 = __importDefault(require("chalk"));
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
 const log_1 = require("./log");
 const mkdirp_1 = require("./mkdirp");
 const prompts_1 = __importDefault(require("./prompts"));
@@ -18,7 +18,7 @@ function assertValidName(folderName) {
     }
 }
 function assertFolderEmptyAsync(projectRoot) {
-    const conflicts = fs_1.default
+    const conflicts = node_fs_1.default
         .readdirSync(projectRoot)
         .filter((file) => !/\.iml$/.test(file));
     if (conflicts.length > 0) {
@@ -39,7 +39,7 @@ const resolveProjectRoot = async () => {
             message: 'What would you like to name your video?',
             initial: 'my-video',
             validate: (name) => {
-                const validation = (0, validate_name_1.validateName)(path_1.default.basename(path_1.default.resolve(name)));
+                const validation = (0, validate_name_1.validateName)(node_path_1.default.basename(node_path_1.default.resolve(name)));
                 if (typeof validation === 'string') {
                     return 'Invalid project name: ' + validation;
                 }
@@ -56,8 +56,8 @@ const resolveProjectRoot = async () => {
             throw error;
         }
     }
-    const projectRoot = path_1.default.resolve(projectName);
-    const folderName = path_1.default.basename(projectRoot);
+    const projectRoot = node_path_1.default.resolve(projectName);
+    const folderName = node_path_1.default.basename(projectRoot);
     assertValidName(folderName);
     (0, mkdirp_1.mkdirp)(projectRoot);
     if (assertFolderEmptyAsync(projectRoot).exists) {

package/dist/templates.d.ts

@@ -1,15 +1,28 @@
-export declare type Template = {
-    shortName: string;
-    description: string;
-    org: string;
-    repoName: string;
-    homePageLabel: string;
-    longerDescription: string;
+import React from 'react';
+type DynamicTemplate = {
+    type: 'video';
     promoVideo: {
         muxId: string;
         width: number;
         height: number;
     };
-    cliId: string;
+} | {
+    type: 'image';
+    promoBanner: {
+        src: string;
+        width: number;
+        height: number;
+    };
 };
+export type Template = {
+    shortName: string;
+    description: string;
+    org: string;
+    repoName: string;
+    homePageLabel: string;
+    longerDescription: React.ReactNode;
+    cliId: 'hello-world' | 'javascript' | 'blank' | 'next' | 'remix' | 'three' | 'still' | 'tts' | 'google-tts' | 'audiogram' | 'skia' | 'tailwind' | 'overlay';
+    defaultBranch: string;
+} & DynamicTemplate;
 export declare const FEATURED_TEMPLATES: Template[];
+export {};

package/dist/templates.js

@@ -1,13 +1,35 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FEATURED_TEMPLATES = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+function truthy(value) {
+    return Boolean(value);
+}
+const ENABLE_NEXT = false;
+const nextTemplate = {
+    homePageLabel: 'Next.js',
+    shortName: 'Next.js',
+    org: 'remotion-dev',
+    repoName: 'template-next',
+    description: 'SaaS template for video generation apps',
+    longerDescription: 'A software-as-a-service starter kit which has the Remotion Player and rendering via Remotion Lambda built-in. Our recommended choice for people who want to build a video generation app.',
+    promoBanner: {
+        width: 1280,
+        height: 720,
+        src: '/img/remix-template.png',
+    },
+    cliId: 'next',
+    type: 'image',
+    defaultBranch: 'main',
+};
+// Note that this page is statically analyzed by extract-articles.mjs
 exports.FEATURED_TEMPLATES = [
     {
-        homePageLabel: 'TypeScript',
+        homePageLabel: 'Hello World',
         shortName: 'Hello World',
         org: 'remotion-dev',
         repoName: 'template-helloworld',
-        description: 'The default starter template (recommended)',
+        description: 'A "Hello World" starter template',
         longerDescription: 'A basic template with TypeScript, Prettier and ESLint preconfigured. Our recommended choice for beginners.',
         promoVideo: {
             muxId: 'vKvV6aa7GXGlR01cmpc6J8Zz4Gkj9d2hBSnVYoef00900I',
@@ -15,10 +37,29 @@ exports.FEATURED_TEMPLATES = [
             width: 1920,
         },
         cliId: 'hello-world',
+        type: 'video',
+        defaultBranch: 'main',
+    },
+    ENABLE_NEXT ? nextTemplate : null,
+    {
+        homePageLabel: 'Blank',
+        shortName: 'Blank',
+        description: 'Nothing except an empty canvas',
+        org: 'remotion-dev',
+        repoName: 'template-empty',
+        longerDescription: 'A template containing nothing but an empty canvas. Recommended for people who already worked with Remotion.',
+        promoVideo: {
+            muxId: 'JD00x15y859GjqO7C9hpILkrSddGzd55K4lfj02dv8gU4',
+            width: 1280,
+            height: 720,
+        },
+        cliId: 'blank',
+        type: 'video',
+        defaultBranch: 'main',
     },
     {
         homePageLabel: 'JavaScript',
-        shortName: 'Hello World (Javascript)',
+        shortName: 'Hello World (JavaScript)',
         org: 'remotion-dev',
         repoName: 'template-helloworld-javascript',
         description: 'The default starter template in plain JS',
@@ -29,20 +70,24 @@ exports.FEATURED_TEMPLATES = [
             height: 1080,
         },
         cliId: 'javascript',
+        type: 'video',
+        defaultBranch: 'main',
     },
     {
-        homePageLabel: 'Blank',
-        shortName: 'Blank',
-        description: 'Nothing except an empty canvas',
+        homePageLabel: 'Remix',
+        shortName: 'Remix',
         org: 'remotion-dev',
-        repoName: 'template-empty',
-        longerDescription: 'A template containing nothing but an empty canvas. Recommended for people who already worked with Remotion.',
-        promoVideo: {
-            muxId: 'JD00x15y859GjqO7C9hpILkrSddGzd55K4lfj02dv8gU4',
+        repoName: 'template-remix',
+        description: 'Remotion + Remix Starter Kit',
+        longerDescription: 'A software-as-a-service starter kit which has the Remotion Player and rendering via Remotion Lambda built-in. Built with remix.run.',
+        promoBanner: {
             width: 1280,
             height: 720,
+            src: '/img/remix-template.png',
         },
-        cliId: 'blank',
+        cliId: 'remix',
+        type: 'image',
+        defaultBranch: 'main',
     },
     {
         homePageLabel: '3D',
@@ -57,6 +102,8 @@ exports.FEATURED_TEMPLATES = [
             height: 720,
         },
         cliId: 'three',
+        type: 'video',
+        defaultBranch: 'main',
     },
     {
         homePageLabel: 'Stills',
@@ -71,10 +118,12 @@ exports.FEATURED_TEMPLATES = [
             width: 1200,
         },
         cliId: 'still',
+        type: 'video',
+        defaultBranch: 'main',
     },
     {
-        homePageLabel: 'TTS',
-        shortName: 'Text To Speech',
+        homePageLabel: 'Text-To-Speech (Azure)',
+        shortName: 'TTS (Azure)',
         org: 'FelippeChemello',
         repoName: 'Remotion-TTS-Example',
         description: 'Turns text into speech and makes a video',
@@ -85,6 +134,24 @@ exports.FEATURED_TEMPLATES = [
             height: 1080,
         },
         cliId: 'tts',
+        type: 'video',
+        defaultBranch: 'master',
+    },
+    {
+        homePageLabel: 'Text-To-Speech (Google)',
+        shortName: 'TTS (Google)',
+        org: 'thecmdrunner',
+        repoName: 'remotion-gtts-template',
+        description: 'Turns text into speech and makes a video',
+        longerDescription: 'A template that turns text into a spoken video. Integrates with Firebase for Storage, and Google Cloud for Speech synthesis.',
+        promoVideo: {
+            muxId: '82dzhGhv3bl3p8LW009cFGd8oltqt6UvxTWdP27202BAY',
+            width: 1920,
+            height: 1080,
+        },
+        cliId: 'google-tts',
+        type: 'video',
+        defaultBranch: 'master',
     },
     {
         homePageLabel: 'Audiogram',
@@ -99,6 +166,8 @@ exports.FEATURED_TEMPLATES = [
             width: 1080,
         },
         cliId: 'audiogram',
+        type: 'video',
+        defaultBranch: 'main',
     },
     {
         homePageLabel: 'Skia',
@@ -113,6 +182,8 @@ exports.FEATURED_TEMPLATES = [
             width: 1920,
         },
         cliId: 'skia',
+        type: 'video',
+        defaultBranch: 'main',
     },
     {
         homePageLabel: 'Tailwind',
@@ -127,5 +198,23 @@ exports.FEATURED_TEMPLATES = [
             width: 1280,
         },
         cliId: 'tailwind',
+        type: 'video',
+        defaultBranch: 'main',
+    },
+    {
+        homePageLabel: 'Overlay',
+        shortName: 'Overlay',
+        org: 'remotion-dev',
+        repoName: 'template-overlay',
+        description: 'Overlays for video editing software',
+        longerDescription: ((0, jsx_runtime_1.jsxs)("span", { children: ["A starter template to create overlays to use in conventional video editing software.", ' ', (0, jsx_runtime_1.jsx)("a", { href: "/docs/overlay", children: "Read more about creating overlays." })] })),
+        promoVideo: {
+            muxId: 'zgy7XK01009y33Vfzhns02cZS00rOyeZ6WaanaxcrDysqmU',
+            height: 720,
+            width: 1280,
+        },
+        cliId: 'overlay',
+        type: 'video',
+        defaultBranch: 'main',
     },
-];
+].filter(truthy);

package/dist/test/git-status.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/git-status.test.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_path_1 = __importDefault(require("node:path"));
+const vitest_1 = require("vitest");
+const init_1 = require("../init");
+(0, vitest_1.test)('Get git status', async () => {
+    const status = await (0, init_1.checkGitAvailability)(process.cwd(), 'git', [
+        '--version',
+    ]);
+    if (status.type !== 'is-git-repo') {
+        throw new Error('is git repo');
+    }
+    (0, vitest_1.expect)(status.location ===
+        node_path_1.default.posix.join(__dirname, '..', '..', '..', '..').replace(/\\/g, '/') ||
+        status.location === 'D:/a/remotion/remotion').toEqual(true);
+    if (status.type !== 'is-git-repo') {
+        throw new Error('is git repo');
+    }
+    const status2 = await (0, init_1.checkGitAvailability)(node_path_1.default.dirname(status.location), 'git', ['--version']);
+    (0, vitest_1.expect)(status2).toEqual({ type: 'no-git-repo' });
+    const status3 = await (0, init_1.checkGitAvailability)(node_path_1.default.dirname(status.location), 'wronggitbinary', ['--version']);
+    (0, vitest_1.expect)(status3).toEqual({ type: 'git-not-installed' });
+});

package/dist/test/patch-package-json.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/patch-package-json.test.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const patch_package_json_1 = require("../patch-package-json");
+const packageManagers = ['npm', 'pnpm', 'yarn'];
+for (const packageManager of packageManagers) {
+    (0, vitest_1.test)(`Using ${packageManager} package manager provides the correct "packageManager" entry in package.json`, () => {
+        const latestRemotionVersion = '1.0.0';
+        const packageManagerVersion = '1.22.19';
+        const packageJson = {
+            name: 'my-video',
+            version: '1.0.0',
+            description: 'My Remotion video',
+            scripts: {
+                start: 'remotion studio',
+            },
+            dependencies: {
+                '@remotion/cli': 'stale-remotion-version',
+                react: '^18.0.0',
+                remotion: 'stale-remotion-version',
+            },
+            devDependencies: {
+                '@types/react': '^18.0.6',
+                '@remotion/eslint-config': '^2.0.0',
+            },
+        };
+        let newPackageJson = null;
+        (0, patch_package_json_1.patchPackageJson)({
+            projectRoot: '/path/to/project',
+            latestRemotionVersion,
+            packageManager: `${packageManager}@${packageManagerVersion}`,
+            projectName: 'my-video',
+        }, {
+            getPackageJson: () => JSON.stringify(packageJson),
+            setPackageJson: (_, content) => {
+                newPackageJson = JSON.parse(content);
+            },
+        });
+        (0, vitest_1.expect)(newPackageJson).to.deep.equal({
+            ...packageJson,
+            dependencies: {
+                ...packageJson.dependencies,
+                '@remotion/cli': latestRemotionVersion,
+                remotion: latestRemotionVersion,
+            },
+            devDependencies: {
+                ...packageJson.devDependencies,
+                '@remotion/eslint-config': latestRemotionVersion,
+            },
+            packageManager: `${packageManager}@${packageManagerVersion}`,
+        });
+    });
+}

package/dist/test/validate-templates.test.d.ts

@@ -0,0 +1 @@
+export {};