create-video 4.0.486 → 4.0.488

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/help.d.ts ADDED
@@ -0,0 +1 @@
1
+ export declare const getCreateVideoHelp: () => string;
package/dist/help.js ADDED
@@ -0,0 +1,48 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getCreateVideoHelp = void 0;
4
+ const templates_1 = require("./templates");
5
+ const formatOption = ({ flag, description, }) => {
6
+ return ` ${flag.padEnd(18)}${description}`;
7
+ };
8
+ const formatTemplateFlags = () => {
9
+ return templates_1.FEATURED_TEMPLATES.map((template) => ` --${template.cliId}`).join('\n');
10
+ };
11
+ const getCreateVideoHelp = () => {
12
+ return [
13
+ 'create-video',
14
+ '',
15
+ 'Scaffold a new Remotion project.',
16
+ '',
17
+ 'Usage:',
18
+ ' npx create-video --yes --blank my-video',
19
+ ' npx create-video [options] [directory]',
20
+ '',
21
+ 'Arguments:',
22
+ ' directory Directory in which the project should be created.',
23
+ '',
24
+ 'Options:',
25
+ formatOption({
26
+ flag: '--yes, -y',
27
+ description: 'Enable non-interactive mode. Requires a template flag and a directory, unless --tmp is used.',
28
+ }),
29
+ formatOption({
30
+ flag: '--no-tailwind',
31
+ description: 'Skip installing TailwindCSS when used with --yes.',
32
+ }),
33
+ formatOption({
34
+ flag: '--tmp',
35
+ description: 'Create the project in a temporary directory.',
36
+ }),
37
+ formatOption({
38
+ flag: '--help, -h',
39
+ description: 'Show this help.',
40
+ }),
41
+ '',
42
+ 'Template flags:',
43
+ formatTemplateFlags(),
44
+ '',
45
+ 'Full documentation: https://www.remotion.dev/docs/cli/create-video',
46
+ ].join('\n');
47
+ };
48
+ exports.getCreateVideoHelp = getCreateVideoHelp;
package/dist/init.js CHANGED
@@ -13,6 +13,7 @@ const ask_skills_1 = require("./ask-skills");
13
13
  const ask_tailwind_1 = require("./ask-tailwind");
14
14
  const create_public_folder_1 = require("./create-public-folder");
15
15
  const degit_1 = require("./degit");
16
+ const help_1 = require("./help");
16
17
  const make_link_1 = require("./hyperlinks/make-link");
17
18
  const install_skills_1 = require("./install-skills");
18
19
  const latest_remotion_version_1 = require("./latest-remotion-version");
@@ -71,6 +72,10 @@ const getGitStatus = async (root) => {
71
72
  }
72
73
  };
73
74
  const init = async () => {
75
+ if ((0, select_template_1.isHelpFlagSelected)()) {
76
+ log_1.Log.info((0, help_1.getCreateVideoHelp)());
77
+ return;
78
+ }
74
79
  log_1.Log.info(`Welcome to ${chalk_1.default.blue('Remotion')}!`);
75
80
  // Get directory argument if provided
76
81
  const directoryArgument = (0, select_template_1.getDirectoryArgument)();
@@ -2,6 +2,7 @@ import type { Template } from './templates';
2
2
  export declare const isTmpFlagSelected: () => boolean;
3
3
  export declare const isYesFlagSelected: () => boolean;
4
4
  export declare const isNoTailwindFlagSelected: () => boolean;
5
+ export declare const isHelpFlagSelected: () => boolean;
5
6
  export declare const getPositionalArguments: () => string[];
6
7
  export declare const getDirectoryArgument: () => string | null;
7
8
  export declare const isFlagSelected: {
@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.selectTemplate = exports.isFlagSelected = exports.getDirectoryArgument = exports.getPositionalArguments = exports.isNoTailwindFlagSelected = exports.isYesFlagSelected = exports.isTmpFlagSelected = void 0;
6
+ exports.selectTemplate = exports.isFlagSelected = exports.getDirectoryArgument = exports.getPositionalArguments = exports.isHelpFlagSelected = exports.isNoTailwindFlagSelected = exports.isYesFlagSelected = exports.isTmpFlagSelected = void 0;
7
7
  const chalk_1 = __importDefault(require("chalk"));
8
8
  const minimist_1 = __importDefault(require("minimist"));
9
9
  const make_link_1 = require("./hyperlinks/make-link");
@@ -11,9 +11,15 @@ const prompts_1 = require("./prompts");
11
11
  const templates_1 = require("./templates");
12
12
  const ALL_TEMPLATES = [...templates_1.FEATURED_TEMPLATES, ...templates_1.PAID_TEMPLATES];
13
13
  const parsed = (0, minimist_1.default)(process.argv.slice(2), {
14
- boolean: [...ALL_TEMPLATES.map((f) => f.cliId), 'tmp', 'yes', 'no-tailwind'],
14
+ boolean: [
15
+ ...ALL_TEMPLATES.map((f) => f.cliId),
16
+ 'tmp',
17
+ 'yes',
18
+ 'no-tailwind',
19
+ 'help',
20
+ ],
15
21
  string: ['_'],
16
- alias: { y: 'yes' },
22
+ alias: { y: 'yes', h: 'help' },
17
23
  });
18
24
  const isTmpFlagSelected = () => parsed.tmp;
19
25
  exports.isTmpFlagSelected = isTmpFlagSelected;
@@ -21,6 +27,8 @@ const isYesFlagSelected = () => parsed.yes;
21
27
  exports.isYesFlagSelected = isYesFlagSelected;
22
28
  const isNoTailwindFlagSelected = () => parsed['no-tailwind'];
23
29
  exports.isNoTailwindFlagSelected = isNoTailwindFlagSelected;
30
+ const isHelpFlagSelected = () => parsed.help;
31
+ exports.isHelpFlagSelected = isHelpFlagSelected;
24
32
  const getPositionalArguments = () => parsed._;
25
33
  exports.getPositionalArguments = getPositionalArguments;
26
34
  const getDirectoryArgument = () => {
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "url": "https://github.com/remotion-dev/remotion/tree/main/packages/create-video"
4
4
  },
5
5
  "name": "create-video",
6
- "version": "4.0.486",
6
+ "version": "4.0.488",
7
7
  "description": "Create a new Remotion project",
8
8
  "main": "dist/index.js",
9
9
  "bin": {
@@ -29,7 +29,7 @@
29
29
  "@types/minimist": "1.2.2",
30
30
  "@types/prompts": "2.4.9",
31
31
  "react": "19.2.3",
32
- "@remotion/eslint-config-internal": "4.0.486",
32
+ "@remotion/eslint-config-internal": "4.0.488",
33
33
  "eslint": "9.19.0",
34
34
  "@typescript/native-preview": "7.0.0-dev.20260217.1"
35
35
  },