writer.md

Writer(pathParts)

Constructor

Kind: global function

Param	Type
pathParts	Array.<string>

• Writer(pathParts)
  • .setLeadingFileComments(comments)
  • .setTrailingFileComments(comments)
  • .preventDeletionOf(pathsToPrevent)
  • .clean()
  • .write(path, filename, content)

writer.setLeadingFileComments(comments)

Sets the contents to write to the beginning of a file when write is called. E.g. legal banner.

Kind: instance method of Writer

Param	Type	Description
comments	string	The leading file comments

writer.setTrailingFileComments(comments)

Sets the contents to write to the end of a file when write is called. E.g. legal footer

Kind: instance method of Writer

Param	Type	Description
comments	string	The trailing file comments

writer.preventDeletionOf(pathsToPrevent)

Adds items to the list of file and folder names to prevent deleting.

Kind: instance method of Writer

Param	Type	Description
pathsToPrevent	Array.<string>	The paths to add to the internal prevention list

writer.clean()

Recursively cleans the base directory

Kind: instance method of Writer

writer.write(path, filename, content)

Writes the contents of a string to a path and file

Kind: instance method of Writer

Param	Type	Description
path	Array.<string>	The path to write to
filename	string	The filename to create/replace
content	string	The file content