snapcube
Version:
📦 Snapshot, backup, and restore any project — binary-safe, fast, and simple CLI.
18 lines • 911 B
TypeScript
import { ServiceOptions, SnapCubeFile } from "../types";
/**
* Scans a local project directory and returns metadata + content
* for every file, formatted as SnapCubeFile objects.
*
* @param rootPath - The absolute or relative path of the project directory
* @param options - Configuration for how files should be scanned
* - ignoreBinaries: Skip contents of binary files (images, pdfs, etc.)
* - ignoreAll: Skip contents of all files (structure only)
* - token: Reserved for GitHub API use (not used in local scans)
* - structureOnly: If true, combine `filePath` + `fileName` into one
*
* @returns An array of SnapCubeFile objects or string representing the project
*
* @throws Error if the provided path is not a directory
*/
export declare const getProjectFiles: (rootPath: string, options?: ServiceOptions) => string[] | SnapCubeFile[];
//# sourceMappingURL=getProjectFiles.d.ts.map