@codemod-utils/files
Version:
Utilities for handling files
28 lines (27 loc) • 554 B
TypeScript
import type { FilePath, Options } from './types.js';
/**
* Removes files. Removes the source directory if it is empty.
*
* @param filePaths
*
* An array of file paths.
*
* @param options
*
* An object with `projectRoot`.
*
* @example
*
* Remove `LICENSE.md` and `README.md` from the project root.
*
* ```ts
* const filePaths = ['LICENSE.md', 'README.md'];
*
* removeFiles(filePaths, {
* projectRoot,
* });
* ```
*/
export declare function removeFiles(filePaths: FilePath[], options: Options & {
projectRoot: string;
}): void;