Crate libscilo 

Modules

config 🔒

Parsing configuration files and representing them internally.

fs 🔒

lints 🔒

The collection of lints to run.

version_control 🔒

This module contains functions and structures related to different version control systems. See SupportedVCS for which systems are supported.

Structs

ConfigFile

A temporary structure used to parse configuration files within a directory.

InstantiatedConfig

The internal representation of all the important files, directories, and lints to check.

RootDirs

Expected top-level directories to organize the project folder.

Enums

ConfigError

Errors that can be raised during the parsing of a ConfigFile.

LintCheck

The linting checks that are currently supported.

LintError

Errors resulting from lint checks that have failed.

ProjectPathError

Errors that occur when attempting to normalize paths within the project directory.

Constants

DEFAULT_CONFIG_TEXT

Functions

find_config_paths

Find all configuration files available to be parsed.

parse_all_config_files

Find and parse all relevant configuration files for the current invocation.

project_config_path

The path of the project-specific configuration

project_path

Normalize paths to be relative to the project_root().

project_root

Determine the project root folder.

user_config_path

The path of the user-specific configuration