Crate rslint_core

The core runner for RSLint responsible for the bulk of the linter's work.

The crate is not RSLint-specific and can be used from any project. The runner is responsible for taking a list of rules, and source code and running the linter on it. It is important to decouple the CLI work and the low level linting work from eachother to be able to reuse the linter facilities. Therefore, the core runner should never do anything rslint_cli-specific.

The structure at the core of the crate is the CstRule and Rule traits. CST rules run on a single file and its concrete syntax tree produced by rslint_parser. The rules have a couple of restrictions for clarity and speed, these include:

• all cst rules must be Send and Sync so they can be run in parallel
• rules may never rely on the results of other rules, this is impossible because rules are run in parallel
• rules should never make any network or file requests

Using the runner

To run the runner you must first create a CstRuleStore, which is the structure used for storing what rules to run. Then you can use lint_file.

Running a single rule

To run a single rule you can find the rule you want in the groups module and submodules within. Then to run a rule in full on a syntax tree you can use run_rule.

Rules can also be run on individual nodes using the functions on CstRule. ⚠️ note however that many rules rely on checking tokens or the root and running on single nodes may yield incorrect results, you should only do this if you know about the rule's implementation.

Modules

autofix	Automatic rule fixing utilities
directives	Directives used to configure or ignore rules. These take place of comments over nodes or comments at the top level.
groups	All of the groups of built in rules in the linter.
rule_prelude	Commonly used items by rules. These include some AST definitions, and utilities.
util	General utilities to make linting easier.

Macros

declare_lint	A macro to easily generate rule boilerplate code.
group	Macro for easily making a rule group hashmap. This will call ::new() on each rule.
rule_tests	A macro for generating linter rule tests.

Structs

CstRuleStore	A utility structure for housing CST rules for a linting run.
Diagnostic	A diagnostic message that can give information like errors or warnings.
Directive	A command given to the linter by an inline comment. A single command may include multiple commands inside of it. A directive constitutes a single comment, which may have one or more commands inside of it.
DirectiveParser
LintResult	The result of linting a file.
RuleCtx	Context given to a rule when running it.
RuleResult	The result of running a single rule on a syntax tree.

Enums

Outcome	The overall result of running a single rule or linting a file.
RuleLevel	The level configured for a rule.
Severity	A severity level for diagnostic messages.

Traits

CstRule	The main type of rule run by the runner. The rule takes individual nodes inside of a Concrete Syntax Tree and checks them. It may also take individual syntax tokens. Rule must be all be Send + Sync, because rules are run in parallel.
Rule	A generic trait which describes things common to a rule regardless on what they run on.
Span	A value which can be used as the range inside of a diagnostic.

Functions

apply_top_level_directives	Apply file level directives to a store and add their respective diagnostics to the pool of diagnostics. for file level ignores this will clear all the rules from the store.
get_group_rules_by_name	Get a group's rules by the group name.
get_rule_by_name	Get a rule by its kebab-case name.
get_rule_suggestion	Get a suggestion for an incorrect rule name for things such as "did you mean ...?"
lint_file	Lint a file with a specific rule store.
run_rule	Run a single run on an entire parsed file.