Repository navigation
feat: add DBC_FILE_NAME + ver, proper code formatting - #131
Merged
Merged
Conversation
Instead of a comment at the top, generate usable constants: ```rust pub const DBC_FILE_NAME: &str = "filename"; pub const DBC_FILE_VERSION: &str = "1.0"; ``` Use token parser and `prettyplease` code formatter to generate stable code output. This also allows us to migrate to syn/quote-based code generation in the future, rather than rely on text manipulation.
There was a problem hiding this comment.
Pull request overview
This PR replaces the comment-based file metadata header with usable constants and implements proper code formatting using prettyplease and syn for stable output generation.
Changes:
- Replaced top-of-file comments with
DBC_FILE_NAMEandDBC_FILE_VERSIONconstants - Integrated
prettypleasefor consistent code formatting - Added
synandprettypleasedependencies to enable token-based parsing and formatting
Reviewed changes
Copilot reviewed 53 out of 98 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/lib.rs | Replaced comment generation with constant declarations; integrated prettyplease formatting in generate() and write() methods |
| Cargo.toml | Added prettyplease and syn dependencies for code formatting |
| tests-snapshots/dbc-cantools/*.snap.rs | Updated snapshot files showing formatted output with new constants replacing comments |
| tests-snapshots/dbc-cantools/*.snap.stderr | Updated error snapshots reflecting new line numbers after formatting changes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
trnila
approved these changes
Jan 26, 2026
tegimeki
reviewed
Jan 26, 2026
| })?; | ||
|
|
||
| writeln!(w)?; | ||
| let dbc_name = config.dbc_name.escape_default(); |
Member
There was a problem hiding this comment.
What do you think of putting these at the top of the file, before the other imports, with a comment indicating "/// Code generated from DBC file"? Then the future #[doc] usage via quote will still be do-able (it will comment the filename string) and the message appears where it used to, as a warning to someone who might attempt to modify it.
tegimeki
approved these changes
Jan 26, 2026
Merged
nyurik
added a commit
that referenced
this pull request
Sep 22, 2026
## 🤖 New release
* `dbc-codegen`: 0.3.0 -> 0.4.0 (⚠ API breaking changes)
* `dbc-codegen-cli`: 0.3.0 -> 0.4.0
### ⚠ `dbc-codegen` breaking changes
```text
--- failure function_missing: pub fn removed or renamed ---
Description:
A publicly-visible function cannot be imported by its prior path. A `pub use` may have been removed, or the function 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.50.0/src/lints/function_missing.ron
Failed in:
function dbc_codegen::codegen, previously in file /tmp/.tmp0XWOqx/dbc-codegen/src/lib.rs:24
```
<details><summary><i><b>Changelog</b></i></summary><p>
## `dbc-codegen`
<blockquote>
##
[0.4.0](v0.3.0...v0.4.0) -
2026-09-22
### Added
- *(fuzz)* make fuzz compile/run
([#140](#140))
- optional padding bit value
([#184](#184))
- add `DBC_FILE_NAME` + ver, proper code formatting
([#131](#131))
- [**breaking**] streamline DBC code generation and file writing
([#128](#128))
### Fixed
- support large min/max values without precision loss
([#152](#152))
- handle duplicate signal names
([#126](#126))
- handle empty relevant msgs in from_can_message
([#125](#125))
- fix typo
- fix formatting errors
- fix factor/offset not getting applied to 0 for unsigned case
- fix duplicate enum names on multiplex messages
- fix issue where signed signals would be rendered as unsigned
### Other
- 2024 edition, bump deps, minor fixes
([#196](#196))
- [pre-commit.ci] pre-commit autoupdate
([#189](#189))
- *(deps)* bump actions/checkout from 6 to 7 in the
all-actions-version-updates group across 1 directory
([#191](#191))
- Remove unsafe from generated MESSAGE_ID constants
([#194](#194))
- Generate raw signal getters and setters
([#193](#193))
- Support relation attributes in attribute_structs
([#192](#192))
- Generate enum-typed setters and constructors for signals with value
descriptions ([#178](#178))
- Emit MESSAGE_CYCLE_TIME as integer
([#186](#186))
- Generate message size and cycle time consts
([#176](#176))
- Add option to generate typed constants from DBC attributes
([#175](#175))
- update can-dbc
([#181](#181))
- rust ver bump ([#182](#182))
- cleanup clippy, justfile, and proj cleanup
([#180](#180))
- *(deps)* bump the all-cargo-version-updates group across 1 directory
with 4 updates ([#172](#172))
- *(deps)* bump codecov/codecov-action from 6 to 7 in the
all-actions-version-updates group
([#165](#165))
- *(deps)* bump the all-cargo-version-updates group across 1 directory
with 4 updates ([#168](#168))
- *(deps)* bump the all-cargo-version-updates group across 1 directory
with 3 updates ([#163](#163))
- *(deps)* bump the all-cargo-version-updates group with 2 updates
([#161](#161))
- *(deps)* bump the all-cargo-version-updates group across 1 directory
with 2 updates ([#158](#158))
- *(deps)* bump the all-actions-version-updates group across 1 directory
with 2 updates ([#159](#159))
- update expected errors to Rust 1.94
([#153](#153))
- *(deps)* bump the all-cargo-version-updates group across 1 directory
with 2 updates ([#145](#145))
- *(deps)* bump insta from 1.46.2 to 1.46.3 in the
all-cargo-version-updates group
([#143](#143))
- upgrade to rust 1.93 stderr
([#142](#142))
- *(deps)* bump the all-cargo-version-updates group across 1 directory
with 4 updates ([#141](#141))
- [**breaking**] remove main fn from generated code
([#138](#138))
- make many rendering fn methods on config
([#133](#133))
- *(deps)* bump clap from 4.5.54 to 4.5.55 in the
all-cargo-version-updates group
([#134](#134))
- use `quote` crate to handle str escaping
([#132](#132))
- noop - dedup, cleanup, new type abstraction
([#130](#130))
- update shared tests, bump deps, freeze to rust 1.92
([#127](#127))
- *(deps)* bump can-dbc from 8.0.0 to 8.0.1 in the
all-cargo-version-updates group
([#129](#129))
- do not clean lock
- bump dependencies and enable verbose output for release actions
([#120](#120))
- [pre-commit.ci] pre-commit autoupdate
([#119](#119))
- Bump the all-cargo-version-updates group across 1 directory with 2
updates ([#118](#118))
- refactor write functions, improve CI, MSRV
([#116](#116))
- minor code cleanup
([#114](#114))
- generate and compile all .dbc files from test repo
([#113](#113))
- allow generated file to be used with `include!`
([#108](#108))
- Bump the all-cargo-version-updates group across 1 directory with 2
updates ([#111](#111))
- minor justfile fix, editorconfig
([#112](#112))
- Bump actions/cache from 4 to 5 in the all-actions-version-updates
group ([#110](#110))
- OxiBUS onboarding cleanup
([#102](#102))
- run `just fmt` to cleanup imports
([#107](#107))
- Bump the all-cargo-version-updates group across 1 directory with 9
updates ([#106](#106))
- upgrade to can-dbc v8
([#101](#101))
- Bump actions/checkout from 1 to 6 in the all-actions-version-updates
group ([#104](#104))
- *(CI)* minor CI updates, automate dependabot
([#103](#103))
- Add optional defmt::Format support for generated types
- Merge pull request #85 from inomotech-foss/fix-mux-msg-id
- Use message name instead of self
- Generate embedded_can::Frame trait for each frame
- Represent CAN message IDs as embedded_can::Id to support extended IDs
- Fix issue with decoding signed values of non-standard length
- revert change to Cargo.toml, not necessary
- address clippy's concerns (thanks clippy), enhance comments
- make can-messages dependency optional so it doesn't pull in std
- reduce diff against main
- handle more edge cases, use i128 as the maximum type
- reorder lines to match signals
- drop symlink in favor of copy so it works on Windows
- revert because I missed the case of check_ranges being false
- add tests, edge cases where the min/max is way less than signal width
- clean up warning
- add unsigned to the name, add test case
- change signal logic to handle negative factors, add tests
- Bump rustc to latest stable, 1.78
- Merge pull request #68 from projectgus/tweaks/codegen_warnings
- Rename .envrc for non-Nix users, add note in README
- dont assign signed integers to unsigned integers
- Update README
- Fix clippy warnings
- Use checked_sub(offset) for set_signal methods
- Don't treat signals as floats if factor is integer
- Add flag to impl std Error
- Tweak docs and optional features
- Make feature-gated impls configurable
</blockquote>
## `dbc-codegen-cli`
<blockquote>
##
[0.4.0](v0.3.0...v0.4.0) -
2026-09-22
### Added
- [**breaking**] streamline DBC code generation and file writing
([#128](#128))
### Other
- 2024 edition, bump deps, minor fixes
([#196](#196))
- Generate raw signal getters and setters
([#193](#193))
- Support relation attributes in attribute_structs
([#192](#192))
- Generate message size and cycle time consts
([#176](#176))
- Add option to generate typed constants from DBC attributes
([#175](#175))
- cleanup clippy, justfile, and proj cleanup
([#180](#180))
- *(deps)* bump the all-cargo-version-updates group with 2 updates
([#161](#161))
- minor code cleanup
([#114](#114))
- allow generated file to be used with `include!`
([#108](#108))
- OxiBUS onboarding cleanup
([#102](#102))
- run `just fmt` to cleanup imports
([#107](#107))
- Bump the all-cargo-version-updates group across 1 directory with 9
updates ([#106](#106))
- upgrade to can-dbc v8
([#101](#101))
- make debug_prints configurable
- Merge pull request #68 from projectgus/tweaks/codegen_warnings
- Rename .envrc for non-Nix users, add note in README
- Update README
- Make feature-gated impls configurable
</blockquote>
</p></details>
---
This PR was generated with
[release-plz](https://github.com/release-plz/release-plz/).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Instead of a comment at the top, generate usable constants:
Use token parser and
prettypleasecode formatter to generate stable code output. This also allows us to migrate to syn/quote-based code generation in the future, rather than rely on text manipulation.Note that this re-generates all expected code files, but the changes are minor - mostly a few newlines, minor formatting, and the two new constants from above.