mirror of
https://github.com/alacritty/alacritty.git
synced 2024-11-18 13:55:23 -05:00
6e1b9d8b25
This replaces the existing `Deserialize` derive from serde with a `ConfigDeserialize` derive. The goal of this new proc macro is to allow a more error-friendly deserialization for the Alacritty configuration file without having to manage a lot of boilerplate code inside the configuration modules. The first part of the derive macro is for struct deserialization. This takes structs which have `Default` implemented and will only replace fields which can be successfully deserialized. Otherwise the `log` crate is used for printing errors. Since this deserialization takes the default value from the struct instead of the value, it removes the necessity for creating new types just to implement `Default` on them for deserialization. Additionally, the struct deserialization also checks for `Option` values and makes sure that explicitly specifying `none` as text literal is allowed for all options. The other part of the derive macro is responsible for deserializing enums. While only enums with Unit variants are supported, it will automatically implement a deserializer for these enums which accepts any form of capitalization. Since this custom derive prevents us from using serde's attributes on fields, some of the attributes have been reimplemented for `ConfigDeserialize`. These include `#[config(flatten)]`, `#[config(skip)]` and `#[config(alias = "alias)]`. The flatten attribute is currently limited to at most one per struct. Additionally the `#[config(deprecated = "optional message")]` attribute allows easily defining uniform deprecation messages for fields on structs.
21 lines
543 B
TOML
21 lines
543 B
TOML
[package]
|
|
name = "alacritty_config_derive"
|
|
version = "0.1.0"
|
|
authors = ["Christian Duerr <contact@christianduerr.com>"]
|
|
license = "MIT/Apache-2.0"
|
|
description = "Failure resistant deserialization derive"
|
|
homepage = "https://github.com/alacritty/alacritty"
|
|
edition = "2018"
|
|
|
|
[lib]
|
|
proc-macro = true
|
|
|
|
[dependencies]
|
|
syn = { version = "1.0.53", features = ["derive", "parsing", "proc-macro", "printing"], default-features = false }
|
|
proc-macro2 = "1.0.24"
|
|
quote = "1.0.7"
|
|
|
|
[dev-dependencies]
|
|
serde_yaml = "0.8.14"
|
|
serde = "1.0.117"
|
|
log = "0.4.11"
|