Nicer help message

[porglezomp]

The help message produced by scc is somewhat confusing and hard to read.

The help text is currently 170 columns wide. It could benefit from line wrapping, ideally automatic based on terminal width, but I understand if that's out of scope.

Current:

   --wide, -w           Set to check produce more output such as complexity and code vs complexity ranking. Same as setting format to wide

Wrapping for 100 columns:

   --wide, -w           Set to check produce more output such as complexity and
                        code vs complexity ranking. Same as setting format to wide.

In addition, many of the help messages are phrased awkwardly, which makes the width issue worse.

For example, --files has the description "Set to specify you want to see the output for every file" which could be written more concisely as "Display output for every file".

[boyter]

I will admit copy writing is not my strong point.

I will have to see about wrapping. Its done though https://github.com/urfave/cli and I don't remember a way to do it in an automated way, but perhaps newlines will work.

If you want to submit a PR with redone messages id be happy to merge it in. Otherwise I am afraid my best guess might still be awkward.

Let me know either way and ill look into the wrapping.

[boyter]

Have modified some of the copy as suggested. Not sure if I can modify the wrapping, still investigating this.

[boyter]

$ scc --help
NAME:
   scc - Sloc, Cloc and Code. Count lines of code in a directory with complexity estimation.

USAGE:
   scc DIRECTORY

VERSION:
   1.10.0

COMMANDS:
     help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --languages                         Print out supported languages and extensions
   --format value, -f value            Set output format [possible values: tabular, wide, json, csv] (default: "tabular")
   --output value, -o value            Save to file, defaults to stdout
   --pathblacklist value, --pbl value  Which directories should be ignored as comma separated list (default: ".git,.hg,.svn")
   --sort value, -s value              Sort based on column [possible values: files, name, lines, blanks, code, comments, complexity] (default: "files")
   --exclude value, -e value           Ignore files and directories matching a regular expression
   --whitelist value, --wl value       Restrict file extensions to just those provided as a comma separated list E.G. go,java,js
   --files                             Display output for every file
   --verbose, -v                       Enable verbose output
   --duplicates, -d                    Check for and remove duplicate files from stats and output
   --complexity, -c                    Skip complexity calculations, note this will be overridden if --wide -w is set
   --wide, -w                          Wider output with additional statistics
   --averagewage value, --aw value     Integer to override the average wage value used for basic COCOMO calculation (default: 56286)
   --cocomo, --co                      Set to check remove COCOMO calculation output
   --filegccount value, --fgc value    How many files to parse before turning the GC on (default: 10000)
   --binary                            Disable binary file detection
   --debug                             Enable debug output
   --trace                             Enable trace output, not recommended when processing multiple files
   --help, -h                          show help
   --version, --ver                    Print the version

[porglezomp]

That's a lot clearer. The only big issue I still have with it is for --cocomo which looks like it didn't get an update. I'd just write that as "Remove COCOMO calculation output"

[boyter]

Dammit I had a feeling I might have missed one. Ill update that as well.

[boyter]

Done.