@salesforce/salesforcedx-vscode-test-tools/lib/src/system-operations/fileSystem.d.ts

Test automation framework for Salesforce Extensions for VS Code

import { TestSetup } from '../testSetup';
/**
 * Creates a directory at the specified path
 * @param folderPath - The file system path where the folder should be created
 */
export declare function createFolder(folderPath: string): void;
/**
 * Creates a file at the specified path, overwriting the file if it already exists
 * @param filePath - The file system path where the file should be created
 * @param content - The content to be written to the file
 */
export declare function createOrOverwriteFile(filePath: string, content: string): void;
/**
 * Removes a directory and all its contents at the specified path
 * @param folderPath - The file system path of the folder to be removed
 */
export declare function removeFolder(folderPath: string): void;
/**
 * Creates custom Salesforce objects in the project's force-app directory
 * Copies object definitions from testSetup.testDataFolderPath to the project
 * @param testSetup - The test setup object containing project paths
 * @throws Error if copying fails or paths are undefined
 */
export declare function createCustomObjects(testSetup: TestSetup): Promise<void>;
/**
 * Creates a global Apex code snippets file in the project's .vscode directory
 * @param testSetup - The test setup object containing project paths
 * @throws Error if file creation fails or paths are undefined
 */
export declare function createGlobalSnippetsFile(testSetup: TestSetup): Promise<void>;
/**
 * Scans the directory for vsix files and returns the full path to each file
 * @param vsixDir
 * @returns
 */
export declare function getVsixFilesFromDir(vsixDir: string): string[];
/**
 * Return folder name if given path is a directory, otherwise return null
 * @param folderPath
 * @returns folder name
 */
export declare function getFolderName(folderPath: string): string | null;