Skip to content

Mileter/Formatter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Formatter

The formatter: makes your files look better.

Manual

Mileter/Formatter Manual

USAGE: formatter [operation] <options ...>

Acceptable operations:
help               Displays help.
ana, auto-newline  Auto-indents.

USAGE on operation help
USAGE: formatter help [command ...]

This operation will display a help message, like this.

command: an optional parameter to show a given usage pattern of a given command.
         If no command is suplied, it will display all general operations.
         If commands are supllied, it will display the usage pattern for each command in order.
         If the supplied command is not a valid command, the program will show a string following the following string pattern:
         "Unknown command `${cmd}` has no usage pattern"

USAGE on ana/auto-newline
USAGE: formatter <ana|auto-newline> <input file> <output file> <max character limit> [force-overwrite]

This operation will attempt to format a document based on guesses on what constitutes a paragraph break.

input file:          The input file should be of the filename of that of that that you want to auto-newline.
output file:         The output file should be of the filename of that of that that you want to store the results of the auto-newline. This parameter will not overwrite a file unless the user specifically allows for such an operation to take place.
max character limit: The max character limit can be configured to limit the number of characters on a line.
force-overwrite:     THIS OPTION HAS NOT YET BEEN IMPLEMENTED. This option will later, will not ask you whether you want to overwrite files or not.

About

The formatter: makes your files look better.

Resources

License

Stars

Watchers

Forks

Packages

No packages published