linter

Run Ruff to lint and optionally auto-fix and reformat the project.


Usage

splent lint [--fix] [--target <target>]...

Examples

Lint everything.

splent lint

Lint and auto-fix + reformat everything.

splent lint --fix

Lint only the CLI.

splent lint --target cli

Fix only the app and its features.

splent lint --fix --target app --target features

Options

Option Description
--fix Auto-fix lint issues and reformat code in one step. Without this flag, the command only reports issues.
--target Scope the run to one or more targets. Repeatable. Defaults to all targets.

Targets

Target Path linted
cli SPLENT CLI source (splent_cli/src/splent_cli)
framework SPLENT Framework source (splent_framework/src/splent_framework)
app Active product source (<product>/src/<product>)
features All installed features (<product>/features/). Symlinks are resolved automatically

Description

Without --fix the command runs the following.

  • ruff check. Reports lint violations
  • ruff format --check. Reports files that need reformatting (without modifying them)

With --fix the command runs the following.

  • ruff check --fix. Fixes auto-fixable lint issues
  • ruff format. Reformats all code

Exits with code 2 if any lint or format check fails, making it suitable for use in CI pipelines.


Back to top

splent. Distributed by an LGPL license v3. Contact us: drorganvidez@us.es