Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 

README.md

pedantrs

A Rust linter, purely for educational purposes. It contains the following lints:

  • (WARN) Check that the number of arguments accepted to each function is not excessively large.
  • (WARN) Check that public constants are documented.
  • (WARN) Check that functions don't use overly deep nesting of expressions.
  • (WARN) Check that private functions, traits, impls, modules, enums and structs are documented.

See the modules in src/lints/ for implementation details. For further information see the Rust documentation.

Building

Ensure you are using the nightly build of Rust (required for access to the lint infrastructure), then simply run cargo build in the root directory.

Using

Adding pedantrs, or any compiler plugin, to the build process of your project is a two step process. First, you need to update the project's Cargo.toml file to add pedantrs as a depedency, then you need to enable the plugin at the crate level within your project.

See the demo folder for an example of an application which makes use of the linter. When you build this application pedantrs will be invoked and a series of warnings generated.

About

A Rust linter, purely for educational purposes

Resources

License

Releases

No releases published

Packages

No packages published

Languages

You can’t perform that action at this time.