missing_mpl

Crates.iomissing_mpl
lib.rsmissing_mpl
version0.2.0
sourcesrc
created_at2018-04-22 16:21:24.115857
updated_at2020-08-19 19:34:53.116465
descriptionA lint for watching over your project's MPL-2.0 licensed source files.
homepagehttps://github.com/regexident/missing_mpl
repositoryhttps://github.com/regexident/missing_mpl
max_upload_size
id61843
size26,646
Vincent Esche (regexident)

documentation

https://regexident.github.io/missing_mpl

README

missing_mpl

Build Status Downloads Version License

Synopsis

A lint for watching over your project's MPL-2.0 licensed source files.

Motivation

The MPL-2.0 license expects one to add a short license header to each and every file to be covered:

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

Working on a project it is all too easy to forget to add such header to newly created files.

The missing_mpl lint aims to help make sure all relevant source files include such a header.

Getting Started

Add the most recent version of missing_mpl to your build-dependencies in your project's Cargo.toml.

Then add …

#![feature(plugin)]
#![plugin(missing_mpl)]

#![warn(missing_mpl)]

… to your crate's root file (e.g. lib.rs, main.rs).

Once that's done you're all set!

Now all you need to do is run cargo build and watch out for warnings:

"warning: Missing MPL license header in source file."

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MPL-2.0 – see the LICENSE.md file for details.

Commit count: 10

cargo fmt