DirectoryAliases Class

Summary

Contains extension methods for working with directories.
Namespace
Cake.Common.IO
Base Types
  • object
graph TD Base0["object"]-->Type Type["DirectoryAliases"] class Type type-node

Syntax

[CakeAliasCategory("Directory Operations")]
public static class DirectoryAliases

Attributes

Type Description
CakeAliasCategoryAttribute An attribute used for documentation of alias methods/properties.

Methods

Name Value Summary
CleanDirectories(ICakeContext, IEnumerable<DirectoryPath>) void
Cleans the specified directories. Cleaning a directory will remove all its content but not the directory itself.
static
CleanDirectories(ICakeContext, IEnumerable<string>) void
Cleans the specified directories. Cleaning a directory will remove all its content but not the directory itself.
static
CleanDirectories(ICakeContext, string) void
Cleans the directories matching the specified pattern. Cleaning the directory will remove all its content but not the directory itself.
static
CleanDirectories(ICakeContext, string, Func<IFileSystemInfo, bool>) void
Cleans the directories matching the specified pattern. Cleaning the directory will remove all its content but not the directory itself.
static
CleanDirectory(ICakeContext, DirectoryPath) void
Cleans the specified directory.
static
CleanDirectory(ICakeContext, DirectoryPath, Func<IFileSystemInfo, bool>) void
Cleans the specified directory.
static
CopyDirectory(ICakeContext, DirectoryPath, DirectoryPath) void
Copies the contents of a directory, including subdirectories to the specified location.
static
CreateDirectory(ICakeContext, DirectoryPath) void
Creates the specified directory.
static
DeleteDirectories(ICakeContext, IEnumerable<DirectoryPath>, bool) void
Deletes the specified directories.
static
DeleteDirectories(ICakeContext, IEnumerable<DirectoryPath>, DeleteDirectorySettings) void
Deletes the specified directories.
static
DeleteDirectories(ICakeContext, IEnumerable<string>, bool) void
Deletes the specified directories.
static
DeleteDirectories(ICakeContext, IEnumerable<string>, DeleteDirectorySettings) void
Deletes the specified directories.
static
DeleteDirectory(ICakeContext, DirectoryPath, bool) void
Deletes the specified directory.
static
DeleteDirectory(ICakeContext, DirectoryPath, DeleteDirectorySettings) void
Deletes the specified directory.
static
Directory(ICakeContext, string) ConvertableDirectoryPath
Gets a directory path from string.
static
DirectoryExists(ICakeContext, DirectoryPath) bool
Determines whether the given path refers to an existing directory.
static
EnsureDirectoryExists(ICakeContext, DirectoryPath) void
Creates the specified directory if it does not exist.
static
GetSubDirectories(ICakeContext, DirectoryPath) DirectoryPathCollection
Gets a list of all the directories inside a directory.
static
MakeAbsolute(ICakeContext, DirectoryPath) DirectoryPath
Makes the path absolute (if relative) using the current working directory.
static
MoveDirectory(ICakeContext, DirectoryPath, DirectoryPath) void
Moves an existing directory to a new location, providing the option to specify a new directory name.
static