rust-lang / rust-lang/rust-clippy

New clippy::cargo-toml lint category

Open
#6,431 9 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

A-lint T-cargo
Dominant language
Rust
Stars
13.5k
Forks
2.2k
Avg merge
2d 10h
Merged PRs (30d)
32

Description

What it does

Lints the Cargo.toml manifest file and make sure everything is alright.

Lints
  • Cargo.toml — file is missing.
  • Cargo.toml — file is misnamed, maybe "cargo.toml or "CARGO.toml", etc
  • package.name — contains characters not allowed
  • package.version — does not follow semantic versioning
  • package.authors — at least one author required
  • package.edition — is unknown
  • package.documentation — is http not https
  • package.readme — file no found
  • package.homepage — is http not https
  • package.repository — is http not https
  • package.license — is not a SPDX 2.1 license expression
  • package.license-file — file not found
  • package.keywords — contains invalid letters
  • package.keywords — exceeds 5 keywords
  • package.categories — exceed 5 categories
  • package.categories — the category does not exist
  • package.build — file not found
  • package.foo — unknown field
  • features — feature name starts with "use-", "using-" or "with-"
  • chapters are in the wrong order
  • fields are in the wrong order
  • dependencies are not sorted alphabetically

https://doc.rust-lang.org/cargo/reference/manifest.html

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no repository files or tests. Start with the linked Cargo manifest reference, then narrow the proposed checks into an agreed scope for the new lint category. Done should mean the selected manifest validations, including their diagnostics and coverage, are clearly defined and implemented.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.