Rob van der Woude's Scripting Pages

Help text for BatCodeCheck.cs

(view help text of BatCodeCheck.cs as plain text)

BatCodeCheck,  Version 0.41 beta
Search batch source code for common errors

Usage:   BATCODECHECK  batchfile [ logging ] [ options ]

Or:      BATCODECHECK  [ batchfile ]  /I

Where:   batchfile       is the batch file to be checked and highlighted
Logging: /L[:"logfile"]  Log results in ASCII format, replace file if it exists
         /H[:"htmlfile"] log results in HTML format, replace file if it exists
                         (default output file names and paths equal batchfile
                         name and path, with extension .log or .html)
Options: /C:checks       run only the specified Checks, where "checks" is a
                         combination of the following letters:
                         A    command line Arguments for batch commands
                         B    Best practice tips
                         E    Environment variables
                         L    Labels
                         M    common Mistakes
                         S    verbose Summary (variables, labels, subroutines)
                         U    Undefined environment variables
                         V    Vulnerabilities
         /D              Debug mode: append error stack trace to error messages
         /E              include local Environment in defined variables list
         /I              open Interactive settings dialog (licensed version)
         /O              Open log file(s) when done (requires /L and/or /H)
         /S              Split one-liners into separate command lines
         /T              add a Timestamp to the default output file names
         /U              check for BatCodeCheck Updates (unlicensed version)
         /W              Wrap messages in source code (default: chop them)

Notes:   The source code is displayed with highlighted ECHOed text,
         comments, quoted strings, redirection, parenthesis and variables.
         A warning message will be displayed if code errors were found.
         Warning messages in the source code are chopped by default, and
         repeated again (wrapped) at the end of the source code.
         A non-zero return code means something was wrong, either on
         the command line or in the source code. A return code greater
         than 1 indicates the last line where an error was detected.
         This program is based on regular expressions, it does not interpret
         the source code; hence false positives cannot be prevented entirely.
         My motto when writing this program was "I'd rather have 10 false
         positives than 1 missed error".
         Use common sense when evaluating the warnings and error messages.

Written by Rob van der Woude

page last uploaded: 2022-10-05