GithubHelp home page GithubHelp logo

Nicer help message about scc HOT 6 CLOSED

boyter avatar boyter commented on May 17, 2024
Nicer help message

from scc.

Comments (6)

boyter avatar boyter commented on May 17, 2024

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.

from scc.

boyter avatar boyter commented on May 17, 2024

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

from scc.

boyter avatar boyter commented on May 17, 2024
$ 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

from scc.

porglezomp avatar porglezomp commented on May 17, 2024

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"

from scc.

boyter avatar boyter commented on May 17, 2024

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

from scc.

boyter avatar boyter commented on May 17, 2024

Done.

from scc.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.