Skip to main content

addFolder()v4.0.528

Adds an empty <Folder> to the registration tree.

warning

Draft API: This API is experimental and may change.

add-folder.ts
import {addFolder, type CodemodProject} from '@remotion/codemods';

declare const project: CodemodProject;

const result = addFolder({
  project,
  compositionFile: 'src/Root.tsx',
  folder: {name: 'Social', parentName: null},
});

console.log(result);

Adds the Folder import when needed. The name must be non-empty, contain no /, and be unused in its parent. The parent must exist. Use a file containing one registration component.

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.

folder​

Identifies a folder in compositionFile.

name​

The folder name.

parentName​

The slash-separated path of the parent folder, such as Social/Published. Use null for a top-level folder.

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.

insertedNodev4.0.530​

The reference of the inserted <Folder> element 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​