Module derive_adhoc::doc_changelog

Changelog, MSRV policy and cargo features

cargo features

Features are provided to allow for a build with reduced dependencies.

• full: Metafeature. Enable all reasonable, non-experimental, features.
• case: Case conversions, using heck.
• expect: the expect expansion option for syntax checking.
• minimal-1: Minimal feature set. Must be enabled.

All of the above features are enabled by default.

MSRV and MSRV policy

The Minimum Supported Rust Version for derive-adhoc is 1.56.

We expect to increase it cautiously and only with good reason. (However, MSRV increase would be a minor version bump.)

Changelog

This is the changelog for the stable branch 0.8.x. This branch is currently maintained but will not receive new features.

0.8.4

Improved

• Now that derive-deftly is fairly stable, recommend upgrading to it.

0.8.3

Fixed

• Fixed a largely-theoretical concurrency bug which could cause wrong error output if multiple invocations generated identical, but syntactically-invalid, expansions. (!262 / !263).

0.8.2

Improved

• Minor documentation edits, to reflect the existence of derive-deftly, the new name for this crate.

0.8.1

Fixed

• Fix doubled dollar deescaping in precanned d-a macros. Fixes macro_rules! .. { { $$m:expr .. } ... }.

Improved

• Improvements to macro rustdoc documentation.
• Minor internal improvements.

0.8.0

Nominally breaking – transitive for exported templates; minor

We recommend you do not treat these changes as semver-breaking for template-defining crates.

• Reject misplaced #[derive_adhoc] attributes.
• Reject malformed attributes like #[adhoc("42")] and #[adhoc(std::cell::<String>)].

Technically these are breaking changes, since users of exported templates might have provided these wrong attributes, which were previously ignored and are now properly rejected. The attributes are interpreted by the version of derive-adhoc which defines the template. However, the likelihood of this breaking a working build seems low.

MSRV

• MSRV increased from 1.54 to 1.56. Principally because we need this to update to syn 2. 1.56 is the first release with Rust 2021, but we’re not updating to the 2021 edition yet.

Fixed

• Fixed a spurious clippy lint crate_in_macro_def (#27).
• More reasonable handling of #[adhoc(..)] attributes whose meta information has paths some of which are nested sub-paths of others.
• Work around a strange bug with literals and spans which can cause a compiler/fallback mismatch panic during error reporting with some compiler versions. (!182)

Improved

• Docuemntation improvements (notably, many cross-references added from the tutorial to the reference).
• Dependency updates (notably, we’re now using syn 2).
• Improvements to tests, CI, HACKING.md, Cargo lockfile handling.
• Lockfile (Cargo.lock) is now committed to git under that name.

0.7.3

Added

• approx_equal condition, for testing a form of token stream equivalence.

Fixed

• docs: Corrected some internal links to refer to the correct anchors.

Improved

• $ttype, $tdeftype and $vtype no longer include ::<> or <> unless the original toplevel driver definition did.

0.7.2

Added

• ${Xmeta(...)} within pasting now defaults to ... as str, so that doesn’t need to be specified each time.

0.7.1

Fixed

• Fix reference documentation examples for $Xattr.

0.7.0

Breaking

• Reject inner attributes (#![...] and //!...) anywhere in templates: these are now reserve for future expansion. To resolve: use inner attributes instead.

Added

• New ${define } and ${defcond } facility for reuseable template fragments and conditions, to save repetition in templates. (#14)
• Abbreviated $<...> syntax for ${paste ...}. (#23)

Fixed

• Allow nested pasting when intermediate pastes aren’t valid idents.
• Fixed bugs relating to pasting of keywords and raw identifiers.
• docs: Fixed minor bugs in the reference.

0.6.1

Fixed

• Fixed a few broken docs links and similar infelicities.

Improved

• Change dollar-escaping pseudo-keyword to $orig_dollar. (Internal change; should not have any user-visible effect.)

0.6.0

Breaking

• $fvis and fvis now refer to the top-level visibility for enums. (The previous behaviour is now available from $fdefvis/fdefvis.)
• fmeta and vmeta now fail when used outside a field or variant, rather than searching through the whole item. ($fmeta and $vmeta didn’t search and are unchanged.)
• Actually make structs and unions be treated as having one “variant”.
• $tdefgens and $tgens include trailing comma when nonempty, as documented and intended.

Added

• define_derive_adhoc! supports doc comments.
• $fdefvis/fdefvis for the textual visibility of a field.

Fixed

• Reference doc example snippets: many errors corrected.
• Added missing cargo dep on syn/extra-traits.

Improved

• Trailing comma no longer added inside generics in $ttype $vtype.
• Relaxed upper dependency bounds for strum, itertools.
• docs: Reference: example snippets: now tested, and many added.
• docs: Introduction: now has a Table of Contents.

0.5.0

Breaking

• Case changing: non-snake-case keywords for case change instructions abolished (to make room for possible future reservation of non-snake-case keywords as user-defined ones). Change the case of the keyword to snake case.

Improved

• Documentation: tidying and a few more examples.

0.4.0

Breaking

• ${paste } no longer allows non-string literals in its content.
• Invalid literal content within ${paste } is now rejected during parsing, so even if that part of the template isn’t expanded.
• ${Xmeta... as lit} is abolished, in favour of ... as str (which has more consistent semantics).
• ${Xmeta} without as is no longer allowed in ${paste ...}.
• In #[adhoc(attr="VALUE")], now only string literals are allowed.

Added

• ${paste } and ${CASE_CHANGE ...} can now be nested, either (or both) ways round.
• ${Xmeta... as str}, ${Xmeta... as tokens}.

Improved

• Better error messages when ${paste } produces a bad identifier.
• docs: Minor improvements to reference.
• internal: CI tests improved and extended
• internal: cleanups, and internal docs improved.

0.3.0

Breaking

• cargo features introduced. Currently, all enabled by default - no breakage if default features enabled.
  • Case conversion (and heck dependency) now behind case.
  • minimal-1 introduced; it must be enabled.

Added

• Expansion options facility
• expect items, expect expr option, for improved errors when template expands to invalid Rust syntax. (expect cargo feature.)
• for struct, for enum, for union option, for improved errors due to misue of a template.
• dbg option, for dumping template expansions to compiler stderr.
• $dbg_all_keywords keyword, for dumping keyword expansions.
• full and minimal-1 cargo meta features.

Improved

• docs: Much expanded and improved tutorial (still a work in progress).
• docs: Various corrections to reference docs.
• docs: Reference documentation retitled and module renamed.
• error handling: Better messages from certain situations involving multiple (incompatible) derive-adhoc versions.
• tests: Made less fragile (more pinning of test dependencies).
• tests: Improved CI checks on documentation, TODOs, etc.
• internal: new HACKING.md file for helping develop derive-adhoc.

0.2.2

Fixed (future compatibility)

• Pinned dependency from derive-adhoc to derive-adhoc-macros.
• Handling of certain supposedly-future-compatible options fixed. (“future driver options” argument to d_a_t_T).

Improved

• Better error messages with usupported combinations of features with mixed derive-adhoc versions. #10.
• Compatibility with derive-adhoc 0.2.0 tested in CI.

0.2.1

Fixed

• $vpat expansion includes necessary post-field comma. #15.
• Docs typo fixes.

Improved

• docs: Much expanded tutorial (still a work in progress)

0.2.0

Breaking

• $tgens no longer includes defaults for generics.
• $Xattrs by default outputs all attributes except derive-adhoc ones, rather than nothing (breaking bugfix).
• $vmeta for a struct (not enum) processes top-level attributes, rather than imagining that there are no variant/value attributes.
• Fixed hygiene (span) for ${paste }; now it’s consistently that of the template (but disagrees with the hygiene span of $fname).

Added

• $fpatname $vpat $vtype, for value matching and construction
• $fvis $tvis, for visibility (also as booleans)
• is_struct is_union v_is_unit v_is_tuple v_is_named, conditions for driver shape.
• $tdefkwd $tdeftype $tdefvariants $vdefbody $fdefine $tdefgens, for defining derived types,
• $select1, exactly-one conditional
• Support exporting a template to other crates, and $crate expansion for referring to template crate items.
• Support exporting a driver to other crates (rather hazardous).

Fixed

• Do not claim that $ttype includes any leading path elements.
• $ in templates always has proper span for error reporting
• $ is properly escaped in drivers
• $Xmeta can expand to arbitrary tokens from an attribute value

Improved

• docs: New tutorial (still a work in progress)
• docs: Template syntax reference overhauled
• Many other minor improvements
• New tests/examples

0.1.0

• First publicly advertised release. Much important documentation and many important features still missing.

0.0.1

• Initial release to crates.io, not widely advertised.