Skip to content

🎥 Make videos programmatically with React

Add Nub package manager support

Igor Samokhovetsbd9595f434d4
diff --git a/packages/create-video/src/pkg-managers.ts b/packages/create-video/src/pkg-managers.ts
index a74045692e..b45fbafd74 100644
--- a/packages/create-video/src/pkg-managers.ts
+++ b/packages/create-video/src/pkg-managers.ts
@@ -3,7 +3,7 @@ import path from 'node:path';
import {Log} from './log';
import type {Template} from './templates';
-export type PackageManager = 'npm' | 'yarn' | 'pnpm' | 'bun';
+export type PackageManager = 'npm' | 'yarn' | 'pnpm' | 'bun' | 'nub';
const shouldUseBun = (): boolean => {
if (
@@ -41,6 +41,10 @@ const shouldUsePnpm = (): boolean => {
};
export const selectPackageManager = (): PackageManager => {
+ if (process.env.npm_config_user_agent?.includes('nub/')) {
+ return 'nub';
+ }
+
if (shouldUseYarn()) {
return 'yarn';
}
@@ -72,6 +76,10 @@ export const getInstallCommand = (manager: PackageManager) => {
if (manager === 'bun') {
return `bun install`;
}
+
+ if (manager === 'nub') {
+ return `nub install`;
+ }
};
const getStartCommand = (manager: PackageManager) => {
@@ -90,6 +98,10 @@ const getStartCommand = (manager: PackageManager) => {
if (manager === 'bun') {
return `bun run dev`;
}
+
+ if (manager === 'nub') {
+ return `nub run dev`;
+ }
};
export const getRunCommand = (manager: PackageManager) => {
@@ -109,6 +121,10 @@ export const getRunCommand = (manager: PackageManager) => {
return `bun run`;
}
+ if (manager === 'nub') {
+ return `nub run`;
+ }
+
throw new TypeError('unknown package manager');
};
@@ -129,6 +145,10 @@ export const getRenderCommand = (manager: PackageManager) => {
return `bunx remotion render`;
}
+ if (manager === 'nub') {
+ return `nubx remotion render`;
+ }
+
throw new TypeError('unknown package manager');
};
@@ -149,6 +169,10 @@ export const getUpgradeCommand = (manager: PackageManager) => {
return `bunx remotion upgrade`;
}
+ if (manager === 'nub') {
+ return `nubx remotion upgrade`;
+ }
+
throw new TypeError('unknown package manager');
};
diff --git a/packages/create-video/src/test/patch-package-json.test.ts b/packages/create-video/src/test/patch-package-json.test.ts
index e061c6a4ab..c3a104ce4a 100644
--- a/packages/create-video/src/test/patch-package-json.test.ts
+++ b/packages/create-video/src/test/patch-package-json.test.ts
@@ -2,7 +2,7 @@ import {expect, test} from 'bun:test';
import {patchPackageJson} from '../patch-package-json';
import type {PackageManager} from '../pkg-managers';
-const packageManagers: PackageManager[] = ['npm', 'pnpm', 'yarn', 'bun'];
+const packageManagers: PackageManager[] = ['npm', 'pnpm', 'yarn', 'bun', 'nub'];
for (const packageManager of packageManagers) {
test(`Using ${packageManager} package manager provides the correct "packageManager" entry in package.json`, () => {
diff --git a/packages/create-video/src/test/pkg-managers.test.ts b/packages/create-video/src/test/pkg-managers.test.ts
new file mode 100644
index 0000000000..05bf9f042d
--- /dev/null
+++ b/packages/create-video/src/test/pkg-managers.test.ts
@@ -0,0 +1,63 @@
+import {expect, test} from 'bun:test';
+import {
+ getDevCommand,
+ getInstallCommand,
+ getRenderCommand,
+ getRunCommand,
+ getUpgradeCommand,
+ selectPackageManager,
+} from '../pkg-managers';
+import {FEATURED_TEMPLATES} from '../templates';
+
+test('detects Nub and uses Nub commands', () => {
+ const previousUserAgent = process.env.npm_config_user_agent;
+ const previousExecPath = process.env.npm_execpath;
+ const previousArgv = process.env.npm_config_argv;
+
+ try {
+ process.env.npm_config_user_agent = 'nub/0.8.2 yarn/1.22.22';
+ process.env.npm_execpath = '/path/to/yarn.js';
+ process.env.npm_config_argv = JSON.stringify({remain: ['dlx']});
+
+ expect(selectPackageManager()).toBe('nub');
+
+ const blankTemplate = FEATURED_TEMPLATES.find(
+ (template) => template.cliId === 'blank',
+ );
+ if (!blankTemplate) {
+ throw new Error('Blank template not found');
+ }
+
+ expect([
+ getInstallCommand('nub'),
+ getDevCommand('nub', blankTemplate),
+ getRunCommand('nub'),
+ getRenderCommand('nub'),
+ getUpgradeCommand('nub'),
+ ]).toEqual([
+ 'nub install',
+ 'nub run dev',
+ 'nub run',
+ 'nubx remotion render',
+ 'nubx remotion upgrade',
+ ]);
+ } finally {
+ if (previousUserAgent === undefined) {
+ delete process.env.npm_config_user_agent;
+ } else {
+ process.env.npm_config_user_agent = previousUserAgent;
+ }
+
+ if (previousExecPath === undefined) {
+ delete process.env.npm_execpath;
+ } else {
+ process.env.npm_execpath = previousExecPath;
+ }
+
+ if (previousArgv === undefined) {
+ delete process.env.npm_config_argv;
+ } else {
+ process.env.npm_config_argv = previousArgv;
+ }
+ }
+});
diff --git a/packages/docs/docs/getting-started.mdx b/packages/docs/docs/getting-started.mdx
index 00748a0f6f..f7616c12f8 100644
--- a/packages/docs/docs/getting-started.mdx
+++ b/packages/docs/docs/getting-started.mdx
@@ -57,6 +57,7 @@ values={[
{ label: 'bun', value: 'bun', },
{ label: 'pnpm', value: 'pnpm', },
{ label: 'yarn', value: 'yarn', },
+{ label: 'nub', value: 'nub', },
]
}>
<TabItem value="npm">
@@ -82,6 +83,14 @@ yarn create video
</TabItem>
+ <TabItem value="nub">
+
+```bash title="Use Nub as the package manager"
+nubx create-video@latest
+```
+
+ </TabItem>
+
<TabItem value="bun">
```bash title="Use Bun as the package manager and runtime"
diff --git a/packages/renderer/src/options/package-manager.tsx b/packages/renderer/src/options/package-manager.tsx
index c727d783c7..3eda8c40c0 100644
--- a/packages/renderer/src/options/package-manager.tsx
+++ b/packages/renderer/src/options/package-manager.tsx
@@ -14,7 +14,7 @@ export const packageManagerOption = {
auto-detect the package manager based on your lockfile.
<br />
Acceptable values are <code>npm</code>, <code>yarn</code>,{' '}
- <code>pnpm</code> and <code>bun</code>.
+ <code>pnpm</code>, <code>bun</code> and <code>nub</code>.
</>
);
},
diff --git a/packages/studio-server/src/helpers/install-command.ts b/packages/studio-server/src/helpers/install-command.ts
index 691f22a342..ff29d758f2 100644
--- a/packages/studio-server/src/helpers/install-command.ts
+++ b/packages/studio-server/src/helpers/install-command.ts
@@ -25,6 +25,7 @@ export const getInstallCommand = ({
pnpm: ['i', ...additionalArgs, ...pkgList],
yarn: ['add', '--exact', ...additionalArgs, ...pkgList],
bun: ['i', ...additionalArgs, ...pkgList],
+ nub: ['add', ...additionalArgs, ...pkgList],
};
return commands[manager];
diff --git a/packages/studio-server/src/preview-server/get-package-manager.ts b/packages/studio-server/src/preview-server/get-package-manager.ts
index 7aef10e28f..f28fe9b15a 100644
--- a/packages/studio-server/src/preview-server/get-package-manager.ts
+++ b/packages/studio-server/src/preview-server/get-package-manager.ts
@@ -30,6 +30,12 @@ export const lockFilePaths: LockfilePath[] = [
installCommand: 'pnpm i',
startCommand: 'pnpm exec remotion studio',
},
+ {
+ path: 'nub.lock',
+ manager: 'nub',
+ installCommand: 'nub add',
+ startCommand: 'nubx remotion studio',
+ },
{
path: 'bun.lock',
manager: 'bun',
diff --git a/packages/studio-server/src/test/install-dependency.test.ts b/packages/studio-server/src/test/install-dependency.test.ts
index bd7e7c76b8..4ffa80bab7 100644
--- a/packages/studio-server/src/test/install-dependency.test.ts
+++ b/packages/studio-server/src/test/install-dependency.test.ts
@@ -89,6 +89,7 @@ test('installs without running dependency lifecycle scripts', async () => {
pnpm: 'pnpm-lock.yaml',
yarn: 'yarn.lock',
bun: 'bun.lock',
+ nub: 'nub.lock',
};
const temporaryDirectories: string[] = [];
@@ -125,6 +126,11 @@ test('installs without running dependency lifecycle scripts', async () => {
expect(spawnCalls).toHaveLength(1);
const [call] = spawnCalls;
expect(call.command).toBe(manager);
+ expect(call.args).toContain('[email protected]');
+ if (manager === 'nub') {
+ expect(call.args[0]).toBe('add');
+ }
+
if (manager === 'yarn') {
expect(call.args).not.toContain('--ignore-scripts');
expect(call.options.env?.YARN_ENABLE_SCRIPTS).toBe('false');
diff --git a/packages/studio-shared/src/package-manager.ts b/packages/studio-shared/src/package-manager.ts
index 4d04f861d7..a3affa8041 100644
--- a/packages/studio-shared/src/package-manager.ts
+++ b/packages/studio-shared/src/package-manager.ts
@@ -1 +1 @@
-export type PackageManager = 'npm' | 'yarn' | 'pnpm' | 'bun';
+export type PackageManager = 'npm' | 'yarn' | 'pnpm' | 'bun' | 'nub';
diff --git a/packages/studio/src/components/UpdatesSettings.tsx b/packages/studio/src/components/UpdatesSettings.tsx
index 3a6e126873..990bf0d269 100644
--- a/packages/studio/src/components/UpdatesSettings.tsx
+++ b/packages/studio/src/components/UpdatesSettings.tsx
@@ -107,6 +107,7 @@ const commands: {
yarn: 'yarn remotion upgrade',
pnpm: 'pnpm exec remotion upgrade',
bun: 'bun remotion upgrade',
+ nub: 'nubx remotion upgrade',
unknown: 'npx remotion upgrade',
};