|Release Date:||24th May, 2019|
MaxCop is a work-in-progress attempt at a BlitzMax source code checker.
Quick Installation Guide
- Extract the contents of the MaxCop zip to a directory.
- Optional Add this directory to your PATH variable (how do I do this on Windows?)
maxcop in your project folder will perform a complete scan of any BMX
maxcop also supports passing one or more files or directories.
maxcop src my_file.bmx
MaxCop searches the current directory for a
Rules can be disabled by including their full name and setting
Rule options can be set in a similar way.
To enable scanning of modules by name, maxcop needs to configured with the correct module paths.
Create a file called "maxcop.ini" in the same directory as maxcop. An example would look something like this (replacing the full paths with ones for your system):
[mod_path] win32 = c:\full\path\to\blitzmax\mods\ linux = /full/path/to/blitzmax/mods/ macos = /full/path/to/blitzmax/mods/
This step is only required if you wish to scan modules by name (e.g. running
maxcop brl.basic) instead of with an absolute path.