Skip to content

🎥 Make videos programmatically with React

refactor(codemods): use batched JSX deletion

JonnyBurgerfcd6bf74ba62
diff --git a/packages/browser-studio/src/browser-studio-operations.ts b/packages/browser-studio/src/browser-studio-operations.ts
index 0f667b0359..24057a11ae 100644
--- a/packages/browser-studio/src/browser-studio-operations.ts
+++ b/packages/browser-studio/src/browser-studio-operations.ts
@@ -44,7 +44,7 @@ const {
computeSequencePropsStatusFromContent,
computeSequencePropsSubscriptionFromContent,
deleteEffects: deleteEffectsCodemod,
- deleteJsxNodes,
+ deleteJsxNodes: deleteJsxNodesCodemod,
duplicateCompositionInSource,
duplicateEffects: duplicateEffectsCodemod,
duplicateJsxNodes: duplicateJsxNodesCodemod,
@@ -1240,7 +1240,7 @@ export const createBrowserStudioOperations = ({
},
};
- const deleteJsxNode: BrowserStudioOperations['deleteJsxNode'] = async ({
+ const deleteJsxNodes: BrowserStudioOperations['deleteJsxNodes'] = async ({
nodes,
}) => {
try {
@@ -1266,7 +1266,7 @@ export const createBrowserStudioOperations = ({
const updates = await Promise.all(
[...nodesByFile].map(async ([fileName, nodePaths]) => ({
fileName,
- result: await deleteJsxNodes({
+ result: await deleteJsxNodesCodemod({
input: project.files[fileName],
nodePaths,
}),
@@ -2067,7 +2067,7 @@ export const createBrowserStudioOperations = ({
sourceOrigin: value.sourceOrigin,
};
},
- deleteJsxNode,
+ deleteJsxNodes,
deleteStaticFile: controller.deleteStaticFile,
downloadRemoteAsset: (request) =>
downloadRemoteAssetInBrowserStudio({
diff --git a/packages/browser-studio/src/test/browser-studio-project-operations.test.ts b/packages/browser-studio/src/test/browser-studio-project-operations.test.ts
index 2e7793faf7..e6246c91db 100644
--- a/packages/browser-studio/src/test/browser-studio-project-operations.test.ts
+++ b/packages/browser-studio/src/test/browser-studio-project-operations.test.ts
@@ -119,7 +119,7 @@ test('mutates virtual files, emits events, and preserves undo and redo history',
throw new Error('Expected the inserted Solid to have a node path');
}
- const deleteResult = await operations.deleteJsxNode({
+ const deleteResult = await operations.deleteJsxNodes({
nodes: [
{
fileName: '/project/src/Composition.tsx',
diff --git a/packages/codemods/README.md b/packages/codemods/README.md
index 142568dd9f..414e9cdf02 100644
--- a/packages/codemods/README.md
+++ b/packages/codemods/README.md
@@ -29,12 +29,11 @@ Mounted JSX elements can be deleted using the same node paths that Remotion
Canvas and Studio use:
```tsx
-import {deleteJsxNode} from '@remotion/codemods';
+import {deleteJsxNodes} from '@remotion/codemods';
-const removed = await deleteJsxNode({
- project: result.project,
- filePath: result.insertedNode.filePath,
- nodePath: result.insertedNode.nodePath,
+const removed = await deleteJsxNodes({
+ project: result.project,
+ nodes: [result.insertedNode],
});
```
diff --git a/packages/codemods/src/composition-source-edits.ts b/packages/codemods/src/composition-source-edits.ts
index 100635dc81..971843491b 100644
--- a/packages/codemods/src/composition-source-edits.ts
+++ b/packages/codemods/src/composition-source-edits.ts
@@ -2,7 +2,7 @@ import type {JSXElement} from '@babel/types';
import type {RecastCodemod} from '@remotion/studio-shared';
import {namedTypes} from 'ast-types';
import * as recast from 'recast';
-import {getNodeSourceEdit} from './delete-jsx-node-internal';
+import {getNodeSourceEdit} from './delete-jsx-nodes-internal';
import {getCompositionId} from './duplicate-composition';
import {getInsertionRootSourceEdit} from './insert-jsx-element';
import {printInsertedJsx} from './print-jsx';
diff --git a/packages/codemods/src/delete-jsx-node.ts b/packages/codemods/src/delete-jsx-node.ts
deleted file mode 100644
index f6b5b6675b..0000000000
--- a/packages/codemods/src/delete-jsx-node.ts
+++ /dev/null
@@ -1,32 +0,0 @@
-import type {SequenceNodePath} from 'remotion';
-import type {CodemodProject, CodemodResult} from './codemod-project';
-import {getCodemodResult} from './codemod-project';
-import {deleteJsxNode as deleteJsxNodeFromSource} from './delete-jsx-node-internal';
-import {findProjectFile} from './internals';
-
-export type DeleteJsxNodeOptions<Project extends CodemodProject> = {
- project: Project;
- filePath: string;
- nodePath: SequenceNodePath;
-};
-
-export const deleteJsxNode = async <Project extends CodemodProject>({
- project,
- filePath,
- nodePath,
-}: DeleteJsxNodeOptions<Project>): Promise<CodemodResult<Project>> => {
- const resolvedFilePath = findProjectFile({filePath, project});
- const {output} = await deleteJsxNodeFromSource({
- input: project.files[resolvedFilePath],
- nodePath,
- });
- const nextProject = {
- ...project,
- files: {
- ...project.files,
- [resolvedFilePath]: output,
- },
- };
-
- return getCodemodResult({nextProject, project});
-};
diff --git a/packages/codemods/src/delete-jsx-node-internal.ts b/packages/codemods/src/delete-jsx-nodes-internal.ts
similarity index 94%
rename from packages/codemods/src/delete-jsx-node-internal.ts
rename to packages/codemods/src/delete-jsx-nodes-internal.ts
index 498ddec60d..6798ea911d 100644
--- a/packages/codemods/src/delete-jsx-node-internal.ts
+++ b/packages/codemods/src/delete-jsx-nodes-internal.ts
@@ -593,35 +593,3 @@ export const deleteJsxNodes = ({
nodePathRemappings,
});
};
-
-export const deleteJsxNode = async ({
- input,
- nodePath,
-}: {
- input: string;
- nodePath: SequenceNodePath;
- // Kept optional for compatibility with callers from before source edits
- // replaced the full-file formatting pass.
- formatFile?: (input: {
- contents: string;
- prettierConfigOverride: Record<string, unknown> | null;
- }) => Promise<{output: string; formatted: boolean}>;
- prettierConfigOverride?: Record<string, unknown> | null;
-}): Promise<{
- output: string;
- formatted: boolean;
- nodeLabel: string;
- logLine: number;
-}> => {
- const {output, formatted, nodeLabels, logLines} = await deleteJsxNodes({
- input,
- nodePaths: [nodePath],
- });
-
- return {
- output,
- formatted,
- nodeLabel: nodeLabels[0],
- logLine: logLines[0],
- };
-};
diff --git a/packages/codemods/src/delete-jsx-nodes.ts b/packages/codemods/src/delete-jsx-nodes.ts
new file mode 100644
index 0000000000..4f9349b270
--- /dev/null
+++ b/packages/codemods/src/delete-jsx-nodes.ts
@@ -0,0 +1,53 @@
+import type {SequenceNodePath} from 'remotion';
+import type {CodemodProject, CodemodResult} from './codemod-project';
+import {getCodemodResult} from './codemod-project';
+import {deleteJsxNodes as deleteJsxNodesFromSource} from './delete-jsx-nodes-internal';
+import {findProjectFile} from './internals';
+
+export type DeleteJsxNodesOptions<Project extends CodemodProject> = {
+ project: Project;
+ nodes: {filePath: string; nodePath: SequenceNodePath}[];
+};
+
+export const deleteJsxNodes = async <Project extends CodemodProject>({
+ project,
+ nodes,
+}: DeleteJsxNodesOptions<Project>): Promise<CodemodResult<Project>> => {
+ if (nodes.length === 0) {
+ throw new Error('No JSX nodes were specified for deletion');
+ }
+
+ const nodesByFile = new Map<string, SequenceNodePath[]>();
+ for (const node of nodes) {
+ const resolvedFilePath = findProjectFile({
+ filePath: node.filePath,
+ project,
+ });
+ const nodePaths = nodesByFile.get(resolvedFilePath) ?? [];
+ nodePaths.push(node.nodePath);
+ nodesByFile.set(resolvedFilePath, nodePaths);
+ }
+
+ const updates = await Promise.all(
+ [...nodesByFile].map(async ([filePath, nodePaths]) => ({
+ filePath,
+ output: (
+ await deleteJsxNodesFromSource({
+ input: project.files[filePath],
+ nodePaths,
+ })
+ ).output,
+ })),
+ );
+ const nextProject = {
+ ...project,
+ files: {
+ ...project.files,
+ ...Object.fromEntries(
+ updates.map(({filePath, output}) => [filePath, output]),
+ ),
+ },
+ };
+
+ return getCodemodResult({nextProject, project});
+};
diff --git a/packages/codemods/src/duplicate-jsx-node.ts b/packages/codemods/src/duplicate-jsx-node.ts
index 7228de16fe..600b59a558 100644
--- a/packages/codemods/src/duplicate-jsx-node.ts
+++ b/packages/codemods/src/duplicate-jsx-node.ts
@@ -5,7 +5,7 @@ import type {SequenceNodePath} from 'remotion';
import {
findJsxElementPathForDeletion,
getJsxElementTagLabel,
-} from './delete-jsx-node-internal';
+} from './delete-jsx-nodes-internal';
import {
captureJsxNodePaths,
getNodePathRemappings,
diff --git a/packages/codemods/src/folder-source-edits.ts b/packages/codemods/src/folder-source-edits.ts
index 224b5e8527..e0c43dddb0 100644
--- a/packages/codemods/src/folder-source-edits.ts
+++ b/packages/codemods/src/folder-source-edits.ts
@@ -6,7 +6,7 @@ import type {
} from '@babel/types';
import type {CompositionOrFolder, RecastCodemod} from '@remotion/studio-shared';
import * as recast from 'recast';
-import {getNodeSourceEdit} from './delete-jsx-node-internal';
+import {getNodeSourceEdit} from './delete-jsx-nodes-internal';
import {getInsertionRootSourceEdit} from './insert-jsx-element';
import {indentInsertedJsx, printInsertedJsx} from './print-jsx';
import {recastLocToOffset} from './recast-loc-to-offset';
diff --git a/packages/codemods/src/index.ts b/packages/codemods/src/index.ts
index b6f6334bed..50eeeed533 100644
--- a/packages/codemods/src/index.ts
+++ b/packages/codemods/src/index.ts
@@ -12,7 +12,6 @@ import {
deleteEffect,
deleteEffects,
deleteJsxElementAtPath,
- deleteJsxNode as deleteJsxNodeFromSource,
deleteJsxNodes,
duplicateCompositionInSource,
duplicateEffect,
@@ -75,7 +74,7 @@ export type {
CodemodProject,
CodemodResult,
} from './codemod-project';
-export {deleteJsxNode, type DeleteJsxNodeOptions} from './delete-jsx-node';
+export {deleteJsxNodes, type DeleteJsxNodesOptions} from './delete-jsx-nodes';
export type {
EffectArrayElement,
EffectDeletionTarget,
@@ -112,7 +111,6 @@ export const CodemodsInternals = {
deleteEffect,
deleteEffects,
deleteJsxElementAtPath,
- deleteJsxNode: deleteJsxNodeFromSource,
deleteJsxNodes,
duplicateCompositionInSource,
duplicateEffect,
diff --git a/packages/codemods/src/insert-basic-captions.ts b/packages/codemods/src/insert-basic-captions.ts
index d7e26733b1..556b8a539f 100644
--- a/packages/codemods/src/insert-basic-captions.ts
+++ b/packages/codemods/src/insert-basic-captions.ts
@@ -2,7 +2,7 @@ import type {JSXElement, JSXFragment} from '@babel/types';
import type {SequenceNodePathRemapping} from '@remotion/studio-shared';
import * as recast from 'recast';
import type {SequenceNodePath} from 'remotion';
-import {findJsxElementPathForDeletion} from './delete-jsx-node-internal';
+import {findJsxElementPathForDeletion} from './delete-jsx-nodes-internal';
import {
captureJsxNodePaths,
getNodePathRemappings,
diff --git a/packages/codemods/src/internals.ts b/packages/codemods/src/internals.ts
index 7cf2e62be9..9e600f7aab 100644
--- a/packages/codemods/src/internals.ts
+++ b/packages/codemods/src/internals.ts
@@ -16,11 +16,10 @@ import {parseAst} from './sequence-props/parse-ast';
export {applyVisualControl} from './apply-visual-control';
export {
deleteJsxElementAtPath,
- deleteJsxNode,
deleteJsxNodes,
findJsxElementPathForDeletion,
getJsxElementTagLabel,
-} from './delete-jsx-node-internal';
+} from './delete-jsx-nodes-internal';
export {duplicateCompositionInSource} from './duplicate-composition';
export {
duplicateJsxElementAtPath,
diff --git a/packages/codemods/src/recast-mods.ts b/packages/codemods/src/recast-mods.ts
index 040170ab1a..4191c2ae81 100644
--- a/packages/codemods/src/recast-mods.ts
+++ b/packages/codemods/src/recast-mods.ts
@@ -21,7 +21,7 @@ import type {
import type {CompositionOrFolder, RecastCodemod} from '@remotion/studio-shared';
import * as recast from 'recast';
import {applyVisualControl} from './apply-visual-control';
-import {deleteJsxElementAtPath} from './delete-jsx-node-internal';
+import {deleteJsxElementAtPath} from './delete-jsx-nodes-internal';
import {parseAst} from './sequence-props/parse-ast';
import {stripParenthesizedExtra} from './strip-parenthesized-extra';
diff --git a/packages/codemods/src/reorder-sequence.ts b/packages/codemods/src/reorder-sequence.ts
index 298ee3a9e1..0f0a4fa3a7 100644
--- a/packages/codemods/src/reorder-sequence.ts
+++ b/packages/codemods/src/reorder-sequence.ts
@@ -9,7 +9,7 @@ import {
findJsxElementPathForDeletion,
getJsxElementTagLabel,
getNodeSourceEdit,
-} from './delete-jsx-node-internal';
+} from './delete-jsx-nodes-internal';
import {
captureJsxNodePaths,
getNodePathRemappings,
diff --git a/packages/codemods/src/split-jsx-sequence.ts b/packages/codemods/src/split-jsx-sequence.ts
index fe6f6dca44..388360c1ed 100644
--- a/packages/codemods/src/split-jsx-sequence.ts
+++ b/packages/codemods/src/split-jsx-sequence.ts
@@ -21,7 +21,7 @@ import type {SequenceNodePath} from 'remotion';
import {
findJsxElementPathForDeletion,
getJsxElementTagLabel,
-} from './delete-jsx-node-internal';
+} from './delete-jsx-nodes-internal';
import {
captureJsxNodePaths,
getNodePathRemappings,
diff --git a/packages/codemods/src/split-video-from-audio.ts b/packages/codemods/src/split-video-from-audio.ts
index af32ec7ebb..3e6d8edcd7 100644
--- a/packages/codemods/src/split-video-from-audio.ts
+++ b/packages/codemods/src/split-video-from-audio.ts
@@ -14,7 +14,7 @@ import type {SequenceNodePath} from 'remotion';
import {
findJsxElementPathForDeletion,
getJsxElementTagLabel,
-} from './delete-jsx-node-internal';
+} from './delete-jsx-nodes-internal';
import {
captureJsxNodePaths,
getNodePathRemappings,
diff --git a/packages/codemods/src/test/public-api.test.ts b/packages/codemods/src/test/public-api.test.ts
index cf2e3a3533..763cf2300c 100644
--- a/packages/codemods/src/test/public-api.test.ts
+++ b/packages/codemods/src/test/public-api.test.ts
@@ -1,5 +1,5 @@
import {expect, test} from 'bun:test';
-import {addSolid, deleteJsxNode} from '../index';
+import {addSolid, deleteJsxNodes} from '../index';
const makeProject = () => ({
entryPoint: 'src/index.ts',
@@ -15,6 +15,13 @@ export const Root = () => <Composition id="Demo" component={Video} width={1280}
`,
'src/Video.tsx': `import {AbsoluteFill} from 'remotion';
export const Video = () => <AbsoluteFill>Existing</AbsoluteFill>;
+`,
+ 'src/Root2.tsx': `import {Composition} from 'remotion';
+import {Video2} from './Video2';
+export const Root2 = () => <Composition id="Demo2" component={Video2} width={1280} height={720} fps={30} durationInFrames={90} />;
+`,
+ 'src/Video2.tsx': `import {AbsoluteFill} from 'remotion';
+export const Video2 = () => <AbsoluteFill>Existing</AbsoluteFill>;
`,
},
});
@@ -46,7 +53,36 @@ test('addSolid() immutably updates a virtual project', () => {
]);
});
-test('deleteJsxNode() deletes the Sequence wrapper identified by a node path', async () => {
+test('deleteJsxNodes() deletes nodes from multiple files', async () => {
+ const project = makeProject();
+ const first = addSolid({
+ compositionFile: 'src/Root.tsx',
+ compositionId: 'Demo',
+ height: 720,
+ project,
+ width: 1280,
+ });
+ const second = addSolid({
+ compositionFile: 'src/Root2.tsx',
+ compositionId: 'Demo2',
+ height: 720,
+ project: first.project,
+ width: 1280,
+ });
+ const result = await deleteJsxNodes({
+ nodes: [first.insertedNode, second.insertedNode],
+ project: second.project,
+ });
+
+ expect(result.project.files['src/Video.tsx']).not.toContain('<Solid');
+ expect(result.project.files['src/Video2.tsx']).not.toContain('<Solid');
+ expect(result.changes.map((change) => change.filePath)).toEqual([
+ 'src/Video.tsx',
+ 'src/Video2.tsx',
+ ]);
+});
+
+test('deleteJsxNodes() deletes the Sequence wrapper identified by a node path', async () => {
const project = makeProject();
const added = addSolid({
compositionFile: 'src/Root.tsx',
@@ -58,9 +94,13 @@ test('deleteJsxNode() deletes the Sequence wrapper identified by a node path', a
});
const sourceWithSolid = added.project.files['src/Video.tsx'];
expect(sourceWithSolid).toContain('<Sequence from={10}');
- const result = await deleteJsxNode({
- filePath: `/${added.insertedNode.filePath}`,
- nodePath: added.insertedNode.nodePath,
+ const result = await deleteJsxNodes({
+ nodes: [
+ {
+ filePath: `/${added.insertedNode.filePath}`,
+ nodePath: added.insertedNode.nodePath,
+ },
+ ],
project: added.project,
});
diff --git a/packages/docs/docs/codemods/add-solid.mdx b/packages/docs/docs/codemods/add-solid.mdx
index 89b55bd142..527da91168 100644
--- a/packages/docs/docs/codemods/add-solid.mdx
+++ b/packages/docs/docs/codemods/add-solid.mdx
@@ -80,7 +80,7 @@ An array describing each changed file with its `filePath`, `previousContents`, a
### insertedNode
-The `filePath` and `nodePath` of the inserted JSX element. Pass these values to [`deleteJsxNode()`](/docs/codemods/delete-jsx-node) to remove the element again.
+The `filePath` and `nodePath` of the inserted JSX element. Pass these values as an item in `nodes` to [`deleteJsxNodes()`](/docs/codemods/delete-jsx-nodes) to remove the element again.
## Compatibility
@@ -90,5 +90,5 @@ The `filePath` and `nodePath` of the inserted JSX element. Pass these values to
- [Source code for this function](https://github.com/remotion-dev/remotion/blob/main/packages/codemods/src/add-solid.ts)
- [`<Solid>`](/docs/solid)
-- [`deleteJsxNode()`](/docs/codemods/delete-jsx-node)
+- [`deleteJsxNodes()`](/docs/codemods/delete-jsx-nodes)
- [`@remotion/browser-bundler`](/docs/browser-bundler)
diff --git a/packages/docs/docs/codemods/delete-jsx-node.mdx b/packages/docs/docs/codemods/delete-jsx-nodes.mdx
similarity index 68%
rename from packages/docs/docs/codemods/delete-jsx-node.mdx
rename to packages/docs/docs/codemods/delete-jsx-nodes.mdx
index 510c437773..30b867398a 100644
--- a/packages/docs/docs/codemods/delete-jsx-node.mdx
+++ b/packages/docs/docs/codemods/delete-jsx-nodes.mdx
@@ -1,14 +1,12 @@
---
-image: /generated/articles-docs-codemods-delete-jsx-node.png
-title: 'deleteJsxNode()'
+image: /generated/articles-docs-codemods-delete-jsx-nodes.png
+title: 'deleteJsxNodes()'
crumb: '@remotion/codemods'
---
-# deleteJsxNode()<AvailableFrom v="4.0.527" />
+# deleteJsxNodes()<AvailableFrom v="4.0.527" />
-Deletes the JSX element identified by a mounted layer's node path.
-
-The API uses the same source-editing routine as Remotion Studio. It works with any JSX layer, including [`<Sequence>`](/docs/sequence) and [`<Solid>`](/docs/solid).
+Deletes one or more JSX elements identified by mounted layer node paths. It works with any JSX layer, including [`<Sequence>`](/docs/sequence) and [`<Solid>`](/docs/solid).
:::warning
@@ -16,17 +14,16 @@ _Draft API_: This API is not yet stable. We are in the experimental phase of thi
:::
-```ts twoslash title="delete-jsx-node.ts"
-import {deleteJsxNode, type CodemodProject} from '@remotion/codemods';
+```ts twoslash title="delete-jsx-nodes.ts"
+import {deleteJsxNodes, type CodemodProject} from '@remotion/codemods';
import type {SequenceNodePath} from 'remotion';
declare const project: CodemodProject;
declare const nodePath: SequenceNodePath;
-const result = await deleteJsxNode({
+const result = await deleteJsxNodes({
project,
- filePath: 'src/Video.tsx',
- nodePath,
+ nodes: [{filePath: 'src/Video.tsx', nodePath}],
});
console.log(result.project.files);
@@ -43,11 +40,15 @@ Pass an object with the following properties.
An in-memory Remotion project containing `rootDir` and a `files` record.
-### filePath
+### nodes
+
+The JSX elements to delete. Nodes may belong to different project files.
+
+#### filePath
The source file containing the JSX element. Absolute paths emitted by a mounted layer and project-relative paths are both accepted.
-### nodePath
+#### nodePath
The `SequenceNodePath` identifying the JSX element to delete. Canvas layers expose it as `nodePathInfo.sequenceSubscriptionKey.nodePath`.
@@ -69,7 +70,7 @@ An array describing each changed file with its `filePath`, `previousContents`, a
## See also
-- [Source code for this function](https://github.com/remotion-dev/remotion/blob/main/packages/codemods/src/delete-jsx-node.ts)
+- [Source code for this function](https://github.com/remotion-dev/remotion/blob/main/packages/codemods/src/delete-jsx-nodes.ts)
- [`addSolid()`](/docs/codemods/add-solid)
- [`<Sequence>`](/docs/sequence)
- [`@remotion/canvas`](/docs/canvas)
diff --git a/packages/docs/docs/codemods/table-of-contents.tsx b/packages/docs/docs/codemods/table-of-contents.tsx
index 4c52f7c957..c0ecb6320e 100644
--- a/packages/docs/docs/codemods/table-of-contents.tsx
+++ b/packages/docs/docs/codemods/table-of-contents.tsx
@@ -9,9 +9,9 @@ export const TableOfContents: React.FC = () => {
<strong>addSolid()</strong>
<div>Add a Solid to a composition source file</div>
</TOCItem>
- <TOCItem link="/docs/codemods/delete-jsx-node">
- <strong>deleteJsxNode()</strong>
- <div>Delete a mounted JSX layer from its source file</div>
+ <TOCItem link="/docs/codemods/delete-jsx-nodes">
+ <strong>deleteJsxNodes()</strong>
+ <div>Delete mounted JSX layers from their source files</div>
</TOCItem>
</Grid>
);
diff --git a/packages/docs/sidebars.ts b/packages/docs/sidebars.ts
index 650ef93421..ea78a30ab0 100644
--- a/packages/docs/sidebars.ts
+++ b/packages/docs/sidebars.ts
@@ -2039,7 +2039,7 @@ const sidebars: SidebarsConfig = {
type: 'doc',
id: 'codemods/index',
},
- items: ['codemods/add-solid', 'codemods/delete-jsx-node'],
+ items: ['codemods/add-solid', 'codemods/delete-jsx-nodes'],
},
],
};
diff --git a/packages/docs/src/data/articles.ts b/packages/docs/src/data/articles.ts
index 1b29406f5c..9745f09866 100644
--- a/packages/docs/src/data/articles.ts
+++ b/packages/docs/src/data/articles.ts
@@ -1414,13 +1414,13 @@ export const articles = [
slug: 'codemods/add-solid',
},
{
- id: 'codemods/delete-jsx-node',
- title: 'deleteJsxNode()',
- relativePath: 'docs/codemods/delete-jsx-node.mdx',
- compId: 'articles-docs-codemods-delete-jsx-node',
+ id: 'codemods/delete-jsx-nodes',
+ title: 'deleteJsxNodes()',
+ relativePath: 'docs/codemods/delete-jsx-nodes.mdx',
+ compId: 'articles-docs-codemods-delete-jsx-nodes',
crumb: '@remotion/codemods',
noAi: false,
- slug: 'codemods/delete-jsx-node',
+ slug: 'codemods/delete-jsx-nodes',
},
{
id: 'codemods/index',
diff --git a/packages/docs/static/generated/articles-docs-codemods-delete-jsx-node.png b/packages/docs/static/generated/articles-docs-codemods-delete-jsx-node.png
deleted file mode 100644
index 98f8ae3f43..0000000000
Binary files a/packages/docs/static/generated/articles-docs-codemods-delete-jsx-node.png and /dev/null differ
diff --git a/packages/docs/static/generated/articles-docs-codemods-delete-jsx-nodes.png b/packages/docs/static/generated/articles-docs-codemods-delete-jsx-nodes.png
new file mode 100644
index 0000000000..c3287204b3
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-codemods-delete-jsx-nodes.png differ
diff --git a/packages/player-example/src/BrowserBundlerExample.tsx b/packages/player-example/src/BrowserBundlerExample.tsx
index 5dd0674ebd..a8fefefda2 100644
--- a/packages/player-example/src/BrowserBundlerExample.tsx
+++ b/packages/player-example/src/BrowserBundlerExample.tsx
@@ -3,7 +3,7 @@ import {
createBrowserBundler,
type VirtualProject,
} from '@remotion/browser-bundler';
-import {addSolid, deleteJsxNode} from '@remotion/codemods';
+import {addSolid, deleteJsxNodes} from '@remotion/codemods';
import Link from 'next/link';
import React, {useCallback, useEffect, useRef, useState} from 'react';
import type {SequenceNodePath} from 'remotion';
@@ -409,9 +409,13 @@ export const BrowserBundlerExample: React.FC = () => {
}
setState({type: 'loading'});
- void deleteJsxNode({
- filePath: insertedSolid.filePath,
- nodePath: insertedSolid.nodePath,
+ void deleteJsxNodes({
+ nodes: [
+ {
+ filePath: insertedSolid.filePath,
+ nodePath: insertedSolid.nodePath,
+ },
+ ],
project: {
...project,
files: {...project.files, 'src/Video.tsx': source},
diff --git a/packages/studio-server/src/codemods/delete-jsx-node.ts b/packages/studio-server/src/codemods/delete-jsx-nodes.ts
similarity index 72%
rename from packages/studio-server/src/codemods/delete-jsx-node.ts
rename to packages/studio-server/src/codemods/delete-jsx-nodes.ts
index 5a5ddc0549..a7cc0dc142 100644
--- a/packages/studio-server/src/codemods/delete-jsx-node.ts
+++ b/packages/studio-server/src/codemods/delete-jsx-nodes.ts
@@ -3,7 +3,6 @@ import type {SequenceNodePath} from 'remotion';
const {
deleteJsxElementAtPath,
- deleteJsxNode: deleteJsxNodeCodemod,
deleteJsxNodes: deleteJsxNodesCodemod,
findJsxElementPathForDeletion,
getJsxElementTagLabel,
@@ -26,15 +25,3 @@ export const deleteJsxNodes = ({
input,
nodePaths,
});
-
-export const deleteJsxNode = ({
- input,
- nodePath,
-}: {
- input: string;
- nodePath: SequenceNodePath;
-}) =>
- deleteJsxNodeCodemod({
- input,
- nodePath,
- });
diff --git a/packages/studio-server/src/preview-server/api-routes.ts b/packages/studio-server/src/preview-server/api-routes.ts
index 5ecb29f436..51c708df59 100644
--- a/packages/studio-server/src/preview-server/api-routes.ts
+++ b/packages/studio-server/src/preview-server/api-routes.ts
@@ -18,7 +18,7 @@ import {
} from './routes/default-coding-agent';
import {getDefaultEditorInfoHandler} from './routes/default-editor';
import {deleteEffectHandler} from './routes/delete-effect';
-import {deleteJsxNodeHandler} from './routes/delete-jsx-node';
+import {deleteJsxNodesHandler} from './routes/delete-jsx-nodes';
import {deleteKeyframesHandler} from './routes/delete-keyframes';
import {deleteStaticFileHandler} from './routes/delete-static-file';
import {downloadRemoteAssetHandler} from './routes/download-remote-asset';
@@ -125,7 +125,7 @@ export const allApiRoutes: {
'/api/batch-update-keyframe-settings': batchUpdateKeyframeSettingsHandler,
'/api/delete-effect': deleteEffectHandler,
'/api/paste-effects': pasteEffectsHandler,
- '/api/delete-jsx-node': deleteJsxNodeHandler,
+ '/api/delete-jsx-nodes': deleteJsxNodesHandler,
'/api/duplicate-jsx-node': duplicateJsxNodeHandler,
'/api/split-jsx-sequence': splitJsxSequenceHandler,
'/api/split-video-from-audio': splitVideoFromAudioHandler,
diff --git a/packages/studio-server/src/preview-server/routes/delete-jsx-node.ts b/packages/studio-server/src/preview-server/routes/delete-jsx-nodes.ts
similarity index 89%
rename from packages/studio-server/src/preview-server/routes/delete-jsx-node.ts
rename to packages/studio-server/src/preview-server/routes/delete-jsx-nodes.ts
index 332dd68008..074112c4fb 100644
--- a/packages/studio-server/src/preview-server/routes/delete-jsx-node.ts
+++ b/packages/studio-server/src/preview-server/routes/delete-jsx-nodes.ts
@@ -1,10 +1,10 @@
import {readFileSync} from 'node:fs';
import {RenderInternals} from '@remotion/renderer';
import type {
- DeleteJsxNodeRequest,
- DeleteJsxNodeResponse,
+ DeleteJsxNodesRequest,
+ DeleteJsxNodesResponse,
} from '@remotion/studio-shared';
-import {deleteJsxNodes} from '../../codemods/delete-jsx-node';
+import {deleteJsxNodes} from '../../codemods/delete-jsx-nodes';
import {writeFileAndNotifyFileWatchers} from '../../file-watcher';
import {resolveFileInsideProject} from '../../helpers/resolve-file-inside-project';
import type {ApiHandler} from '../api-types';
@@ -29,16 +29,16 @@ const getDeletedNodeDescription = (nodeLabels: string[]): string => {
return `${nodeLabels.length} JSX nodes`;
};
-export const deleteJsxNodeHandler: ApiHandler<
- DeleteJsxNodeRequest,
- DeleteJsxNodeResponse
+export const deleteJsxNodesHandler: ApiHandler<
+ DeleteJsxNodesRequest,
+ DeleteJsxNodesResponse
> = ({input: {nodes}, remotionRoot, logLevel}) => {
return withSourceFileWriteQueue(async () => {
try {
logHmrTiming({
detail: null,
logLevel,
- stage: 'delete-jsx-node-request-start',
+ stage: 'delete-jsx-nodes-request-start',
});
if (nodes.length === 0) {
@@ -47,7 +47,7 @@ export const deleteJsxNodeHandler: ApiHandler<
RenderInternals.Log.trace(
{indent: false, logLevel},
- `[delete-jsx-node] Received request to delete ${nodes.length} JSX node${nodes.length === 1 ? '' : 's'}`,
+ `[delete-jsx-nodes] Received request to delete ${nodes.length} JSX node${nodes.length === 1 ? '' : 's'}`,
);
const itemsByFileName = new Map<string, typeof nodes>();
@@ -87,7 +87,7 @@ export const deleteJsxNodeHandler: ApiHandler<
logHmrTiming({
detail: `files=${updates.length}`,
logLevel,
- stage: 'delete-jsx-node-codemod-complete',
+ stage: 'delete-jsx-nodes-codemod-complete',
});
const nodePathMutation = broadcastSequenceNodePathMutation(
updates.map((update) => ({
@@ -113,7 +113,7 @@ export const deleteJsxNodeHandler: ApiHandler<
undoMessage: `↩️ Deletion of ${deletedNodeDescription}`,
redoMessage: `↪️ Deletion of ${deletedNodeDescription}`,
},
- entryType: 'delete-jsx-node',
+ entryType: 'delete-jsx-nodes',
suppressHmrOnFileRestore: false,
nodePathRemappings: update.nodePathRemappings,
});
@@ -146,7 +146,7 @@ export const deleteJsxNodeHandler: ApiHandler<
);
RenderInternals.Log.verbose(
{indent: false, logLevel},
- `[delete-jsx-node] Wrote ${update.fileRelativeToRoot}`,
+ `[delete-jsx-nodes] Wrote ${update.fileRelativeToRoot}`,
);
}
diff --git a/packages/studio-server/src/preview-server/undo-stack.ts b/packages/studio-server/src/preview-server/undo-stack.ts
index dc73309521..779e574867 100644
--- a/packages/studio-server/src/preview-server/undo-stack.ts
+++ b/packages/studio-server/src/preview-server/undo-stack.ts
@@ -38,7 +38,7 @@ type UndoEntryType =
| 'paste-effects'
| 'reorder-effect'
| 'reorder-sequence'
- | 'delete-jsx-node'
+ | 'delete-jsx-nodes'
| 'duplicate-jsx-node'
| 'split-jsx-sequence'
| 'split-video-from-audio'
diff --git a/packages/studio-server/src/test/delete-jsx-node.test.ts b/packages/studio-server/src/test/delete-jsx-nodes.test.ts
similarity index 91%
rename from packages/studio-server/src/test/delete-jsx-node.test.ts
rename to packages/studio-server/src/test/delete-jsx-nodes.test.ts
index 6aadc044fe..5f2261a354 100644
--- a/packages/studio-server/src/test/delete-jsx-node.test.ts
+++ b/packages/studio-server/src/test/delete-jsx-nodes.test.ts
@@ -6,13 +6,13 @@ import type {
EventSourceEvent,
SubscribeToSequencePropsRequest,
} from '@remotion/studio-shared';
-import {deleteJsxNode, deleteJsxNodes} from '../codemods/delete-jsx-node';
+import {deleteJsxNodes} from '../codemods/delete-jsx-nodes';
import {
createFileWatcherRegistry,
setFileWatcherRegistry,
} from '../file-watcher';
import {setLiveEventsListener} from '../preview-server/live-events';
-import {deleteJsxNodeHandler} from '../preview-server/routes/delete-jsx-node';
+import {deleteJsxNodesHandler} from '../preview-server/routes/delete-jsx-nodes';
import {subscribeToSequenceProps} from '../preview-server/routes/subscribe-to-sequence-props';
import {unsubscribeClientSequencePropsWatchers} from '../preview-server/sequence-props-watchers';
import {
@@ -34,10 +34,10 @@ export const X: React.FC = () => {
};
`;
-test('deleteJsxNode removes a JSX child from a parent element', async () => {
- const {output} = await deleteJsxNode({
+test('deleteJsxNodes removes a JSX child from a parent element', async () => {
+ const {output} = await deleteJsxNodes({
input: sample,
- nodePath: lineColumnToNodePath(sample, 7),
+ nodePaths: [lineColumnToNodePath(sample, 7)],
});
expect(output).not.toContain('<div');
@@ -51,10 +51,10 @@ export const X: React.FC = () => {
};
`;
-test('deleteJsxNode replaces sole return JSX with null', async () => {
- const {output} = await deleteJsxNode({
+test('deleteJsxNodes replaces sole return JSX with null', async () => {
+ const {output} = await deleteJsxNodes({
input: onlyReturn,
- nodePath: lineColumnToNodePath(onlyReturn, 4),
+ nodePaths: [lineColumnToNodePath(onlyReturn, 4)],
});
expect(output).toContain('return null');
@@ -68,10 +68,10 @@ export const X: React.FC<{show: boolean}> = ({show}) => {
};
`;
-test('deleteJsxNode turns conditional JSX into null', async () => {
- const {output} = await deleteJsxNode({
+test('deleteJsxNodes turns conditional JSX into null', async () => {
+ const {output} = await deleteJsxNodes({
input: conditional,
- nodePath: lineColumnToNodePath(conditional, 4),
+ nodePaths: [lineColumnToNodePath(conditional, 4)],
});
expect(output).toContain('&& null');
@@ -85,10 +85,10 @@ export const X: React.FC<{show: boolean}> = ({show}) => {
};
`;
-test('deleteJsxNode replaces JSX in ternary consequent with null', async () => {
- const {output} = await deleteJsxNode({
+test('deleteJsxNodes replaces JSX in ternary consequent with null', async () => {
+ const {output} = await deleteJsxNodes({
input: ternary,
- nodePath: lineColumnToNodePath(ternary, 4),
+ nodePaths: [lineColumnToNodePath(ternary, 4)],
});
expect(output).toMatch(/\?\s*null/);
@@ -108,10 +108,10 @@ export const X: React.FC = () => {
};
`;
-test('deleteJsxNode replaces JSX inside map callback', async () => {
- const {output} = await deleteJsxNode({
+test('deleteJsxNodes replaces JSX inside map callback', async () => {
+ const {output} = await deleteJsxNodes({
input: mapCase,
- nodePath: lineColumnToNodePath(mapCase, 7),
+ nodePaths: [lineColumnToNodePath(mapCase, 7)],
});
expect(output).not.toContain('<div');
@@ -406,7 +406,7 @@ test('deleting a JSX node broadcasts node path mutations for all clients', async
expect(subscription.success).toBe(true);
expect(subscription.results.every((result) => result.success)).toBe(true);
- const response = await deleteJsxNodeHandler({
+ const response = await deleteJsxNodesHandler({
...apiHandlerContext,
input: {
nodes: [
diff --git a/packages/studio-shared/src/api-requests.ts b/packages/studio-shared/src/api-requests.ts
index 356362ec26..923dc74732 100644
--- a/packages/studio-shared/src/api-requests.ts
+++ b/packages/studio-shared/src/api-requests.ts
@@ -844,16 +844,16 @@ export type PasteEffectsResponse =
stack: string;
};
-export type DeleteJsxNodeRequestItem = {
+export type DeleteJsxNodesRequestItem = {
fileName: string;
nodePath: SequenceNodePath;
};
-export type DeleteJsxNodeRequest = {
- nodes: DeleteJsxNodeRequestItem[];
+export type DeleteJsxNodesRequest = {
+ nodes: DeleteJsxNodesRequestItem[];
};
-export type DeleteJsxNodeResponse =
+export type DeleteJsxNodesResponse =
| {
success: true;
nodePathMutation: SequenceNodePathMutation;
@@ -1418,9 +1418,9 @@ export type ApiRoutes = {
>;
'/api/delete-effect': ReqAndRes<DeleteEffectRequest, DeleteEffectResponse>;
'/api/paste-effects': ReqAndRes<PasteEffectsRequest, PasteEffectsResponse>;
- '/api/delete-jsx-node': ReqAndRes<
- DeleteJsxNodeRequest,
- DeleteJsxNodeResponse
+ '/api/delete-jsx-nodes': ReqAndRes<
+ DeleteJsxNodesRequest,
+ DeleteJsxNodesResponse
>;
'/api/duplicate-jsx-node': ReqAndRes<
DuplicateJsxNodeRequest,
diff --git a/packages/studio-shared/src/browser-studio-operations.ts b/packages/studio-shared/src/browser-studio-operations.ts
index 6ef1759824..0861361efb 100644
--- a/packages/studio-shared/src/browser-studio-operations.ts
+++ b/packages/studio-shared/src/browser-studio-operations.ts
@@ -13,8 +13,8 @@ import type {
BatchUpdateKeyframeSettingsResponse,
CompositionComponentInfoRequest,
CompositionComponentInfoResponse,
- DeleteJsxNodeRequest,
- DeleteJsxNodeResponse,
+ DeleteJsxNodesRequest,
+ DeleteJsxNodesResponse,
DeleteKeyframesRequest,
DeleteKeyframesResponse,
DeleteEffectRequest,
@@ -168,9 +168,9 @@ export type BrowserStudioOperations = {
sourceOrigin: string | null;
} | null;
applyCodemod: (request: ApplyCodemodRequest) => Promise<ApplyCodemodResponse>;
- deleteJsxNode: (
- request: DeleteJsxNodeRequest,
- ) => Promise<DeleteJsxNodeResponse>;
+ deleteJsxNodes: (
+ request: DeleteJsxNodesRequest,
+ ) => Promise<DeleteJsxNodesResponse>;
deleteStaticFile: (
request: DeleteStaticFileRequest,
) => Promise<DeleteStaticFileResponse>;
diff --git a/packages/studio-shared/src/index.ts b/packages/studio-shared/src/index.ts
index 2fbdbd0659..c72a043522 100644
--- a/packages/studio-shared/src/index.ts
+++ b/packages/studio-shared/src/index.ts
@@ -37,9 +37,9 @@ export {
DeleteEffectRequest,
DeleteEffectRequestItem,
DeleteEffectResponse,
- DeleteJsxNodeRequest,
- DeleteJsxNodeRequestItem,
- DeleteJsxNodeResponse,
+ DeleteJsxNodesRequest,
+ DeleteJsxNodesRequestItem,
+ DeleteJsxNodesResponse,
DeleteKeyframesRequest,
DeleteKeyframesResponse,
DeleteSequenceKeyframe,
diff --git a/packages/studio/src/components/Timeline/delete-selected-timeline-item.ts b/packages/studio/src/components/Timeline/delete-selected-timeline-item.ts
index 42fb7b59f1..951442063d 100644
--- a/packages/studio/src/components/Timeline/delete-selected-timeline-item.ts
+++ b/packages/studio/src/components/Timeline/delete-selected-timeline-item.ts
@@ -3,7 +3,7 @@ import {Internals} from 'remotion';
import {canUseEffectOperations} from '../../helpers/browser-studio-operations';
import type {SequenceNodePathInfo} from '../../helpers/get-timeline-sequence-sort-key';
import type {ConfirmationDialogFunction} from '../ConfirmationDialog-types';
-import {deleteJsxNode} from '../delete-jsx-node-api';
+import {deleteJsxNodes} from '../delete-jsx-nodes-api';
import {deleteEffects as deleteEffectsApi} from '../effect-operations-api';
import {showNotification} from '../Notifications/NotificationCenter';
import {deleteSelectedKeyframes} from './delete-selected-keyframe';
@@ -58,7 +58,7 @@ export const deleteSequencesFromSource = async (
return false;
}
- return deleteJsxNode({
+ return deleteJsxNodes({
nodes: nodePathInfos.map((nodePathInfo) => {
const nodePath = nodePathInfo.sequenceSubscriptionKey;
diff --git a/packages/studio/src/components/delete-jsx-node-api.ts b/packages/studio/src/components/delete-jsx-nodes-api.ts
similarity index 51%
rename from packages/studio/src/components/delete-jsx-node-api.ts
rename to packages/studio/src/components/delete-jsx-nodes-api.ts
index bf874eae03..f51bfcab80 100644
--- a/packages/studio/src/components/delete-jsx-node-api.ts
+++ b/packages/studio/src/components/delete-jsx-nodes-api.ts
@@ -1,15 +1,15 @@
import type {
- DeleteJsxNodeRequest,
- DeleteJsxNodeResponse,
+ DeleteJsxNodesRequest,
+ DeleteJsxNodesResponse,
} from '@remotion/studio-shared';
import {getBrowserStudioOperations} from '../helpers/browser-studio-operations';
import {callApi} from './call-api';
-export const deleteJsxNode = (
- request: DeleteJsxNodeRequest,
-): Promise<DeleteJsxNodeResponse> => {
+export const deleteJsxNodes = (
+ request: DeleteJsxNodesRequest,
+): Promise<DeleteJsxNodesResponse> => {
const browserStudioOperations = getBrowserStudioOperations();
return browserStudioOperations
- ? browserStudioOperations.deleteJsxNode(request)
- : callApi('/api/delete-jsx-node', request);
+ ? browserStudioOperations.deleteJsxNodes(request)
+ : callApi('/api/delete-jsx-nodes', request);
};
diff --git a/packages/studio/src/test/make-browser-studio-operations.ts b/packages/studio/src/test/make-browser-studio-operations.ts
index 16af2c2bd1..f3b81af641 100644
--- a/packages/studio/src/test/make-browser-studio-operations.ts
+++ b/packages/studio/src/test/make-browser-studio-operations.ts
@@ -10,7 +10,7 @@ export const makeBrowserStudioOperations = (
return {
applyCodemod: () => unusedOperation('applyCodemod'),
consumeInitialElement: () => null,
- deleteJsxNode: () => unusedOperation('deleteJsxNode'),
+ deleteJsxNodes: () => unusedOperation('deleteJsxNodes'),
deleteStaticFile: () => unusedOperation('deleteStaticFile'),
downloadRemoteAsset: () => unusedOperation('downloadRemoteAsset'),
downloadProject: () => unusedOperation('downloadProject'),