Skip to content

Commit

Permalink
Prepare clippy_utils for publishing
Browse files Browse the repository at this point in the history
- Add metadata to clippy_utils/Cargo.toml file
- Add clippy_utils README.md file
  • Loading branch information
flip1995 committed Nov 17, 2024
1 parent 8698c31 commit 74b95f2
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
6 changes: 6 additions & 0 deletions clippy_utils/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
name = "clippy_utils"
version = "0.1.84"
edition = "2021"
description = "Helpful tools for writing lints, provided as they are used in Clippy"
repository = "https://github.com/rust-lang/rust-clippy"
readme = "README.md"
license = "MIT OR Apache-2.0"
keywords = ["clippy", "lint", "utils"]
categories = ["development-tools"]

[dependencies]
arrayvec = { version = "0.7", default-features = false }
Expand Down
40 changes: 40 additions & 0 deletions clippy_utils/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# `clippy-utils`

Helpful tools for writing lints, provided as they are used in Clippy.

## Usage

This crate is only guaranteed to build with this `nightly` toolchain:

<!-- begin autogenerated nightly -->
```
nightly-2024-11-14
```
<!-- end autogenerated nightly -->

To use `clippy-utils` in your lint, add the following to your `Cargo.toml`:

```
clippy_utils = "0.1.XY"
```

`XY` is the version of the nightly toolchain above and can be determined with `rustc +nightly-YYYY-MM-DD -V`.

## :warning: Stability :warning:

No stability guarantees are made for this crate! Use at your own risk.

Function signatures can change or be removed without replacement without any prior notice.

## LICENSE

<!-- REUSE-IgnoreStart -->

Copyright 2014-2024 The Rust Project Developers

Licensed under the Apache License, Version 2.0
<[https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)> or the MIT license
<[https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT)>, at your option. Files in the project may
not be copied, modified, or distributed except according to those terms.

<!-- REUSE-IgnoreEnd -->

0 comments on commit 74b95f2

Please sign in to comment.