Home

Welcome to the SwaLint wiki!

What is SwaLint?

SwaLint is a code critics tool for Smalltalk projects. It provides you over 150 different rules from ten different categories, that will lint your code to make it easier for you to find defects and code smells, give you an overview over your software system and its metrics to increase the overall code quality.

How can I install it?

There are two ways of installing the latest release. You can either use a SAR file or Metacello.

SAR file

Go to the latest release of SwaLint, download the .sar file, drag and drop it into your image and choose "install SAR".

Metaclleo

1. Make sure you have metacello-work installed.
2. Load the project with (it might ask you to click "Proceed" several times):

[Metacello new
  baseline: 'SwaLint';
  repository: 'github://hpi-swa-teaching/SwaLint:release/packages';
  get;
  load: #default]
    on: MetacelloSkipDirtyPackageLoad
    do: [:e | e resume: false]

How do I use it?

Click Apps > SwaLint Code Critis and the overview window will open. On the left you will see all Categories you can choose from. If you select one, the corresponding classes will be added in the middle window. The Classes you select here are those, which will be linted. The Rules for the linting can be chosen on the right. In the top right corner you will see the Linter Rules Categories you can choose from, among them you will find the concrete Linter Rules. If you select one you will see its description in the right bottom corner. If you have made your selection you can choose whether you want to make a one time linting by clicking the Run Selected button or configure the linter to run on every code change by clicking Start AutoLinting that will show a defects-overview inspired by the Test Auto Runner. Furthermore you will find plenty of configuration options when clicking the Options button. You can primarily set thresholds and enabled/disable the appearance of extra rules.

How can I contribute?

What are our plans for the future?