Skip to content

Conversation

@nwesterhausen
Copy link
Owner

This pull request introduces several significant updates across the workspace, most notably the addition of a new procedural macro crate, workspace dependency consolidation, and improvements to documentation practices. It also updates package editions for consistency, makes minor CLI fixes, and cleans up workflow steps.

Workspace and Dependency Management:

  • Added new workspace members test_util and dfraw_parser_proc_macros in Cargo.toml, and centralized most dependencies using [workspace.dependencies] for easier management and version consistency across crates.
  • Updated individual crate manifests (cli/Cargo.toml, jsonlib/Cargo.toml) to use workspace dependencies, reducing duplication and ensuring alignment of dependency versions. [1] [2]

Procedural Macro Infrastructure:

  • Introduced the new crate dfraw_parser_proc_macros with its own manifest and source files, providing custom derive macros for Cleanable and IsEmpty traits. These macros automate boilerplate for cleaning and emptiness checks on structs, supporting custom attributes for fine-tuned control. [1] [2] [3] [4]

Documentation Improvements:

  • Added DOCUMENTATION_REFERENCE.md, a comprehensive quick-reference guide for documenting the codebase. It covers common patterns, section keywords, linking, and best practices tailored for the Dwarf Fortress context.

Build and Workflow Cleanups:

  • Removed a redundant formatting step for TypeScript files from the clippy.yml GitHub Actions workflow, streamlining CI checks.

Minor Fixes and Updates:

  • Updated the Rust edition for cli and jsonlib crates to 2024 for consistency. [1] [2]
  • Fixed a CLI argument bug by changing RawModuleLocation::Mods to RawModuleLocation::WorkshopMods for the --mods flag, and improved a log message for clarity. [1] [2]

These changes collectively improve code maintainability, documentation quality, and developer experience across the project.

@nwesterhausen nwesterhausen merged commit 211ba06 into main Jan 16, 2026
7 of 9 checks passed
@nwesterhausen nwesterhausen deleted the db-stuff branch January 16, 2026 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants