Skip to main content

renameComposition()v4.0.528

Changes a composition registration's ID.

warning

Draft API: This API is experimental and may change.

rename-composition.ts
import {renameComposition, type CodemodProject} from '@remotion/codemods';

declare const project: CodemodProject;

const result = renameComposition({
  project,
  compositionFile: 'src/Root.tsx',
  compositionId: 'MyComposition',
  newId: 'RenamedComposition',
});

console.log(result);

Changes the ID in source. It does not rename component exports, files, or references elsewhere. Passing the existing ID returns an unchanged project.

Options​

project​

An in-memory CodemodProject. The input project is not mutated.

compositionFile​

The project file containing the composition registrations. Registration edits support <Composition>, <Still>, and <Folder> with static IDs or folder names. Aliased and namespace imports from remotion are supported.

compositionId​

The static ID of the composition to edit.

newId​

The new ID, containing only ASCII letters, numbers, CJK characters, or hyphens. It must be unused in this file.

Return value​

Returns an object with the following properties.

changes​

An array of {filePath, previousContents, nextContents} file changes. A null content value indicates a created or deleted file.

nodePathRemappingsv4.0.530​

An array of {filePath, oldNodePath, newNodePath} mappings. A null old path indicates an insertion; a null new path indicates removal. Apply these mappings to references from the input project. See node references.

updatedNodev4.0.530​

The renamed registration's node reference in the new project.

Errors​

Throws when the target cannot be resolved, the requested edit is unsupported, or an option is invalid. Failed edits leave the input project unchanged.

Compatibility​

BrowsersServersEnvironments
Chrome
Firefox
Safari
Node.js
Bun
Serverless Functions

See also​