OBSOLETE
Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem)
FileHelper
Contains helper function which allow to deal with files and directories.
Functions and values
Function or value | Description |
allFiles(path)
Signature: path:string -> bool
Attributes: [<Obsolete("Please open an issue and tell us why you need it! (FAKE0002 - no longer supported)")>] |
OBSOLETEPlease open an issue and tell us why you need it! (FAKE0002 - no longer supported) Includes all files |
AppendTextFiles newFileName files
Signature: newFileName:string -> files:seq<string> -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.AppendTextFiles)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.AppendTextFiles) Appends all given files to one file. Parameters
|
changeExt extension fileName
Signature: extension:string -> fileName:string -> string
Attributes: [<Obsolete("Open System.IO and use Path.ChangeExtension")>] |
OBSOLETEOpen System.IO and use Path.ChangeExtension Change the extension of the file. Parameters
|
CleanDir(path)
Signature: path:string -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CleanDir)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CleanDir) Cleans a directory by removing all files and sub-directories. |
CleanDirs(dirs)
Signature: dirs:seq<string> -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CleanDirs)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CleanDirs) Cleans multiple directories |
CompareFiles(...)
Signature: delete:bool -> originalFileName:string -> compareFileName:string -> bool
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CompareFiles)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CompareFiles) Compares the given files for changes. If delete is set to true then equal files will be removed. |
Copy target files
Signature: target:string -> files:seq<string> -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.Copy)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.Copy) Copies the files to the target. Parameters
|
CopyCached target cacheDir files
Signature: target:string -> cacheDir:string -> files:seq<string> -> string list
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CopyCached)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CopyCached) Copies the files from a cache folder. If the files are not cached or the original files have a different write time the cache will be refreshed. Parameters
|
CopyDir target source filterFile
Signature: target:string -> source:string -> filterFile:(string -> bool) -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CopyDir)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CopyDir) Copies a directory recursivly. If the target directory does not exist, it will be created. Parameters
|
CopyFile target fileName
Signature: target:string -> fileName:string -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CopyFile)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CopyFile) Copies a single file to the target and overwrites the existing file. Parameters
|
CopyFileIntoSubFolder target fileName
Signature: target:string -> fileName:string -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CopyFileIntoSubFolder)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CopyFileIntoSubFolder) Copies a single file to a relative subfolder of the target. Parameters
|
CopyFiles target files
Signature: target:string -> files:seq<string> -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CopyFiles)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CopyFiles) Copies the files to the target - Alias for Copy Parameters
|
CopyFileWithSubfolder(...)
Signature: baseDir:string -> target:string -> fileName:string -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CopyFileWithSubfolder)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CopyFileWithSubfolder) Copies a single file to the target folder preserving the folder structure starting from the specified base folder. Parameters
|
copyRecursive dir outputDir overwrite
Signature: dir:DirectoryInfo -> outputDir:DirectoryInfo -> overwrite:bool -> string list
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.DirectoryInfo.copyRecursiveTo. NB: parameters order changed)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.DirectoryInfo.copyRecursiveTo. NB: parameters order changed) Copies the file structure recursively. |
CopyRecursive dir outputDir
Signature: dir:string -> outputDir:string -> bool -> string list
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CopyRecursive)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CopyRecursive) Copies the file structure recursively. |
CopyTo target files
Signature: target:string -> files:seq<string> -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CopyTo)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.CopyTo) Copies the given files to the target. Parameters
|
CopyWithSubfoldersTo target files
Signature: target:string -> files:seq<FileIncludes> -> unit
Attributes: [<Obsolete("Please open an issue and tell us why you need it! (FAKE0002 - no longer supported)")>] |
OBSOLETEPlease open an issue and tell us why you need it! (FAKE0002 - no longer supported) Copies several file groups, each represented by a FileIncludes object, to the target folder preserving the folder structure starting from the BaseDirectory of each FileIncludes. Parameters
|
CreateDir(path)
Signature: path:string -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Directory.create)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Directory.create) Creates a directory if it does not exist. |
CreateFile(fileName)
Signature: fileName:string -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.File.create)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.File.create) Creates a file if it does not exist. |
DeleteDir(path)
Signature: path:string -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Directory.delete)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Directory.delete) Deletes a directory if it exists. |
DeleteDirs(dirs)
Signature: dirs:seq<string> -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.DeleteDirs)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.DeleteDirs) Deletes multiple directories |
DeleteFile(fileName)
Signature: fileName:string -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.File.delete)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.File.delete) Deletes a file if it exists. |
DeleteFiles(files)
Signature: files:seq<string> -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.File.deleteAll)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.File.deleteAll) Deletes the given files. |
directory(path)
Signature: path:string -> string
Attributes: [<Obsolete("Open System.IO and use Path.GetDirectoryName")>] |
OBSOLETEOpen System.IO and use Path.GetDirectoryName Get the directory of the specified path Parameters
|
excludeSVNFiles(path)
Signature: path:string -> bool
Attributes: [<Obsolete("Please open an issue and tell us why you need it! (FAKE0002 - no longer supported)")>] |
OBSOLETEPlease open an issue and tell us why you need it! (FAKE0002 - no longer supported) Exclude SVN files (path with .svn) |
ext(fileName)
Signature: fileName:string -> string
Attributes: [<Obsolete("Open System.IO and use Path.GetExtension")>] |
OBSOLETEOpen System.IO and use Path.GetExtension Get the filename extension including the leading '.', or an empty string if the file has no extension. Parameters
|
filename(path)
Signature: path:string -> string
Attributes: [<Obsolete("Open System.IO and use Path.GetFileName")>] |
OBSOLETEOpen System.IO and use Path.GetFileName Get the filename for the specified path Parameters
|
filenameWithouExt(path)
Signature: path:string -> string
Attributes: [<Obsolete("This was a typo - please use fileNameWithoutExt")>] |
OBSOLETEThis was a typo - please use fileNameWithoutExt |
fileNameWithoutExt(path)
Signature: path:string -> string
Attributes: [<Obsolete("Open System.IO and use Path.GetFileNameWithoutExtension")>] |
OBSOLETEOpen System.IO and use Path.GetFileNameWithoutExtension Get the filename for the specified path without it's extension Parameters
|
FilesAreEqual first second
Signature: first:FileInfo -> second:FileInfo -> bool
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.FileInfo.contentIsEqualTo)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.FileInfo.contentIsEqualTo) Checks if the two files are byte-to-byte equal. |
FileVersion(fileName)
Signature: fileName:string -> string
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.File.getVersion)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.File.getVersion) Get the version a file. Parameters
|
GeneratePatch(...)
Signature: lastReleaseDir:string -> patchDir:string -> srcFiles:seq<string> -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.GeneratePatch)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.GeneratePatch) Checks the srcFiles for changes to the last release. Parameters
|
GeneratePatchWithFindOldFileFunction(...)
Signature: lastReleaseDir:string -> patchDir:string -> srcFiles:seq<string> -> findOldFileF:(string -> string -> string) -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.GeneratePatchWithFindOldFileFunction)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.GeneratePatchWithFindOldFileFunction) Checks the srcFiles for changes to the last release. Parameters
|
hasExt extension fileName
Signature: extension:string -> fileName:string -> bool
Attributes: [<Obsolete("Open System.IO and use System.String.Equals(Path.GetExtension fileName, extension, System.StringComparison.InvariantCultureIgnoreCase)")>] |
OBSOLETEOpen System.IO and use System.String.Equals(Path.GetExtension fileName, extension, System.StringComparison.InvariantCultureIgnoreCase) Tests whether the file has specified extensions (containing the leading '.') Parameters
|
MoveFile target fileName
Signature: target:string -> fileName:string -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.MoveFile)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.MoveFile) Moves a single file to the target and overwrites the existing file. Parameters
|
ReadCSVFile(file)
Signature: file:string -> seq<string []>
Attributes: [<Obsolete("Please open an issue and tell us why you need it! (FAKE0002 - no longer supported)")>] |
OBSOLETEPlease open an issue and tell us why you need it! (FAKE0002 - no longer supported) Reads a csv file line by line delimiter is a , |
recursively dirF fileF dir
Signature: dirF:(DirectoryInfo -> unit) -> fileF:(FileInfo -> unit) -> dir:DirectoryInfo -> unit
Attributes: [<Obsolete("Function is no more accessible (FAKE0003 - package: Fake.IO.FileSystem - member: Fake.IO.DirectoryInfo.recursively). If you consider, it is still useful, please open an issue and explain your use case")>] |
OBSOLETEFunction is no more accessible (FAKE0003 - package: Fake.IO.FileSystem - member: Fake.IO.DirectoryInfo.recursively). If you consider, it is still useful, please open an issue and explain your use case Performs the given actions on all files and subdirectories |
RegexReplaceInFilesWithEncoding(...)
Signature: pattern:string -> replacement:string -> encoding:Encoding -> files:seq<string> -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.RegexReplaceInFileWithEncoding)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.RegexReplaceInFileWithEncoding) Replace all occurences of the regex pattern with the given replacement in the specified files Parameters
|
RegexReplaceInFileWithEncoding(...)
Signature: pattern:string -> replacement:string -> encoding:Encoding -> file:string -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.RegexReplaceInFileWithEncoding)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.RegexReplaceInFileWithEncoding) Replace all occurences of the regex pattern with the given replacement in the specified file Parameters
|
Rename target fileName
Signature: target:string -> fileName:string -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.Rename)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.Rename) Renames the file or directory to the target name. Parameters
|
ReplaceInFiles replacements files
Signature: replacements:seq<string * string> -> files:seq<string> -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.ReplaceInFiles)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.ReplaceInFiles) Replaces all occurences of the patterns in the given files with the given replacements. Parameters
|
setDirectoryReadOnly readOnly dir
Signature: readOnly:bool -> dir:DirectoryInfo -> unit
Attributes: [<Obsolete("Please open an issue and tell us why you need it! (FAKE0002 - no longer supported)")>] |
OBSOLETEPlease open an issue and tell us why you need it! (FAKE0002 - no longer supported) Sets the directory readonly |
SetDirReadOnly readOnly dir
Signature: readOnly:bool -> dir:DirectoryInfo -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.DirectoryInfo.setReadOnlyRecursive)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.DirectoryInfo.setReadOnlyRecursive) Sets all files in the directory readonly. |
SetReadOnly readOnly files
Signature: readOnly:bool -> files:seq<string> -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.SilentCopy)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.SilentCopy) Sets all given files readonly. |
SilentCopy target files
Signature: target:string -> files:seq<string> -> unit
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.SilentCopy)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.SilentCopy) Copies a list of files to the specified directory without any output. Parameters
|
TestDir(path)
Signature: path:string -> bool
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.TestDir)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.TestDir) Checks if the directory exists |
TestFile(path)
Signature: path:string -> bool
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.TestFile)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.TestFile) Checks if the file exists |
WriteConfigFile(...)
Signature: configFileName:string -> parameters:seq<'?12699 * '?12700> -> unit
Type parameters: '?12699, '?12700 Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.WriteConfigFile)")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.Shell.WriteConfigFile) Creates a config file with the parameters as "key;value" lines |
Active patterns
Active pattern | Description |
( |EndsWith|_| ) extension file
Signature: extension:string -> file:string -> unit option
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.File.(|EndsWith|_|))")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.File.(|EndsWith|_|)) Active Pattern for determining file extension. |
( |File|Directory| )(fileSysInfo)
Signature: fileSysInfo:FileSystemInfo -> Choice<FileInfo,(DirectoryInfo * IEnumerable<FileSystemInfo>)>
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.FileSystemInfo.(|File|Directory|))")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.FileSystemInfo.(|File|Directory|)) Active pattern which discriminates between files and directories. |
( |FileInfoFullName| )(f)
Signature: f:FileInfo -> string
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.FileInfo.(|FullName|))")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.FileInfo.(|FullName|)) Active Pattern for determining file name. |
( |FileInfoNameSections| )(f)
Signature: f:FileInfo -> string * string * string
Attributes: [<Obsolete("Use Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.FileInfo.(|NameSections|))")>] |
OBSOLETEUse Fake.IO instead (FAKE0001 - package: Fake.IO.FileSystem - member: Fake.IO.FileInfo.(|NameSections|)) Active Pattern for determining FileInfoNameSections. |