## FileOperations **Kind**: global class * [FileOperations](#FileOperations) * [.getAllFileNames(files)](#FileOperations+getAllFileNames) ⇒ array * [.doGlobDelete(globPattern, conversionStep)](#FileOperations+doGlobDelete) * [.globGetFilesByExtension(directoryPath, fileExtension)](#FileOperations+globGetFilesByExtension) ⇒ array * [.globGetFilesByPattern(pattern)](#FileOperations+globGetFilesByPattern) ⇒ array * [.deleteFile(filePath, conversionStep)](#FileOperations+deleteFile) * [.deleteFilesWithExtension(directoryPath, extension, conversionStep)](#FileOperations+deleteFilesWithExtension) * [.deleteAllFilesContainingSubstring(directoryPath, fileSubString, conversionStep)](#FileOperations+deleteAllFilesContainingSubstring) * [.deleteAllFilesNotConformingToPattern(directoryPath, filePattern, conversionStep)](#FileOperations+deleteAllFilesNotConformingToPattern) ⇒ array * [.renameFile(srcPath, destPath)](#FileOperations+renameFile) * [.getContentFromFile(filePath, recursive)](#FileOperations+getContentFromFile) ⇒ string * [.getReadablePath(line, pathToPrepend)](#FileOperations+getReadablePath) ⇒ string * [.getPathForDir(isConfString, dirName)](#FileOperations+getPathForDir) ⇒ string * [.removeVirtualHostSectionsNotPort80(directoryPath, conversionStep)](#FileOperations+removeVirtualHostSectionsNotPort80) * [.removeOrReplaceFileInclude(filePath, includeStatementSyntax, oldRuleName, newRuleName, conversionStep)](#FileOperations+removeOrReplaceFileInclude) * [.removeIncludeStatementForSomeRule(directoryPath, includeStatementSyntax, fileExtension, ruleFileNameToRemove, conversionStep)](#FileOperations+removeIncludeStatementForSomeRule) * [.replaceIncludeStatementWithNewRule(directoryPath, fileExtension, includeStatementSyntax, ruleFileToReplace, ruleFileToReplaceWith, conversionStep)](#FileOperations+replaceIncludeStatementWithNewRule) * [.removeOrReplaceIncludePatternInSection(filePath, sectionHeader, includePatternToReplace, includePatternToReplaceWith, conversionStep)](#FileOperations+removeOrReplaceIncludePatternInSection) * [.replaceIncludePatternInSection(directoryPath, fileExtension, sectionHeader, patternToReplace, fileToReplaceWith, conversionStep)](#FileOperations+replaceIncludePatternInSection) * [.replaceFileIncludeWithFileContent(filePath, includeStatementSyntax, ruleFileToReplace, ruleFileContent, conversionStep)](#FileOperations+replaceFileIncludeWithFileContent) * [.replaceIncludeStatementWithContentOfRuleFile(directoryPath, fileExtension, ruleFileToReplace, content, includeStatementSyntax, conversionStep)](#FileOperations+replaceIncludeStatementWithContentOfRuleFile) * [.replaceVariableUsage(filePath, variableToReplace, newVariable)](#FileOperations+replaceVariableUsage) * [.replaceAllUsageOfOldVariableWithNewVariable(directoryPath, fileExtension, variableToReplace, newVariable)](#FileOperations+replaceAllUsageOfOldVariableWithNewVariable) * [.removeVariableUsage(filePath, variableToRemove, conversionStep)](#FileOperations+removeVariableUsage) * [.removeAllUsageOfOldVariable(directoryPath, fileExtension, variableToRemove, conversionStep)](#FileOperations+removeAllUsageOfOldVariable) * [.replaceParticularSectionContentWithIncludeStatement(filePath, sectionHeader, includeStatementToReplaceWith, conversionStep)](#FileOperations+replaceParticularSectionContentWithIncludeStatement) * [.replaceContentOfSection(directoryPath, extension, sectionHeader, includeStatementToReplaceWith, conversionStep)](#FileOperations+replaceContentOfSection) * [.removeNonWhitelistedDirectivesInVhostFiles(directoryPath, whitelistedDirectivesSet, conversionStep)](#FileOperations+removeNonWhitelistedDirectivesInVhostFiles) * [.removeNonMatchingFilesByName(srcDir, destDir, conversionStep)](#FileOperations+removeNonMatchingFilesByName) * [.consolidateVariableFiles(files, newFilePath)](#FileOperations+consolidateVariableFiles) ⇒ array * [.checkForUndefinedVariables(directoryPath, definedVariablesList)](#FileOperations+checkForUndefinedVariables) * [.replaceIncludesInFarmAndVhostFile(dirPath, type, header, ruleFileToReplace, includePatternToReplaceWith, conversionStep)](#FileOperations+replaceIncludesInFarmAndVhostFile) * [.replaceFileIncludesInFarmFileAndVhostFile(filePath, type, header, ruleFilesToReplace, includePatternToReplaceWith, conversionStep)](#FileOperations+replaceFileIncludesInFarmFileAndVhostFile) * [.getNamesOfRuleFilesIncluded(filePath, ruleFilesToCheck, includeSyntax, recursive)](#FileOperations+getNamesOfRuleFilesIncluded) ⇒ * [.consolidateAllRuleFilesIntoSingleRuleFile(ruleFiles, consolidatedRuleFilePath, conversionStep)](#FileOperations+consolidateAllRuleFilesIntoSingleRuleFile) * [.getFileContentsArray(file)](#FileOperations+getFileContentsArray) * [.getPath(file)](#FileOperations+getPath) ⇒ string ### fileOperations.getAllFileNames(files) ⇒ array Get all the file names from the provided list of files. **Kind**: instance method of [FileOperations](#FileOperations) **Returns**: array - Returns an array of file names | Param | Type | Description | | --- | --- | --- | | files | array | A string array of file paths whose names will be returned | ### fileOperations.doGlobDelete(globPattern, conversionStep) Delete files matching the passed globPattern **Kind**: instance method of [FileOperations](#FileOperations) | Param | Default | | --- | --- | | globPattern | | | conversionStep | | ### fileOperations.globGetFilesByExtension(directoryPath, fileExtension) ⇒ array Utility Function to return files recursively based on a directory path and file extension. **Kind**: instance method of [FileOperations](#FileOperations) **Returns**: array - files An Array of files | Param | | --- | | directoryPath | | fileExtension | ### fileOperations.globGetFilesByPattern(pattern) ⇒ array Utility Function to return files based on any pattern given **Kind**: instance method of [FileOperations](#FileOperations) **Returns**: array - files An Array of files | Param | Type | Description | | --- | --- | --- | | pattern | string | The glob pattern used to search | ### fileOperations.deleteFile(filePath, conversionStep) Deletes the file provided. **Kind**: instance method of [FileOperations](#FileOperations) | Param | Type | Default | Description | | --- | --- | --- | --- | | filePath | string | | The path of the file to delete | | conversionStep | object | | The conversion step to which the performed actions are to be added. | ### fileOperations.deleteFilesWithExtension(directoryPath, extension, conversionStep) Deletes all files with given extension in a specific directory. Does not check sub-directories. Sample Usage: `FileOperations.deleteFilesWithExtension("./target/js", ".min.js")` **Kind**: instance method of [FileOperations](#FileOperations) | Param | Type | Description | | --- | --- | --- | | directoryPath | string | The path to the directory where the deletion is to be performed | | extension | string | The file extension which is to be matched for deletion | | conversionStep | object | The conversion step to which the performed actions are to be added. | ### fileOperations.deleteAllFilesContainingSubstring(directoryPath, fileSubString, conversionStep) Deletes all files with given extension in a specific directory. Does not check sub-directories. **Kind**: instance method of [FileOperations](#FileOperations) | Param | Type | Description | | --- | --- | --- | | directoryPath | string | The path to the directory where the deletion is to be performed | | fileSubString | string | The file extension which is to be matched for deletion | | conversionStep | object | The conversion step to which the performed actions are to be added. | ### fileOperations.deleteAllFilesNotConformingToPattern(directoryPath, filePattern, conversionStep) ⇒ array Delete all files in a given directory (recursively) on conforming to the given pattern (eg. '*.vars'). Returns the files remaining. **Kind**: instance method of [FileOperations](#FileOperations) **Returns**: array - a list containing the names of the files in the directory. | Param | Type | Description | | --- | --- | --- | | directoryPath | string | | | filePattern | string | | | conversionStep | object | The conversion step to which the performed actions are to be added. | ### fileOperations.renameFile(srcPath, destPath) Renames file by copying it from source path and copying the content at the destination path **Kind**: instance method of [FileOperations](#FileOperations) | Param | | --- | | srcPath | | destPath | ### fileOperations.getContentFromFile(filePath, recursive) ⇒ string **Kind**: instance method of [FileOperations](#FileOperations) **Returns**: string - Content of the file | Param | Type | Default | Description | | --- | --- | --- | --- | | filePath | string | | The path to file whose content is to be retrieved | | recursive | | false | | ### fileOperations.getReadablePath(line, pathToPrepend) ⇒ string Returns path by taking file name from path and concatenating pathToPrepend to it. **Kind**: instance method of [FileOperations](#FileOperations) | Param | | --- | | line | | pathToPrepend | ### fileOperations.getPathForDir(isConfString, dirName) ⇒ string Appends path in configuration file to get the actual path of the file **Kind**: instance method of [FileOperations](#FileOperations) | Param | | --- | | isConfString | | dirName | ### fileOperations.removeVirtualHostSectionsNotPort80(directoryPath, conversionStep) **Kind**: instance method of [FileOperations](#FileOperations) | Param | Type | Description | | --- | --- | --- | | directoryPath | string | The path to the vhost directory | | conversionStep | object | The conversion step to which the performed actions are to be added. | ### fileOperations.removeOrReplaceFileInclude(filePath, includeStatementSyntax, oldRuleName, newRuleName, conversionStep) Remove or replace inclusion of some file. If replacement file is not specified, the include statement is removed. **Kind**: instance method of [FileOperations](#FileOperations) | Param | Type | Default | Description | | --- | --- | --- | --- | | filePath | | | | | includeStatementSyntax | | | | | oldRuleName | | | | | newRuleName | | | | | conversionStep | object | | The conversion step to which the performed actions are to be added. | ### fileOperations.removeIncludeStatementForSomeRule(directoryPath, includeStatementSyntax, fileExtension, ruleFileNameToRemove, conversionStep) Remove inclusion of some file from all files os given file-extension in specified directory and sub-directories. **Kind**: instance method of [FileOperations](#FileOperations) | Param | Type | Description | | --- | --- | --- | | directoryPath | string | The path to directory whose files are to be processed | | includeStatementSyntax | string | The syntax of the include statement to be looked for | | fileExtension | string | The extension of the type that needs to be processed | | ruleFileNameToRemove | string | The rule file name (in include statement) that is to be removed | | conversionStep | object | The conversion step to which the performed actions are to be added. | ### fileOperations.replaceIncludeStatementWithNewRule(directoryPath, fileExtension, includeStatementSyntax, ruleFileToReplace, ruleFileToReplaceWith, conversionStep) Replace inclusion of some file (with new file to be included) from all files os given file-extension in specified directory and sub-directories. **Kind**: instance method of [FileOperations](#FileOperations) | Param | Type | Description | | --- | --- | --- | | directoryPath | | The path to directory whose files are to be processed | | fileExtension | | The extension of the type that needs to be processed | | includeStatementSyntax | | The syntax of the include statement to be looked for | | ruleFileToReplace | | The rule file name (in include statement) that is to be replaced | | ruleFileToReplaceWith | | The rule file name (in include statement) that is to be replaced with | | conversionStep | object | The conversion step to which the performed actions are to be added. | ### fileOperations.removeOrReplaceIncludePatternInSection(filePath, sectionHeader, includePatternToReplace, includePatternToReplaceWith, conversionStep) Remove-replace include statements of certain pattern within specified sections of a file. **Kind**: instance method of [FileOperations](#FileOperations) | Param | Type | Description | | --- | --- | --- | | filePath | string | | | sectionHeader | string | | | includePatternToReplace | string | | | includePatternToReplaceWith | string | | | conversionStep | object | The conversion step to which the performed actions are to be added. | ### fileOperations.replaceIncludePatternInSection(directoryPath, fileExtension, sectionHeader, patternToReplace, fileToReplaceWith, conversionStep) **Kind**: instance method of [FileOperations](#FileOperations) | Param | Type | Description | | --- | --- | --- | | directoryPath | | | | fileExtension | | | | sectionHeader | | | | patternToReplace | | | | fileToReplaceWith | | | | conversionStep | object | The conversion step to which the performed actions are to be added. | ### fileOperations.replaceFileIncludeWithFileContent(filePath, includeStatementSyntax, ruleFileToReplace, ruleFileContent, conversionStep) Replace file include statements with the content of the included file itself. **Kind**: instance method of [FileOperations](#FileOperations) | Param | Type | Description | | --- | --- | --- | | filePath | string | | | includeStatementSyntax | string | | | ruleFileToReplace | string | | | ruleFileContent | string | | | conversionStep | object | The conversion step to which the performed actions are to be added. | ### fileOperations.replaceIncludeStatementWithContentOfRuleFile(directoryPath, fileExtension, ruleFileToReplace, content, includeStatementSyntax, conversionStep) Replace file include statements with the content of the included file itself, in all files of given file-type in specified directory and sub-directories. **Kind**: instance method of [FileOperations](#FileOperations) | Param | Type | Description | | --- | --- | --- | | directoryPath | string | The path to directory whose files are to be processed | | fileExtension | string | The extension of the type that needs to be processed | | ruleFileToReplace | string | include statement pattern that is to be replaced | | content | string | The content of file with which the include statement is to be replaced | | includeStatementSyntax | string | The syntax of the include statement to be replaced | | conversionStep | object | The conversion step to which the performed actions are to be added. | ### fileOperations.replaceVariableUsage(filePath, variableToReplace, newVariable) Replace usage of a variable with a new variable. **Kind**: instance method of [FileOperations](#FileOperations) | Param | Type | Description | | --- | --- | --- | | filePath | string | The file to replace the variables in | | variableToReplace | string | The variable that will be replaced | | newVariable | string | The new variable to put in place of replaced. | ### fileOperations.replaceAllUsageOfOldVariableWithNewVariable(directoryPath, fileExtension, variableToReplace, newVariable) Replaces name of old variables with the new variables. **Kind**: instance method of [FileOperations](#FileOperations) | Param | | --- | | directoryPath | | fileExtension | | variableToReplace | | newVariable | ### fileOperations.removeVariableUsage(filePath, variableToRemove, conversionStep) Remove usage of specified variable within a file. If the variable is used in an if block - the entire if statement is removed. **Kind**: instance method of [FileOperations](#FileOperations) | Param | Type | Description | | --- | --- | --- | | filePath | string | The file to search for the variable in. | | variableToRemove | string | The variable to remove. | | conversionStep | object | The conversion step to which the performed actions are to be added. | ### fileOperations.removeAllUsageOfOldVariable(directoryPath, fileExtension, variableToRemove, conversionStep) Replace usage of specified variable in all files of given file-type in specified directory and sub-directories. **Kind**: instance method of [FileOperations](#FileOperations) | Param | Type | Description | | --- | --- | --- | | directoryPath | string | The path to directory whose files are to be processed | | fileExtension | string | The extension of the type that needs to be processed | | variableToRemove | string | The variable that is to be removed | | conversionStep | object | The conversion step to which the performed actions are to be added. | ### fileOperations.replaceParticularSectionContentWithIncludeStatement(filePath, sectionHeader, includeStatementToReplaceWith, conversionStep) **Kind**: instance method of [FileOperations](#FileOperations) | Param | | --- | | filePath | | sectionHeader | | includeStatementToReplaceWith | | conversionStep | ### fileOperations.replaceContentOfSection(directoryPath, extension, sectionHeader, includeStatementToReplaceWith, conversionStep) **Kind**: instance method of [FileOperations](#FileOperations) | Param | | --- | | directoryPath | | extension | | sectionHeader | | includeStatementToReplaceWith | | conversionStep | ### fileOperations.removeNonWhitelistedDirectivesInVhostFiles(directoryPath, whitelistedDirectivesSet, conversionStep) Removes Non Whitelisted Directives in Vhost Files **Kind**: instance method of [FileOperations](#FileOperations) | Param | | --- | | directoryPath | | whitelistedDirectivesSet | | conversionStep | ### fileOperations.removeNonMatchingFilesByName(srcDir, destDir, conversionStep) Remove files in destination dir which are not present in source dir (comparision by name) **Kind**: instance method of [FileOperations](#FileOperations) | Param | Type | Description | | --- | --- | --- | | srcDir | string | The source directory's path | | destDir | string | The destination directory's path | | conversionStep | ConversionStep | The Conversion Step Object used to Write the Report. | ### fileOperations.consolidateVariableFiles(files, newFilePath) ⇒ array Returns a list of the variables after consolidating the variables (duplicates not allowed) from given files into a single new file. **Kind**: instance method of [FileOperations](#FileOperations) **Returns**: array - An array of variable names that were added to the new file. | Param | Type | Description | | --- | --- | --- | | files | array | An array of all the files that will be parsed and combined. | | newFilePath | string | The file that will be created to consolidate the variables. | ### fileOperations.checkForUndefinedVariables(directoryPath, definedVariablesList) Check vhost files for usage of undefined variables. If found, print warning in terminal. **Kind**: instance method of [FileOperations](#FileOperations) **Throws**: - TypeError This will throw a error if the directory does not exist. | Param | Type | | --- | --- | | directoryPath | string | | definedVariablesList | array | ### fileOperations.replaceIncludesInFarmAndVhostFile(dirPath, type, header, ruleFileToReplace, includePatternToReplaceWith, conversionStep) Replace Includes by reading directories and passing file to include the file content **Kind**: instance method of [FileOperations](#FileOperations) | Param | | --- | | dirPath | | type | | header | | ruleFileToReplace | | includePatternToReplaceWith | | conversionStep | ### fileOperations.replaceFileIncludesInFarmFileAndVhostFile(filePath, type, header, ruleFilesToReplace, includePatternToReplaceWith, conversionStep) **Kind**: instance method of [FileOperations](#FileOperations) | Param | | --- | | filePath | | type | | header | | ruleFilesToReplace | | includePatternToReplaceWith | | conversionStep | ### fileOperations.getNamesOfRuleFilesIncluded(filePath, ruleFilesToCheck, includeSyntax, recursive) ⇒ Returns rules file included based on includeSyntax **Kind**: instance method of [FileOperations](#FileOperations) | Param | Default | | --- | --- | | filePath | | | ruleFilesToCheck | | | includeSyntax | | | recursive | true | ### fileOperations.consolidateAllRuleFilesIntoSingleRuleFile(ruleFiles, consolidatedRuleFilePath, conversionStep) Writes all the rules file into a single rule file **Kind**: instance method of [FileOperations](#FileOperations) | Param | | --- | | ruleFiles | | consolidatedRuleFilePath | | conversionStep | ### fileOperations.getFileContentsArray(file) **Kind**: instance method of [FileOperations](#FileOperations) | Param | | --- | | file | ### fileOperations.getPath(file) ⇒ string Returns path for a file **Kind**: instance method of [FileOperations](#FileOperations) | Param | | --- | | file |