Skip to content

Latest commit

 

History

History
93 lines (70 loc) · 3.32 KB

README.md

File metadata and controls

93 lines (70 loc) · 3.32 KB
Raw

Magik-Lint

A command line linter to use in your workflow. Mostly built after Pylint.

Usage

Magik-lint takes the following command line options:

  • --apply-fixes: Automatically apply fixes, when possible.
  • --column-offset: Column offset, in case your editor uses a different column numbering scheme.
  • --debug: Enable debug logging.
  • --help: Show help.
  • --max-infractions: Maximum number of issues to report.
  • --msg-template: Template for output, defaults to: ${path}:${line}:${column}: ${msg} (${symbol})
  • --rcfile: Path to configuration file
  • --show-checks: Show a list of all checks and whether it is disabled
  • --version: Show version and quit.
  • A file or directory to check (can be multiple).
    • If a file is given, only this file is checked.
    • If a directory is given, all files in this directory and any sub-directories, are checked.

Integration

The emacs magik-mode readily supports integration of magik-tools through flycheck.

VSCode integration is achieved by adding a task with a problemMatcher, for example:

{
    "label": "magik-lint",
    "type": "shell",
    "command": "java -jar /path/to/magik-lint-LATEST.jar --msg-template \"\\${path}:\\${line}:\\${column}:\\${severity}:\\${symbol}:\\${msg}\" --watch .",
    "problemMatcher": {
        "owner": "magik",
        "fileLocation": "relative",
        "pattern": {
            "regexp": "^(.*):(\\d+):(\\d+):(.*):(.*):(.*)$",
            "file": 1,
            "line": 2,
            "column": 3,
            "severity": 4,
            "code": 5,
            "message": 6
        }
    }
}

Configuration

Magik-lint can use a configuration file.

The configuration file is located as follows, in order:

  1. if --rcfile command line argument is given, use it;
  2. if magik-lint.properties exists in the current working directory, use it;
  3. if .magik-lint.properties exists in the current working directory, use it;
  4. if magik-lint.properties exists in the current Smallworld product seen from the current working directory, or any parent product, use it;
  5. if environment variable MAGIKLINTRC is given and the file exists, use it;
  6. if .magik-lint.properties exists in your home directory, use it;
  7. if /etc/magik-lint.properties exists, use it.

If no configuration file is found, defaults are assumed.

The following options are available in the configuration file:

  • enabled=<comma separated list of check-names>
  • disabled=<comma separated list of check-names or all>
  • <check_name>.<check_attribute>=<value>

I.e., you can disable checks method-complexity and line-length by setting:

disabled=method-complexity,line-length

You can configure the line-length check to allow up to 120 characters per line by setting:

line-length.max-line-length=120

Exit codes

The exit code from Magik-lint is determined by the infractions of checks. The severity of a check will set a flag in the return code:

Severity Exit code
Critical 2
Major 4
Minor 8

When using Git, checking flags in the return code allows you to allow minor infractions being committed, but prevent a commit of a major infraction, using Git hooks.