@remotion/codemodsv4.0.527

Apply source-to-source transforms to an in-memory Remotion project.

warning

Draft API: This API is not yet stable. We are in the experimental phase of this package and reserve to change it at any time.

The package accepts a record of file paths and source code and returns a new project together with the files that changed. It does not read from or write to the filesystem, so it can run in browsers and server-side JavaScript runtimes.

Installation

Remotion CLI
npm
bun
pnpm
yarn

npx remotion add @remotion/codemods

npm i --save-exact @remotion/[email protected]

This assumes you are currently using v4.0.526 of Remotion.
Also update remotion and all `@remotion/*` packages to the same version.
Remove all ^ character in front of the version numbers of it as it can lead to a version conflict.

pnpm i @remotion/[email protected]

bun i @remotion/[email protected]

yarn --exact add @remotion/[email protected]

Keep the version aligned with the other Remotion packages in the project.

Project model

A codemod project contains a rootDir and a files record. File paths may be project-relative or absolute, but they must consistently identify imports within the project.

project.ts
import type {CodemodProject} from '@remotion/codemods';

export const project: CodemodProject = {
  rootDir: '/',
  files: {
    'src/Root.tsx': `export const Root = () => null;`,
  },
};