dylint_linting
This crate provides macros for creating Dylint libraries, and utilities for creating configurable libraries.
Contents
dylint_library!
declare_late_lint!
,declare_early_lint!
,declare_pre_expansion_lint!
impl_late_lint!
,impl_early_lint!
,impl_pre_expansion_lint!
- Configurable libraries
dylint_library!
The dylint_library!
macro expands to the following:
extern crate rustc_driver;
pub extern "C"
If your library uses the dylint_library!
macro and the dylint-link
tool, then all you
should have to do is implement the register_lints
function. See the examples in this
repository.
declare_late_lint!
, etc.
If your library contains just one lint, using declare_late_lint!
, etc. can make your code more
concise. Each of these macros requires the same arguments as declare_lint!
, and wraps the
following:
- a call to
dylint_library!
- an implementation of the
register_lints
function - a call to
declare_lint!
- a call to
declare_lint_pass!
For example, declare_late_lint!(vis NAME, Level, "description")
expands to the following:
!;
extern crate rustc_lint;
extern crate rustc_session;
declare_lint!;
declare_lint_pass!;
dylint_library
declare_early_lint!
and declare_pre_expansion_lint!
are defined similarly.
impl_late_lint!
, etc.
impl_late_lint!
, etc. are like declare_late_lint!
, etc. except:
- each calls
impl_lint_pass!
instead ofdeclare_lint_pass!
; - each requires an additional argument to specify the value of the lint's
LintPass
structure.
That is, impl_late_lint!
's additional argument is what goes here:
lint_store.register_late_pass;
^^^
An example use of impl_pre_expansion_lint!
can be found in env_cargo_path
in this
repository.
Configurable libraries
Libraries can be configured by including a dylint.toml
file in the target workspace's root
directory. This crate provides the following functions for reading and parsing dylint.toml
files:
A configurable library containing just one lint will typically have a lib.rs
file of the
following form:
!
// Lint configuration
// Keep a copy of the configuration in the `LintPass` structure.
// Read the configuration from the `dylint.toml` file, or use the default configuration if
// none is present.
impl_late_lint
For a concrete example of a lib.rs
file with this form, see the
non_local_effect_before_error_return
library in this repository.
A library containing more than one lint must implement the register_lints
function without
relying on the above macros. If the library is configurable, then its register_lints
function
should include a call to dylint_linting::init_config
, as in the following example:
Additional documentation on config_or_default
, etc. can be found on docs.rs.