Nate Butler
773ad6bfd1
This PR enables required documentation for the `theme` crate starts on documenting it. The end goal is to have all meaningful documentation in the crate filled out – However I'm not sure that just adding `#![deny(missing_docs)]` to the whole crate is the right approach. I don't know that having 200+ "The color of the _ color" field docs is useful however–In the short term I've excluded some of the modules that contain structs with a ton of fields (`colors, `status`, etc.) until we decide what the right solution here is. Next steps are to clean up the crate, removing unused modules or those with low usage in favor of other approaches. Changes in this PR: - Enable the `deny(missing_docs)` lint for the `theme` crate - Start documenting a subset of the crate. - Enable `#![allow(missing_docs)]` for some modules. Release Notes: - N/A
212 lines
7.8 KiB
Rust
212 lines
7.8 KiB
Rust
#![allow(missing_docs)]
|
|
|
|
use gpui::Hsla;
|
|
use refineable::Refineable;
|
|
|
|
use crate::{blue, grass, neutral, red, yellow};
|
|
|
|
#[derive(Refineable, Clone, Debug)]
|
|
#[refineable(Debug, serde::Deserialize)]
|
|
pub struct StatusColors {
|
|
/// Indicates some kind of conflict, like a file changed on disk while it was open, or
|
|
/// merge conflicts in a Git repository.
|
|
pub conflict: Hsla,
|
|
pub conflict_background: Hsla,
|
|
pub conflict_border: Hsla,
|
|
|
|
/// Indicates something new, like a new file added to a Git repository.
|
|
pub created: Hsla,
|
|
pub created_background: Hsla,
|
|
pub created_border: Hsla,
|
|
|
|
/// Indicates that something no longer exists, like a deleted file.
|
|
pub deleted: Hsla,
|
|
pub deleted_background: Hsla,
|
|
pub deleted_border: Hsla,
|
|
|
|
/// Indicates a system error, a failed operation or a diagnostic error.
|
|
pub error: Hsla,
|
|
pub error_background: Hsla,
|
|
pub error_border: Hsla,
|
|
|
|
/// Represents a hidden status, such as a file being hidden in a file tree.
|
|
pub hidden: Hsla,
|
|
pub hidden_background: Hsla,
|
|
pub hidden_border: Hsla,
|
|
|
|
/// Indicates a hint or some kind of additional information.
|
|
pub hint: Hsla,
|
|
pub hint_background: Hsla,
|
|
pub hint_border: Hsla,
|
|
|
|
/// Indicates that something is deliberately ignored, such as a file or operation ignored by Git.
|
|
pub ignored: Hsla,
|
|
pub ignored_background: Hsla,
|
|
pub ignored_border: Hsla,
|
|
|
|
/// Represents informational status updates or messages.
|
|
pub info: Hsla,
|
|
pub info_background: Hsla,
|
|
pub info_border: Hsla,
|
|
|
|
/// Indicates a changed or altered status, like a file that has been edited.
|
|
pub modified: Hsla,
|
|
pub modified_background: Hsla,
|
|
pub modified_border: Hsla,
|
|
|
|
/// Indicates something that is predicted, like automatic code completion, or generated code.
|
|
pub predictive: Hsla,
|
|
pub predictive_background: Hsla,
|
|
pub predictive_border: Hsla,
|
|
|
|
/// Represents a renamed status, such as a file that has been renamed.
|
|
pub renamed: Hsla,
|
|
pub renamed_background: Hsla,
|
|
pub renamed_border: Hsla,
|
|
|
|
/// Indicates a successful operation or task completion.
|
|
pub success: Hsla,
|
|
pub success_background: Hsla,
|
|
pub success_border: Hsla,
|
|
|
|
/// Indicates some kind of unreachable status, like a block of code that can never be reached.
|
|
pub unreachable: Hsla,
|
|
pub unreachable_background: Hsla,
|
|
pub unreachable_border: Hsla,
|
|
|
|
/// Represents a warning status, like an operation that is about to fail.
|
|
pub warning: Hsla,
|
|
pub warning_background: Hsla,
|
|
pub warning_border: Hsla,
|
|
}
|
|
|
|
pub struct DiagnosticColors {
|
|
pub error: Hsla,
|
|
pub warning: Hsla,
|
|
pub info: Hsla,
|
|
}
|
|
|
|
pub struct GitStatusColors {
|
|
pub created: Hsla,
|
|
pub deleted: Hsla,
|
|
pub modified: Hsla,
|
|
pub renamed: Hsla,
|
|
pub conflict: Hsla,
|
|
pub ignored: Hsla,
|
|
}
|
|
|
|
impl StatusColors {
|
|
pub fn dark() -> Self {
|
|
Self {
|
|
conflict: red().dark().step_9(),
|
|
conflict_background: red().dark().step_9(),
|
|
conflict_border: red().dark().step_9(),
|
|
created: grass().dark().step_9(),
|
|
created_background: grass().dark().step_9(),
|
|
created_border: grass().dark().step_9(),
|
|
deleted: red().dark().step_9(),
|
|
deleted_background: red().dark().step_9(),
|
|
deleted_border: red().dark().step_9(),
|
|
error: red().dark().step_9(),
|
|
error_background: red().dark().step_9(),
|
|
error_border: red().dark().step_9(),
|
|
hidden: neutral().dark().step_9(),
|
|
hidden_background: neutral().dark().step_9(),
|
|
hidden_border: neutral().dark().step_9(),
|
|
hint: blue().dark().step_9(),
|
|
hint_background: blue().dark().step_9(),
|
|
hint_border: blue().dark().step_9(),
|
|
ignored: neutral().dark().step_9(),
|
|
ignored_background: neutral().dark().step_9(),
|
|
ignored_border: neutral().dark().step_9(),
|
|
info: blue().dark().step_9(),
|
|
info_background: blue().dark().step_9(),
|
|
info_border: blue().dark().step_9(),
|
|
modified: yellow().dark().step_9(),
|
|
modified_background: yellow().dark().step_9(),
|
|
modified_border: yellow().dark().step_9(),
|
|
predictive: neutral().dark_alpha().step_9(),
|
|
predictive_background: neutral().dark_alpha().step_9(),
|
|
predictive_border: neutral().dark_alpha().step_9(),
|
|
renamed: blue().dark().step_9(),
|
|
renamed_background: blue().dark().step_9(),
|
|
renamed_border: blue().dark().step_9(),
|
|
success: grass().dark().step_9(),
|
|
success_background: grass().dark().step_9(),
|
|
success_border: grass().dark().step_9(),
|
|
unreachable: neutral().dark().step_10(),
|
|
unreachable_background: neutral().dark().step_10(),
|
|
unreachable_border: neutral().dark().step_10(),
|
|
warning: yellow().dark().step_9(),
|
|
warning_background: yellow().dark().step_9(),
|
|
warning_border: yellow().dark().step_9(),
|
|
}
|
|
}
|
|
|
|
pub fn light() -> Self {
|
|
Self {
|
|
conflict: red().light().step_9(),
|
|
conflict_background: red().light().step_9(),
|
|
conflict_border: red().light().step_9(),
|
|
created: grass().light().step_9(),
|
|
created_background: grass().light().step_9(),
|
|
created_border: grass().light().step_9(),
|
|
deleted: red().light().step_9(),
|
|
deleted_background: red().light().step_9(),
|
|
deleted_border: red().light().step_9(),
|
|
error: red().light().step_9(),
|
|
error_background: red().light().step_9(),
|
|
error_border: red().light().step_9(),
|
|
hidden: neutral().light().step_9(),
|
|
hidden_background: neutral().light().step_9(),
|
|
hidden_border: neutral().light().step_9(),
|
|
hint: blue().light().step_9(),
|
|
hint_background: blue().light().step_9(),
|
|
hint_border: blue().light().step_9(),
|
|
ignored: neutral().light().step_9(),
|
|
ignored_background: neutral().light().step_9(),
|
|
ignored_border: neutral().light().step_9(),
|
|
info: blue().light().step_9(),
|
|
info_background: blue().light().step_9(),
|
|
info_border: blue().light().step_9(),
|
|
modified: yellow().light().step_9(),
|
|
modified_background: yellow().light().step_9(),
|
|
modified_border: yellow().light().step_9(),
|
|
predictive: neutral().light_alpha().step_9(),
|
|
predictive_background: neutral().light_alpha().step_9(),
|
|
predictive_border: neutral().light_alpha().step_9(),
|
|
renamed: blue().light().step_9(),
|
|
renamed_background: blue().light().step_9(),
|
|
renamed_border: blue().light().step_9(),
|
|
success: grass().light().step_9(),
|
|
success_background: grass().light().step_9(),
|
|
success_border: grass().light().step_9(),
|
|
unreachable: neutral().light().step_10(),
|
|
unreachable_background: neutral().light().step_10(),
|
|
unreachable_border: neutral().light().step_10(),
|
|
warning: yellow().light().step_9(),
|
|
warning_background: yellow().light().step_9(),
|
|
warning_border: yellow().light().step_9(),
|
|
}
|
|
}
|
|
|
|
pub fn diagnostic(&self) -> DiagnosticColors {
|
|
DiagnosticColors {
|
|
error: self.error,
|
|
warning: self.warning,
|
|
info: self.info,
|
|
}
|
|
}
|
|
|
|
pub fn git(&self) -> GitStatusColors {
|
|
GitStatusColors {
|
|
created: self.created,
|
|
deleted: self.deleted,
|
|
modified: self.modified,
|
|
renamed: self.renamed,
|
|
conflict: self.conflict,
|
|
ignored: self.ignored,
|
|
}
|
|
}
|
|
}
|