https://github.com/cooperwalbrun/rust-template

A project template for setting up new Rust 2021 Edition projects with cargo-make/rustfmt/rust-clippy.
https://github.com/cooperwalbrun/rust-template

clippy llvm rust rustfmt template

Last synced: about 1 month ago
JSON representation

A project template for setting up new Rust 2021 Edition projects with cargo-make/rustfmt/rust-clippy.

• Host: GitHub
• URL: https://github.com/cooperwalbrun/rust-template
• Owner: cooperwalbrun
• License: gpl-3.0
• Created: 2021-09-19T15:40:18.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-09-15T00:26:52.000Z (3 months ago)
• Last Synced: 2024-09-15T07:05:37.981Z (3 months ago)
• Topics: clippy, llvm, rust, rustfmt, template
• Language: Rust
• Homepage:
• Size: 104 KB
• Stars: 9
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-ccamel - cooperwalbrun/rust-template - A project template for setting up new Rust 2021 Edition projects with cargo-make/rustfmt/rust-clippy. (Rust)

README

        
# rust-template [![master](https://github.com/cooperwalbrun/rust-template/actions/workflows/master.yml/badge.svg)](https://github.com/cooperwalbrun/rust-template/actions/workflows/master.yml) [![codecov](https://codecov.io/gh/cooperwalbrun/rust-template/branch/master/graph/badge.svg?token=SFH1NL79H4)](https://codecov.io/gh/cooperwalbrun/rust-template)

1. [Checklist](#checklist)

2. [Overview](#overview)

3. [Contributing](#contributing)

## Checklist

>Did you just clone this repository? Here is a checklist of things you should change before you

>start developing!

1. Determine whether to delete the `Cargo.lock` file and add an entry for it to the `.gitignore`.

   The decision to do this will depend on your project's dependency management needs. Refer to

   [this section](https://doc.rust-lang.org/cargo/faq.html#why-have-cargolock-in-version-control) of

   the Rust FAQs for more information about the benefits and drawbacks of making this change.

2. Rename `src/main.rs` to `src/lib.rs` (and remove the `main` function) if your project will *not*

   be an executable binary. Likewise, be sure to remove all mentions of `run` command(s) from the

   `CONTRIBUTING.md` and `Makefile.toml` files.

3. Update other files according to your project's needs (e.g. `Cargo.toml`, `README.md`,

   `CODEOWNERS`, etc).

## Overview

This is a template repository. It comes with support for the following:

* Support for all the items below on both Windows and Linux

* Linting via [rust-clippy](https://github.com/rust-lang/rust-clippy)

* Formatting via [rustfmt](https://github.com/rust-lang/rustfmt)

* Unit testing

* Code coverage analysis and "pretty" coverage reporting via

  [cargo-llvm-cov](https://github.com/taiki-e/cargo-llvm-cov)

* Orchestration of *all of the above* via [cargo-make](https://github.com/sagiegurari/cargo-make)

(see [CONTRIBUTING.md](CONTRIBUTING.md) for details)

This repository also includes other features which are not necessarily specific to Rust, but they

have been added for demonstrative purposes:

* Sample [Codecov](https://app.codecov.io) configuration

* Execution of unit testing-, code coverage-, and Codecov-oriented tasks in an automated fashion via

  [GitHub Actions workflows](https://docs.github.com/en/actions)

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for developer-oriented information.