Quickstart
-
Lint the workspace
Terminal window skif # the workspace or package containing the current directoryskif path/to/pkg # the nearest ancestor workspace that lists it, else the package itselfskif -r # every workspace and standalone package at or below the current directoryA package needs no workspace to be linted. Run
skifat the top of a repository of independent projects, or pass-r, to lint all of them in one run. -
Write a starter configuration
Terminal window skif initskif initwrites a commentedskif.tomlwith a#:schemadirective, so editors with Taplo or Even Better TOML validate and complete the file. It refuses to overwrite an existing configuration. -
Apply fixes
Terminal window skif --fix # safe fixes, lint again, then run the package manager's installskif --fix-unsafe # also apply unsafe fixesskif --fix --dry-run # print the planned changes as a diff; writes nothing--fixis refused whenCIis truthy, unless--dry-runis set. Pass--no-installto skip the install step. -
Tune rules
Terminal window skif --rule unsorted-dependencies=off --fail-on-warningsskif rules # list every rule -
Run it in CI
- uses: actions/checkout@v7- uses: polylint/skif@v0.8with:fail-on-warnings: true
Output formats
Section titled “Output formats”skif --format json # one JSON document on stdoutskif --format sarif --output skif.sarif # code scanningskif --format github # workflow annotationsskif --format codeclimate --output gl-code-quality.json # GitLab Code Qualityskif --format markdown # a pull request commentskif --format compact # one line per finding