chore!: rename `DBC`→`Dbc` and feature `with-serde`→`serde` #42

nyurik · 2025-10-04T23:50:39Z

add a new serde feature and deprecate the with-serde feature, per clippy recommendation
rename DBC to Dbc struct, per conventions

Copilot

Pull Request Overview

This PR addresses minor clippy warnings and linting issues in the codebase. The changes focus on fixing spelling errors, improving documentation formatting, and refactoring feature configurations to comply with clippy recommendations.

Fixed spelling and formatting issues in comments and documentation
Refactored Cargo.toml feature configuration to address clippy::redundant_feature_names warning
Updated clippy lint configuration to be more selective about allowed warnings

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File	Description
src/parser.rs	Fixed spelling error in comment and improved documentation formatting for C_identifier function
src/lib.rs	Added TODO comment and clippy allow attribute for DBC struct naming
README.md	Added backticks around feature names in markdown list for better formatting
Cargo.toml	Refactored feature configuration and updated clippy lint settings

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

codecov · 2025-10-04T23:51:25Z

Codecov Report

❌ Patch coverage is 94.11765% with 1 line in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/lib.rs	93.33%	1 Missing ⚠️

📢 Thoughts on this report? Let us know!

tegimeki

Looks good, works for me

tegimeki · 2025-10-18T12:55:00Z

src/lib.rs

 }

 #[derive(Clone, Debug, PartialEq, Getters, Serialize, Deserialize)]
+// TODO: consider renaming to `Dbc`


This would be more aligned with convention

thx, renamed

## 🤖 New release * `can-dbc`: 6.0.0 -> 7.0.0 (⚠ API breaking changes) ### ⚠ `can-dbc` breaking changes ```text --- failure enum_struct_variant_field_added: pub enum struct variant field added --- Description: An enum's exhaustive struct variant has a new field, which has to be included when constructing or matching on this variant. ref: https://doc.rust-lang.org/reference/attributes/type_system.html#the-non_exhaustive-attribute impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.43.0/src/lints/enum_struct_variant_field_added.ron Failed in: field name of variant ValueDescription::Signal in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:544 field name of variant ValueDescription::EnvironmentVariable in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:548 field name of variant Comment::Node in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:458 field id of variant Comment::Message in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:462 field name of variant Comment::Signal in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:467 field name of variant Comment::EnvVar in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:471 --- failure enum_struct_variant_field_missing: pub enum struct variant's field removed or renamed --- Description: A publicly-visible enum has a struct variant whose field is no longer available under its prior name. It may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.43.0/src/lints/enum_struct_variant_field_missing.ron Failed in: field signal_name of variant ValueDescription::Signal, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:597 field env_var_name of variant ValueDescription::EnvironmentVariable, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:601 field node_name of variant Comment::Node, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:503 field message_id of variant Comment::Message, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:507 field signal_name of variant Comment::Signal, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:512 field env_var_name of variant Comment::EnvVar, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:516 --- failure enum_variant_added: enum variant added on exhaustive enum --- Description: A publicly-visible enum without #[non_exhaustive] has a new variant. ref: https://doc.rust-lang.org/cargo/reference/semver.html#enum-variant-new impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.43.0/src/lints/enum_variant_added.ron Failed in: variant AttributeValue:U64 in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:426 variant AttributeValue:I64 in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:427 variant AttributeValue:Double in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:428 variant AttributeValue:String in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:429 variant AttributeValuedForObjectType:Raw in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:394 variant AttributeValuedForObjectType:NetworkNode in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:395 variant AttributeValuedForObjectType:MessageDefinition in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:396 variant AttributeValuedForObjectType:Signal in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:397 variant AttributeValuedForObjectType:EnvVariable in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:398 variant EnvType:Float in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:351 variant EnvType:U64 in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:352 variant EnvType:Data in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:353 variant AccessNode:VectorXXX in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:381 variant AccessNode:Name in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:382 variant AttributeValueType:Int in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:404 variant AttributeValueType:Hex in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:405 variant AttributeValueType:Float in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:406 variant AttributeValueType:String in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:407 variant AttributeValueType:Enum in /tmp/.tmpLGhgsa/can-dbc/src/lib.rs:408 --- failure enum_variant_missing: pub enum variant removed or renamed --- Description: A publicly-visible enum has at least one variant that is no longer available under its prior name. It may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.43.0/src/lints/enum_variant_missing.ron Failed in: variant AttributeValue::AttributeValueU64, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:468 variant AttributeValue::AttributeValueI64, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:469 variant AttributeValue::AttributeValueF64, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:470 variant AttributeValue::AttributeValueCharString, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:471 variant AttributeValueType::AttributeValueTypeInt, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:444 variant AttributeValueType::AttributeValueTypeHex, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:445 variant AttributeValueType::AttributeValueTypeFloat, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:446 variant AttributeValueType::AttributeValueTypeString, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:447 variant AttributeValueType::AttributeValueTypeEnum, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:448 variant AttributeValuedForObjectType::RawAttributeValue, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:434 variant AttributeValuedForObjectType::NetworkNodeAttributeValue, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:435 variant AttributeValuedForObjectType::MessageDefinitionAttributeValue, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:436 variant AttributeValuedForObjectType::SignalAttributeValue, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:437 variant AttributeValuedForObjectType::EnvVariableAttributeValue, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:438 variant EnvType::EnvTypeFloat, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:387 variant EnvType::EnvTypeu64, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:388 variant EnvType::EnvTypeData, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:389 variant AccessNode::AccessNodeVectorXXX, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:420 variant AccessNode::AccessNodeName, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:421 --- failure feature_missing: package feature removed or renamed --- Description: A feature has been removed from this package's Cargo.toml. This will break downstream crates which enable that feature. ref: https://doc.rust-lang.org/cargo/reference/semver.html#cargo-feature-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.43.0/src/lints/feature_missing.ron Failed in: feature serde_derive in the package's Cargo.toml --- failure inherent_method_missing: pub method removed or renamed --- Description: A publicly-visible method or associated fn is no longer available under its prior name. It may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.43.0/src/lints/inherent_method_missing.ron Failed in: Message::message_id, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:525 Message::message_name, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:525 Message::message_size, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:525 AttributeValueForObject::attribute_name, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:570 AttributeValueForObject::attribute_value, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:570 ValDescription::a, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:451 ValDescription::b, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:451 AttributeDefault::attribute_name, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:563 AttributeDefault::attribute_value, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:563 Signal::signal_size, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:294 SignalType::signal_type_name, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:392 SignalGroups::signal_group_name, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:615 EnvironmentVariable::env_var_name, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:537 EnvironmentVariable::env_var_type, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:537 ValueTable::value_table_name, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:475 ValueTable::value_descriptions, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:475 --- failure struct_missing: pub struct removed or renamed --- Description: A publicly-visible struct cannot be imported by its prior path. A `pub use` may have been removed, or the struct itself may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.43.0/src/lints/struct_missing.ron Failed in: struct can_dbc::DBC, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:642 --- failure struct_pub_field_missing: pub struct's pub field removed or renamed --- Description: A publicly-visible struct has at least one public field that is no longer available under its prior name. It may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.43.0/src/lints/struct_pub_field_missing.ron Failed in: field signal_size of struct Signal, previously in file /tmp/.tmpBTmaKo/can-dbc/src/lib.rs:300 ``` <details><summary>Changelog</summary> <blockquote> ## [7.0.0](v6.0.0...v7.0.0) - 2025-10-18 ### Added - [**breaking**] support cp1252, rm `from_slice`, improve README examples ([#44](#44)) ### Other - [**breaking**] major struct and enum naming refactoring ([#45](#45)) - update README with usage examples and license information ([#46](#46)) - [**breaking**] rename `DBC`→`Dbc` and feature `with-serde`→`serde` ([#42](#42)) - move tests to the end ([#43](#43)) - relicense as `MIT OR Apache-2.0` ([#38](#38)) - auto-release and `cargo deny` ([#39](#39)) - move test files to submodule, default with serde feature ([#40](#40)) - upload coverage reports - update README to oxibus org ([#37](#37)) - allow space after message ID ([#25](#25)) - upgrade to nom 8 ([#36](#36)) - add automatic validation with precommit on CI side ([#30](#30)) - *(ci)* modernize CI ([#33](#33)) - cleanup a few clippy lints - consolidate docs with readme - use `insta` to test all parsing results - use `clap-derive` in example - run `cargo fmt` - bump dependencies and minor cleanup - Simplify tests, test for other escaped characters - Remove obsolete is_quote function - Add support for escaped strings within comments - Also derive the Deserialize trait when serde is enabled </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/).

nyurik requested review from Copilot and tegimeki October 4, 2025 23:50

Copilot AI reviewed Oct 4, 2025

View reviewed changes

nyurik changed the title ~~chore: more minor clippy fixes~~ chore: new serde feature instead of deprecated with-serde Oct 4, 2025

tegimeki approved these changes Oct 18, 2025

View reviewed changes

chore: more minor clippy fixes

8ac2a51

nyurik force-pushed the clippy2 branch from d294555 to 8ac2a51 Compare October 18, 2025 15:16

nyurik changed the title ~~chore: new serde feature instead of deprecated with-serde~~ chore: rename DBC→Dbc and feature with-serde→serde Oct 18, 2025

nyurik changed the title ~~chore: rename DBC→Dbc and feature with-serde→serde~~ chore!: rename DBC→Dbc and feature with-serde→serde Oct 18, 2025

rename DBC to Dbc

85ce86d

nyurik force-pushed the clippy2 branch from 8921394 to 85ce86d Compare October 18, 2025 15:22

nyurik merged commit 28b4f51 into oxibus:main Oct 18, 2025
8 checks passed

nyurik deleted the clippy2 branch October 18, 2025 15:23

nyurik mentioned this pull request Oct 18, 2025

chore: release v7.0.0 #41

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore!: rename `DBC`→`Dbc` and feature `with-serde`→`serde` #42

chore!: rename `DBC`→`Dbc` and feature `with-serde`→`serde` #42

Uh oh!

nyurik commented Oct 4, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

codecov bot commented Oct 4, 2025 •

edited

Loading

Uh oh!

tegimeki left a comment

Uh oh!

tegimeki Oct 18, 2025

Uh oh!

nyurik Oct 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

chore!: rename DBC→Dbc and feature with-serde→serde #42

chore!: rename DBC→Dbc and feature with-serde→serde #42

Uh oh!

Conversation

nyurik commented Oct 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

codecov bot commented Oct 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

tegimeki left a comment

Choose a reason for hiding this comment

Uh oh!

tegimeki Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

nyurik Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

chore!: rename `DBC`→`Dbc` and feature `with-serde`→`serde` #42

chore!: rename `DBC`→`Dbc` and feature `with-serde`→`serde` #42

nyurik commented Oct 4, 2025 •

edited

Loading

codecov bot commented Oct 4, 2025 •

edited

Loading