Skip to content

🎥 Make videos programmatically with React

`@remotion/studio-codemods`: Move Recast composition codemods from `@remotion/studio-server` (#10591)

Jonny Burgerbb663e816c84
diff --git a/packages/studio-server/src/codemods/apply-visual-control.ts b/packages/studio-codemods/src/apply-visual-control.ts
similarity index 97%
rename from packages/studio-server/src/codemods/apply-visual-control.ts
rename to packages/studio-codemods/src/apply-visual-control.ts
index 4e35b6fc20..7df00a8e6d 100644
--- a/packages/studio-server/src/codemods/apply-visual-control.ts
+++ b/packages/studio-codemods/src/apply-visual-control.ts
@@ -9,8 +9,8 @@ import {
} from '@remotion/studio-shared';
import type {ExpressionKind} from 'ast-types/lib/gen/kinds';
import * as recast from 'recast';
-import {parseAst} from './parse-ast';
import type {ApplyCodeModReturnType, Change} from './recast-mods';
+import {parseAst} from './sequence-props/parse-ast';
const expectString = (
node: ExpressionKind | recast.types.namedTypes.SpreadElement,
diff --git a/packages/studio-codemods/src/index.ts b/packages/studio-codemods/src/index.ts
index fef6435669..1fc2a529d7 100644
--- a/packages/studio-codemods/src/index.ts
+++ b/packages/studio-codemods/src/index.ts
@@ -11,6 +11,7 @@ import type {SequenceNodePath} from 'remotion';
import {getNodePathForRecastPath} from './sequence-props';
import {parseAst} from './sequence-props/parse-ast';
+export {applyVisualControl} from './apply-visual-control';
export {
deleteJsxElementAtPath,
deleteJsxNode,
@@ -20,6 +21,12 @@ export {
} from './delete-jsx-node';
export {duplicateCompositionInSource} from './duplicate-composition';
export {findSearchPosition} from './find-search-position';
+export {parseAndApplyCodemod} from './parse-and-apply-codemod';
+export {
+ applyCodemod,
+ type ApplyCodeModReturnType,
+ type Change,
+} from './recast-mods';
export {
insertJsxElementIntoComposition,
insertJsxElementIntoProjectWithNodePathRemappings,
diff --git a/packages/studio-codemods/src/parse-and-apply-codemod.ts b/packages/studio-codemods/src/parse-and-apply-codemod.ts
new file mode 100644
index 0000000000..5b10bcc47a
--- /dev/null
+++ b/packages/studio-codemods/src/parse-and-apply-codemod.ts
@@ -0,0 +1,62 @@
+import type {RecastCodemod} from '@remotion/studio-shared';
+import {duplicateCompositionInSource} from './duplicate-composition';
+import type {Change} from './recast-mods';
+import {applyCodemod} from './recast-mods';
+import {ensureNamedImport} from './sequence-props/imports';
+import {parseAst, serializeAst} from './sequence-props/parse-ast';
+
+export const parseAndApplyCodemod = ({
+ input,
+ codeMod,
+}: {
+ input: string;
+ codeMod: RecastCodemod;
+}): {newContents: string; changesMade: Change[]} => {
+ if (codeMod.type === 'duplicate-composition') {
+ return duplicateCompositionInSource({input, codemod: codeMod});
+ }
+
+ const ast = parseAst(input);
+
+ const {newAst, changesMade} = applyCodemod({
+ file: ast,
+ codeMod,
+ });
+
+ if (changesMade.length === 0) {
+ throw new Error(
+ 'Unable to calculate the changes needed for this file. Edit the file manually.',
+ );
+ }
+
+ if (codeMod.type === 'new-composition') {
+ if (codeMod.canvasCapture === null) {
+ ensureNamedImport({
+ ast: newAst,
+ importedName: 'Composition',
+ sourcePath: 'remotion',
+ localName: 'Composition',
+ });
+ }
+
+ ensureNamedImport({
+ ast: newAst,
+ importedName: codeMod.componentName,
+ sourcePath: codeMod.componentImportPath,
+ localName: codeMod.componentName,
+ });
+ }
+
+ if (codeMod.type === 'new-folder') {
+ ensureNamedImport({
+ ast: newAst,
+ importedName: 'Folder',
+ sourcePath: 'remotion',
+ localName: 'Folder',
+ });
+ }
+
+ const output = serializeAst(newAst);
+
+ return {changesMade, newContents: output};
+};
diff --git a/packages/studio-server/src/codemods/recast-mods.ts b/packages/studio-codemods/src/recast-mods.ts
similarity index 99%
rename from packages/studio-server/src/codemods/recast-mods.ts
rename to packages/studio-codemods/src/recast-mods.ts
index 12fe4ca7b3..f5bedadaed 100644
--- a/packages/studio-server/src/codemods/recast-mods.ts
+++ b/packages/studio-codemods/src/recast-mods.ts
@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-use-before-define */
import type {
ArrowFunctionExpression,
BlockStatement,
diff --git a/packages/studio-server/src/codemods/duplicate-composition.ts b/packages/studio-server/src/codemods/duplicate-composition.ts
index 7e257d4a51..981ca04883 100644
--- a/packages/studio-server/src/codemods/duplicate-composition.ts
+++ b/packages/studio-server/src/codemods/duplicate-composition.ts
@@ -1,9 +1,4 @@
-import {duplicateCompositionInSource} from '@remotion/studio-codemods';
-import type {RecastCodemod} from '@remotion/studio-shared';
-import {ensureNamedImport} from '../helpers/imports';
-import {parseAst, serializeAst} from './parse-ast';
-import type {Change} from './recast-mods';
-import {applyCodemod} from './recast-mods';
+export {parseAndApplyCodemod} from '@remotion/studio-codemods';
const getPrettier = async () => {
try {
@@ -39,59 +34,3 @@ export const formatOutput = async (tsContent: string) => {
return newContents;
};
-
-export const parseAndApplyCodemod = ({
- input,
- codeMod,
-}: {
- input: string;
- codeMod: RecastCodemod;
-}): {newContents: string; changesMade: Change[]} => {
- if (codeMod.type === 'duplicate-composition') {
- return duplicateCompositionInSource({input, codemod: codeMod});
- }
-
- const ast = parseAst(input);
-
- const {newAst, changesMade} = applyCodemod({
- file: ast,
- codeMod,
- });
-
- if (changesMade.length === 0) {
- throw new Error(
- 'Unable to calculate the changes needed for this file. Edit the file manually.',
- );
- }
-
- if (codeMod.type === 'new-composition') {
- if (codeMod.canvasCapture === null) {
- ensureNamedImport({
- ast: newAst,
- importedName: 'Composition',
- sourcePath: 'remotion',
- localName: 'Composition',
- });
- }
-
- ensureNamedImport({
- ast: newAst,
- importedName: codeMod.componentName,
- sourcePath: codeMod.componentImportPath,
- localName: codeMod.componentName,
- });
- }
-
- if (codeMod.type === 'new-folder') {
- ensureNamedImport({
- ast: newAst,
- importedName: 'Folder',
- sourcePath: 'remotion',
- localName: 'Folder',
- });
- }
-
- const output = serializeAst(newAst);
-
- return {changesMade, newContents: output};
-};
diff --git a/packages/studio-server/src/preview-server/routes/apply-visual-control-change.ts b/packages/studio-server/src/preview-server/routes/apply-visual-control-change.ts
index ca599c38b4..7f8168205a 100644
--- a/packages/studio-server/src/preview-server/routes/apply-visual-control-change.ts
+++ b/packages/studio-server/src/preview-server/routes/apply-visual-control-change.ts
@@ -1,13 +1,13 @@
import {readFileSync} from 'node:fs';
import type {File} from '@babel/types';
import {RenderInternals} from '@remotion/renderer';
+import {applyCodemod} from '@remotion/studio-codemods';
import type {
ApplyVisualControlRequest,
ApplyVisualControlResponse,
} from '@remotion/studio-shared';
import * as recast from 'recast';
import {parseAst, serializeAst} from '../../codemods/parse-ast';
-import {applyCodemod} from '../../codemods/recast-mods';
import {writeFileAndNotifyFileWatchers} from '../../file-watcher';
import {resolveFileInsideProject} from '../../helpers/resolve-file-inside-project';
import type {ApiHandler} from '../api-types';