Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve crate manifests, adding missing [package.repository] and [package.description] fields #17745

Merged
merged 9 commits into from
Aug 6, 2024
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ rust-version = "1.78"
edition = "2021"
license = "MIT OR Apache-2.0"
authors = ["rust-analyzer team"]
repository = "https://github.com/rust-lang/rust-analyzer"

[profile.dev]
debug = 1
Expand Down
3 changes: 2 additions & 1 deletion crates/base-db/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "base-db"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "Basic database traits for rust-analyzer. The concrete DB is defined by `ide` (aka `ra_ap_ide`)."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/cfg/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "cfg"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "Conditional compiling options, `cfg` attribute parser and evaluator for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/flycheck/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "flycheck"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "Functionality needed for rust-analyzer to run `cargo` commands in a background thread."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/hir-def/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "hir-def"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "RPC Api for the `proc-macro-srv` crate of rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/hir-expand/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "hir-expand"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "Macro expansion for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/hir-ty/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "hir-ty"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "The type system for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/hir/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "hir"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "A high-level object-oriented access to Rust code for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
2 changes: 1 addition & 1 deletion crates/hir/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! HIR (previously known as descriptors) provides a high-level object oriented
//! HIR (previously known as descriptors) provides a high-level object-oriented
//! access to Rust code.
//!
//! The principal difference between HIR and syntax trees is that HIR is bound
Expand Down
3 changes: 2 additions & 1 deletion crates/ide-assists/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "ide-assists"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "Code assists for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/ide-completion/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "ide-completion"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "Utilities for generating completions of user input for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/ide-db/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "ide-db"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "Core data structure representing IDE state for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
2 changes: 1 addition & 1 deletion crates/ide-db/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! This crate defines the core datastructure representing IDE state -- `RootDatabase`.
//! This crate defines the core data structure representing IDE state -- `RootDatabase`.
//!
//! It is mainly a `HirDatabase` for semantic analysis, plus a `SymbolsDatabase`, for fuzzy search.

Expand Down
3 changes: 2 additions & 1 deletion crates/ide-diagnostics/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "ide-diagnostics"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "Diagnostics rendering and fixits for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
4 changes: 2 additions & 2 deletions crates/ide-ssr/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[package]
name = "ide-ssr"
version = "0.0.0"
description = "Structural search and replace of Rust code"
repository = "https://github.com/rust-lang/rust-analyzer"
repository.workspace = true
description = "Structural search and replace of Rust code for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/ide/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "ide"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "IDE-centric APIs for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/intern/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "intern"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "Global `Arc`-based object interning infrastructure for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/limit/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "limit"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "A struct to enforce limits for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/load-cargo/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "load-cargo"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "Loads a Cargo project into a static instance of rust-analyzer for analysis."

rust-version.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/mbe/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "mbe"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "Handling of `macro_rules` macros for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/parser/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "parser"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "The Rust parser for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/paths/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "paths"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "Path wrappers for absolute and relative paths rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/proc-macro-api/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "proc-macro-api"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "RPC Api for the `proc-macro-srv` crate of rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/proc-macro-srv-cli/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "proc-macro-srv-cli"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "A standalone binary for the `proc-macro-srv` crate of rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/proc-macro-srv/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "proc-macro-srv"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "Proc-macro server for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/profile/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "profile"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "A collection of tools for profiling rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/project-model/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "project-model"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "A representation for a Cargo project for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
2 changes: 1 addition & 1 deletion crates/rust-analyzer/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name = "rust-analyzer"
version = "0.0.0"
homepage = "https://rust-analyzer.github.io/"
repository = "https://github.com/rust-analyzer/rust-analyzer"
repository.workspace = true
description = "A language server for the Rust programming language"
documentation = "https://rust-analyzer.github.io/manual.html"
autobins = false
Expand Down
3 changes: 2 additions & 1 deletion crates/span/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "span"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "File and span related types for rust-analyzer."

rust-version.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/stdx/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "stdx"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "Missing batteries for standard libraries for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
4 changes: 2 additions & 2 deletions crates/syntax/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[package]
name = "syntax"
version = "0.0.0"
description = "Comment and whitespace preserving parser for the Rust language"
repository = "https://github.com/rust-lang/rust-analyzer"
repository.workspace = true
description = "Concrete syntax tree definitions for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/test-utils/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "test-utils"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "Assorted testing utilities for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/text-edit/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "text-edit"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "Representation of a `TextEdit` for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/toolchain/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "toolchain"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "Discovery of `cargo` & `rustc` executables for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/tt/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "tt"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "A `TokenTree` data structure for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/vfs-notify/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "vfs-notify"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "Implementation of `loader::Handle` for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down
3 changes: 2 additions & 1 deletion crates/vfs/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "vfs"
version = "0.0.0"
description = "TBD"
repository.workspace = true
description = "A virtual file system for rust-analyzer."

authors.workspace = true
edition.workspace = true
Expand Down