ktoml
ktoml copied to clipboard
Update all non-major dependencies (except core Kotlin)
This PR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| org.junit.jupiter:junit-jupiter-engine (source) | 5.0.0 -> 5.11.3 |
||||
| org.jetbrains.kotlinx:kotlinx-datetime | 0.6.0 -> 0.6.1 |
||||
| org.ajoberstar.grgit:grgit-core | 5.2.2 -> 5.3.0 |
||||
| io.gitlab.arturbosch.detekt:detekt-gradle-plugin (source) | 1.22.0 -> 1.23.7 |
||||
| org.jetbrains.kotlinx:kotlinx-serialization-core | 1.7.0 -> 1.7.3 |
||||
| com.squareup.okio:okio | 3.9.0 -> 3.9.1 |
Release Notes
Kotlin/kotlinx-datetime (org.jetbrains.kotlinx:kotlinx-datetime)
v0.6.1
- Prohibit parsing non-ASCII digits as numbers in
DateTimeFormat(#405) - More accurately determine which files represent time zones and which don't on Linux and Darwin (#395)
- Fix a regression that occasionally considered the right boundary of a time overlap to be a part of it on Native (#399)
- Introduce various small improvements to the timezone handling on Windows (#390)
- On Linux, allow not having any
/etc/localtimeset, defaulting toTimeZone.UTCas the system time zone (#426)
ajoberstar/grgit (org.ajoberstar.grgit:grgit-core)
v5.3.0
Small release to resolve outstanding issues that I still felt were in scope (given feature freeze, see README for more background).
Breaking Changes
None
Enhancements
- #362 Add
GrgitService#findGrgit()which returns anOptional<Grgit>allowing accessing whether a repo is present or not, rather than throwing likegetGrgit()does.
Fixes
- #391
initIfNoTExistsonGrgitServiceworks now - Update dependencies
Deprecations
None
Compatibility
Tested on the following version:
| Java Version | Gradle Versions |
|---|---|
| 11 | 7.0.2, 7.6.4, 8.0.2, 8.10.2 |
| 17 | 7.3.3, 7.6.4, 8.0.2, 8.10.2 |
| 21 | 8.4, 8.10.2 |
detekt/detekt (io.gitlab.arturbosch.detekt:detekt-gradle-plugin)
v1.23.7
1.23.7 - 2024-09-08
This is a point release for Detekt 1.23.0, built against Kotlin 2.0.10, with fixes for several bugs that got reported by the community.
Notable Changes
- fix(deps): update kotlin monorepo to v2.0.10 - #7517
- Update to Kotlin 2.0.0 #6640
- fix(deps): update kotlin monorepo to v1.9.24 - #7264
- fix(deps): update dependency com.android.tools.build:gradle to v8.5.2 - #7525
- chore(deps): update dependency gradle to v8.10 - #7546
Changelog
- Add basic support for isolated projects to 1.x - #7526
- ExplicitCollectionElementAccessMethod: fix false positive when Map put has 3 arguments - #7563
- BracesOnIfStatements: fix false-positive when chained - #7444
- Add enum entry check in
UndocumentedPublicProperty- #7426 - Use the anchor which is already present before - #7423
- Fix small corner-case in "SerialVersionUIDInSerializableClass" rule, … - #7346
- SwallowedException: fix false positive when exception is used as a receiver - #7288
- NamedArguments: fix false positive on spread varargs - #7283
- MultilineLambdaItParameter: fix false negative with single statement on multiple lines - #7221
- Check for root of receiver in selector expression - #7220
- Check for
public companionobject forUndocumentedPublicClass- #7219 - fix: TopLevelPropertyNaming also detecting extension property name - #7212
- Publish detekt-compiler-plugin-all to Maven and GH Releases - #7179
- versioned default detekt config file link - #7161
- Support rangeUntil operator for UnusedImport rule - #7104
- Fix false positive on it usages when type parameter is specified - #6850
Housekeeping/Docs
- [bugfix] AnnotationOnSeparateLine in snippets - #6526
- Add docs about using the Compiler Plugin with the Kotlin CLI compiler - #7184
v1.23.6
1.23.6 - 2024-03-23
This is a point release for Detekt 1.23.0, where we added support for Kotlin 1.9.23 and fixed several bugs that got reported by the community.
Changelog
- UselessPostfixExpression - Fix #7037 false positive postfix - #7084
- Don't allow invalid Source Locations - #7030
- UnusedPrivateClass: don't report if private classes are used for type conversion - #6995
- RedundantSuspendModifier: do not report when the function has 'actual' modifier - #6951
- Update dependency gradle to v8.7 - #7080
- Update kotlin monorepo to v1.9.23 - #7027
- Update dependency gradle to v8.6 - #6939
- Update dependency com.android.tools.build:gradle to v8.3.1 - #7070
Contributors
We would like to thank the following contributors that made this release possible: @BraisGabin, @psuzn, @t-kameyama.
v1.23.5
This is a point release for Detekt 1.23.0, where we added support for Kotlin 1.9.22 and fixed several bugs that
got reported by the community.
Notable Changes
- Test Gradle plugin with AGP 8.2.0 - #6672
- chore(deps): update dependency gradle to v8.5 - #6663
- fix(deps): update kotlin monorepo to v1.9.22 - #6746
Changelog
- Report rule's default severity in sarif backport - #6916
- Add ignoreAnnotatedFunctions to TooManyFunctions - #6875
- Fix by checking the existence of label in previous statements - #6671
- Also check
USELESS_ELVISinUnreachableCode- #6624 - Fix by adding last method call to the set - #6567
Housekeeping & Refactorings
- Opt in to ExperimentalCompilerApi in all compilations in compiler-plugin - #6534
Contributors
We would like to thank the following contributors that made this release possible: @3flex, @TWiStErRob, @atulgpt, @matejdro
v1.23.4
1.23.4 - 2023-11-26
This is a point release for Detekt 1.23.0, where we added support for Kotlin 1.9.21 and fixed several bugs that
got reported by the community.
Notable Changes
- fix(deps): update kotlin monorepo to v1.9.21 - #6642
- fix(deps): update kotlin monorepo to v1.9.20 - #6572
Changelog
- Update the ruleset regex to allow numbers - #6635
- Show deprecation message - #6614
- Add io.gitlab.arturbosch.detekt.generator.Main to the jar manifest - #6613
- Don't report FunctionNaming when the function's name equals to the return type's name with type arguments - #6605
- Fix issues related to kotlin-stdlib's Gradle module metadata in Kotlin 1.9.20 - #6590
- MethodSignature - Add the condition of receiver should be null - #6570
- Remove check for deprectated functions toUpperCase and toLowerCase - #6548
- Fixes false positive of trailing whitespaces in kdoc - #6370
Dependency Updates
- Update tested AGP version to 8.1.3 - #6610
- Switch to kctfork for Kotlin compilation testing - #6589
Contributors
We would like to thank the following contributors that made this release possible: @3flex, @BraisGabin, @Gosunet, @atulgpt, @t-kameyama
v1.23.3
1.23.3 - 2023-10-31
This is a point release for Detekt 1.23.0, where we added support for Kotlin 1.9.10 and fixed several bugs that
got reported by the community.
NOTE: This is a republishing of 1.23.2 which was accidentally published against Kotlin 1.9.0 instead of 1.9.10
Changelog
- Consider deprecated rules as inactive when running allRules #6381
- Fix inputstream leaking file descriptor in Gradle - #6519
- ForbiddenMethodCall - Handle sequence of overridden methods - #6478
- Function to return supported Kotlin version - #6472
- Fix false negative
IgnoredReturnValuewith scope functions - #6446 - UnconditionalJumpStatementInLoop: don't report a conditional break in a single body expression - #6443
- Fix reporting unused imports at file level - #6390
- OutdatedDocumentation - Detect param which private property documented as property - #6372
- NullableToStringCall: fix false negative in lambda - #6352
- Correctly set scheme for URIs in the SARIF report output - #6331
- SleepInsteadOfDelay - Find the parent for suspend check - #6191
Dependency Updates
- Update kotlin monorepo to v1.9.10 - #6423
- Update dependency gradle to v8.4 - #6522
- Update dependency gradle to v8.3 - #6406
- Update com.android.tools.build to 8.1.1 - #6419
- update dependency org.jetbrains.dokka to v1.9.10 - #6549
Contributors
We would like to thank the following contributors that made this release possible: @3flex, @arturbosch, @atulgpt, @kkocel, @marschwar, @pablobaxter, @t-kameyama
v1.23.2
1.23.2 - 2023-10-29
NOTE: Please use version 1.23.3 instead - Version 1.23.2 was accidentally built against Kotlin 1.9.0 instead of 1.9.10 https://github.com/detekt/detekt/releases/tag/v1.23.3
This is a point release for Detekt 1.23.0, where we added support for Kotlin 1.9.10 and fixed several bugs that
got reported by the community.
Changelog
- Consider deprecated rules as inactive when running allRules #6381
- Fix inputstream leaking file descriptor in Gradle - #6519
- ForbiddenMethodCall - Handle sequence of overridden methods - #6478
- Function to return supported Kotlin version - #6472
- Fix false negative
IgnoredReturnValuewith scope functions - #6446 - UnconditionalJumpStatementInLoop: don't report a conditional break in a single body expression - #6443
- Fix reporting unused imports at file level - #6390
- OutdatedDocumentation - Detect param which private property documented as property - #6372
- NullableToStringCall: fix false negative in lambda - #6352
- Correctly set scheme for URIs in the SARIF report output - #6331
- SleepInsteadOfDelay - Find the parent for suspend check - #6191
Dependency Updates
- Update kotlin monorepo to v1.9.10 - #6423
- Update dependency gradle to v8.4 - #6522
- Update dependency gradle to v8.3 - #6406
- Update com.android.tools.build to 8.1.1 - #6419
- update dependency org.jetbrains.dokka to v1.9.10 - #6549
Contributors
We would like to thank the following contributors that made this release possible: @3flex, @arturbosch, @atulgpt, @kkocel, @marschwar, @pablobaxter, @t-kameyama
v1.23.1
1.23.1 - 2023-07-30
This is a point release for Detekt 1.23.0, where we added support for Kotlin 1.9.0 and fixed several bugs that
got reported by the community.
Notable Changes
- Bumped Kotlin to v1.9.0 - #6258
- Bumped KtLint to v0.50.0 - #6239
- Updated CLI to reflect Java 20 support - #6277
Changelog
- Add missing jdkHome and languageVersion properties to DetektCreateBaselineTask - #6284
- Make InvalidRange aware of rangeUntil operator - #6264
- MaxChainedCallsOnSameLine: don't count class references as chained calls - #6224
- CanBeNonNullable: Fix false positive when property is defined after assignment - #6210
- Add
..<andrangeToin theForEachOnRangerule - #6197 - Don't report
UseDataClassif class contains non-property parameters - #6173 - Allow documenting public fun name when same private variable is present - #6165
- Find range call using recursion - #6164
- StringShouldBeRawString: Ignore
replaceIndentandprependIndent- #6154 - UnusedPrivateProperty: Fix false postive by ignoring data classes - #6151
- PropertyUsedBeforeDeclaration: fix false positive in nested/inner class - #6139
Dependency Updates
- Update dependency gradle to v8.2.1 - #6274
- Switch to SLF4J 2.x - #6266
- Update kotlin monorepo to v1.8.22 - #6192
Contributors
We would like to thank the following contributors that made this release possible: @3flex, @Goooler, @Hexcles, @PoisonedYouth, @TWiStErRob, @VirtualParticle, @atulgpt, @cortinico, @dzirbel, @eygraber, @marschwar, @rmarquis, @segunfamisa, @severn-everett, @t-kameyama
v1.23.0
We're so proud to announce the next upcoming stable release of detekt: 1.23.0 🚀 This release is coming with 25 new rules and much more.
We moved the detekt-compiler-plugin to the main repo, and you can now use it in your builds following the official documentation.
This release also marks the beginning of development of 2.x from the main branch! You can follow the progress here
We want to take the opportunity to thank our Sponsors and our Contributors for testing, bug reporting and helping us release this new version of Detekt. You're more than welcome to join our community on the #detekt channel on KotlinLang's Slack (you can get an invite here).
Notable Changes
- This is the first version of Detekt that ships with the
detekt-compiler-plugin. The Detekt Compiler plugin is still experimental, but we're moving it closer to Detekt to make it easier to integrate. From now on the compiler plugin will follow the same versioning schema as Detekt. We invite you to try it and provide feedback till we stabilize it. You can read more about it in the official documentation page - #5492 - We added 25 new Rules to detekt
BracesOnIfStatements- #5700BracesOnWhenStatements- #5838CastNullableToNonNullableType- #5653DoubleNegativeLambda- #5937ForbiddenAnnotation- #5515PropertyUsedBeforeDeclaration- #6062StringShouldBeRawString- #5705SuspendFunSwallowedCancellation- #5666UnusedParameter- #5722UnusedPrivateProperty- #5722UseLet- #6091UnnecessaryBracesAroundTrailingLambda- #6029- Plus the bump to KtLint 0.49.1 added the following rules to the
detekt-formattingruleset:ClassName- #6037EnumWrapping- #6028FunctionName- #6037IfElseBracing- #6028IfElseWrapping- #6028MultilineExpressionWrapping- #6028NoBlankLineInList- #6028NoConsecutiveComments- #6028NoEmptyFirstLineInClassBody- #6028NoSingleLineBlockCommentRule- #6104ParameterWrapping- #6028PropertyName- #6037PropertyWrapping- #6028StringTemplateIndent- #6028TryCatchFinallySpacing- #6028
- Notable changes to existing rules:
UnnecessaryAbstractClassnow only runs with type resolution - #5829UnusedPrivateMemberhas been refactored with some of its logic moved toUnusedParameterandUnusedPrivateProperty- #5722- Removed the
ignoreOverriddenconfig fromBooleanPropertyNaming,ConstructorParameterNaming,FunctionNaming,VariableNamingandFunctionParameterNamingas not useful for those rules - #5718 - Added
ignoredSubjectTypesto ruleElseCaseInsteadOfExhaustiveWhento specify types that should be ignored by the rule (#5623) - #5634 - Added
allowOperatorsto ruleDataClassContainsFunctions- #5658 MandatoryBracesIfStatementshas been removed in favor ofBracesOnIfStatements- #5700- Added
ignoreWhenContainingVariableDeclarationtoUseIfInsteadOfWhento ignore captured variables - #5681 - Several rules in the
detekt-formattingruleset now accepts anindentSizeparameter (see the full list here). - We followed the KtLint decisions on turning on some rules by default, so several rules in the
detekt-formattingruleset are now turned on by default (see the full list here).
- We added support for Gradle's Worker API inside Detekt Gradle Plugin, for faster execution on bigger projects. - #4128
- We fixed the
includes/excludeslogic on the config file as they were overriding each other - #5782 - We fully removed support for Spek from
detekt-test-utils. The recommended testing framework is JUnit - #5785 - The minimum supported Gradle version is now
v6.8.3- #5616 - This version of detekt is built with Gradle
v8.1, AGP8.0.1, Kotlin1.8.21and KtLint0.49.1(see #5893 #5723 #5877 #6028 #6043 #5995 #5996) - We now added a Code of Conduct to our repo. Please read it and follow it when interacting with our community on our channels.
Changelog
- SerialVersionUIDInSerializableClass - Update the error location - #6114
- Reduce LoopWithTooManyJumpStatements finding scope - #6110
- Add alias for SuspendFunWithCoroutineScopeReceiver - #6089
- CastNullableToNonNullableType - Check the SimpleType instead of typeElement - #6071
- Update plugin com.gradle.enterprise to v3.13.1 - #6069
- CanBeNonNullable: Check parent condition for checking if nullability info is used or not - #6064
- Add configuration to add alternate trimming methods - #6063
- Check if property is documented at class header - #6061
- OutdatedDocumentation - Check if only public property is documented - #6057
- UnnecessaryLet: fix false positive in call chains - #6052
- Add
commentswith a list of regexes toForbiddenComment- #5981 - Fix incomplete
requireRootInDeclarationcheck inInvalidPackageDeclaration- #6045 - BracesOnWhenStatements: fix false positive for necessary braces - #6042
- Fix redundant ClassOrdering violations using maximum increasing section - #6003
- UseIsNullOrEmpty: fix false negative with chained call - #6027
- Create docs for Gradle Worker API - #6016
- Compile compiler plugin against kotlin-compiler-embeddable - #6012
- Update intro.mdx to use setFrom() on detekt config - #6010
- Use
detekt-versions.propertiesinstead ofversions.properties- #6006 - Implement parentPath accessor in concrete config implementations - #6002
- Increase ALIASES_LIMIT to 100 for YamlConfig - #5986
- Fix elvis to +/- case in case UnnecessaryParentheses when precedence is unclear - #5983
- jdkHome as @Internal - #5978
- Fix broken POM file for detetk-compiler-plugin - #5971
- Fix broken publishToMavenLocal - #5970
- Add
allowOmitUnitto ruleLibraryCodeMustSpecifyReturnType- #5861 - Remove dependency that creates a cycle. - #5777
- Update dependency org.jetbrains:annotations to v24 - #5969
- Update github/codeql-action digest to
8c8d71d- #5966 - Add functions to ExitOutsideMain rule - #5963
- Update README.md - #5954
- Prevent import statements from counting as references for UnusedPrivateProperty - #5942
- Fix ExpressionBodySyntax not checking property getters/setters - #5938
- Improve correctness of UnusedPrivateProperty - #5935
- Fix documentation for deprecated 'reports' object (Issue #5908) - #5924
- Print file path report as link file - #5921
- "detekt" or "Detekt" - #5898
- Update JSON schema URL - #5881
- Add support for local suppression inside formatting - #5876
- Fix checkExhaustiveness for formatting and third party rules - #5869
- Allow newline style for MaxChainedCallsOnSameLine - #5865
- Declare inputs and outputs to support incremental build for testPluginKotlinc - #5862
- Use code syntax for
Unitfor ImplicitUnitReturnType rule - #5857 - MatchingDeclarationName. KtFilesSpec also remove .common.kt suffix from kotlin files - #5851
- Fix double mutability issues with Gradle plugin's use of ConfigurableFileCollection - #5850
- MagicNumber - Make ignoreNamedArgument catch more complex expression - #5837
- Exclude super call when generating guard clauses - #5835
- Enable test retry for all our modules - #5825
- Stop configuring report merge tasks while configuring Detekt tasks - #5813
- FunctionMatcher support for fully qualified function names - #5812
- Boy Scout - #5808
- Simplify
TestConfigusages - #5801 - Reduce configuration of UnusedPrivateMember's split rules - #5800
- Force SerialVerionUID to be private - #5798
- Exclude the KMP test folders for android - #5797
- Add aliases for PackageNaming and InvalidPackageDeclaration - #5795
- Forbid using Jupiter Kotlin assertions - #5794
- ModifierOrder: fix false positive with block comments - #5791
- Fixed ProtectedMemberInFinalClass rule reporting valid JVM finalize - #5788
- Remove unnecessary usage of BeforeAll in tests - #5781
- Run Kotlin compiler plugin CLI test as part of standard build - #5766
- Refactor to remove java.util.Array* imports - #5761
- Replace java.util.Stack with Kotlin's ArrayDeque implementation - #5760
- Replace java.time.Duration with kotlin.time.Duration - #5759
- Add NixOS installation method to doc - #5757
- Remove & forbid usage of java.util.stream - #5756
- Use stdlib functions for file & path operations - #5754
- Enable UnnecessaryBackticks in detekt project - #5753
- Update docusaurus monorepo to v2.3.1 - #5752
- Resolve runtime classpaths consistently with compile classpaths - #5730
- Exclude new Kotlin Test directories in default config - #5727
- Fail when unexpected version of kotlin-compiler-embeddable is on runtime classpath - #5726
- Fix IgnoredReturnValue rule crash in parallel mode - #5724
- Use
namethat return name after backticks - #5719 - UnusedPrivateMember - Fix false positive in case of invoke operator - #5717
- Fix false positive for
CanBeNonNullablerule - #5714 - IgnoredReturnValue: fix false negative when annotation is on the package - #5706
- Check Thread.sleep for block expression - #5699
- Fix false positive of in UnnecessaryParentheses - #5684
- Fix url and kotlin reference support in kdoc - #5683
- Add config for variable expression in when - #5681
- Enable NoSemicolons rule - #5663
- Use correct resolvable/consumable flags on detekt's configurations - #5657
- Prepare for Gradle 8 - #5656
- ExplicitCollectionElementAccessMethod rule update - #5654
- Cast nullable to non nullable type - #5653
- Enable verbose mode for Codecov GH Action - #5652
- Fail build when issues found with JVM target compatibility of related compile tasks - #5651
- Don't silently use Kotlin compiler fallback strategy - #5650
- Documentation tweaks - #5639
- Have consistent compile-test-snippets between project and system property - #5630
- Exclude operator functions in function min/max length - #5618
- Broken link at EmptyFunctionBlock - #5604
- Update rule description for errorprone rules - #5603
- FunctionMaxLength false positive for overridden methods #5590 - #5599
- Report proper code position in
MaxLineLength- #5583 - Allow access to nonpublic members of public types in java.base/java.lang package - #5579
- NonBooleanPropertyPrefixedWithIs: Allow AtomicBoolean - #5577
- Pass compilation output classes to detekt analysis classpath - #5556
- Fix KDocReferencesNonPublicProperty false positive - #5534
Dependency Updates
- Update dependency io.github.detekt.sarif4k:sarif4k to v0.4.0 - #6113
- Update dependency org.jetbrains.kotlinx:kotlinx-coroutines-core to v1.7.1 - #6097
- Update dependency org.jetbrains.kotlinx:kotlinx-coroutines-core to v1.7.0 - #6074
- Update com.android.tools.build - #6065
- Update JaCoCo to v0.8.10 - #6044
- Update plugin pluginPublishing to v1.2.0 - #5975
- Update ktlint to v0.48.1 - #5661
- Update dependency com.android.tools.build:gradle to v7.4.0 - #5693
- JaCoCo 0.8.9 - #5959
- Update dependency com.github.tschuchortdev:kotlin-compile-testing to v1.5.0 - #5882
- Update dependency org.jetbrains.dokka to v1.8.10 - #5878
- Compile detekt-compiler-plugin against standard Kotlin compiler artifact - #5765
- Migrate to SnakeYAML Engine - #5751
- Update kotlin monorepo to v1.8.10 - #5745
- Update ktlint to v0.48.0 - #5625
- Migrate to Gradle Nexus Publish Plugin - #5554
- Update dependency io.github.detekt.sarif4k:sarif4k to v0.2.0 - #5496
Housekeeping & Refactorings
- Inline Cases enum and inline other external test code into the test classes - #6107
- Update codecov/codecov-action digest to
eaaf4be- #6102 - Remove unnecessary baselines - #6092
- Remove unused
dependenciesAsNames- #6059 - Reduce eager POM task creation - #6041
- Improve our configuration of
ClassNamingandFunctionNaming- #6019 - Comment text in the Issue/PR Template - #5992
- Fix typo: Github -> GitHub - #5956
- Review all Detekt and Detekt Gradle Plugin usages. - #5955
- Review all Detekt and Detekt Gradle Plugin usages. - #5953
- Add a test for catching undocumented public interfaces - #5951
- Execute tests in parallel - #5944
- Make GeneratorSpec use resources - #5932
- Cleanup detekt-formatting to use detekt's own assertThat function - #5911
- Stale any issue with support tag in one month - #5904
- Remove instances of double mutability - #5899
- Handle todo in LinesOfCode logic - #5897
- Boy scout -
detekt-generator- #5854 - Tweak GHA configs a bit - #5852
- Create
generateWebsite- #5849 - Remove dependency between check and jacocoMergedReport - #5846
- Sort deprecation properties - #5845
- Simplify generate documentation - #5844
- Remove unnecessary
@Suppress("ReturnCount")- #5841 - Cleaner merging of Gradle blocks for functionalTests - #5830
- Replace trimMargin usages - #5827
- Disable PTS from local and enable it for PRs - #5826
- Activate MultilineRawStringIndentation on detekt - #5819
- Remove single-use
timesmethod, use stdlib'srepeatinstead. - #5774 - Remove redundant build config - #5617
- Migrate to AGP namespaces - #5569
- Fix typo - #5557
Contributors
We would like to thank the following contributors that made this release possible: @3flex, @BeBAKE, @BraisGabin, @Goooler, @SaumyaBhushan, @TWiStErRob, @VitalyVPinchuk, @adef145, @asomov, @atulgpt, @chao2zhang, @cketti, @cortinico, @drawers, @dzirbel, @igorwojda, @lexa-diky, @luanpotter, @marschwar, @mjovanc, @mmorozkov, @ncteisen, @osipxd, @ov7a, @schalkms, @t-kameyama, @tresni
See all issues at: 1.23.0
Kotlin/kotlinx.serialization (org.jetbrains.kotlinx:kotlinx-serialization-core)
v1.7.3
==================
This release aims to fix important issues that were discovered in the 1.7.2 release, including the inability to sync certain projects into Android Studio/IntelliJ IDEA and exceptions from custom Uuid serializers.
It uses Kotlin 2.0.20 by default.
- Use explicit kotlin-stdlib and kotlin-test versions from version catalog (#2818)
- Drop usage of deprecated Any?.freeze() in K/N target (#2819)
- Check against serialName instead of simpleClassName (#2802)
- Ignore NoClassDefFoundError when initializing builtins map for serializer() function (#2803)
- Clarify example for SerializationException (#2806)
v1.7.2
==================
This release provides several new features, including a major Cbor configuration rework. It uses Kotlin 2.0.20 by default.
Cbor feature set for COSE compliance
This change brings a lot of features to the CBOR format, namely:
- Serial Labels — see
@CborLabelannotation andpreferCborLabelsOverNamesflag. - Tagging of keys and values — see
encode*Tagsandverify*Tagsset of flags - Definite length encoding — see
useDefiniteLengthEncoding. This flag affects object encoding, since decoding of arrays with definite lenghts is automatically supported. - Option to globally prefer major type 2 for byte array encoding — see
alwaysUseByteStringflag.
Since there are quite a lot of flags now, they were restructured to a separate CborConfiguration class, similarly to JsonConfiguration.
It is possible to retrieve this configuration from CborEncoder/CborDecoder interfaces in your custom serializers (see their documentation for details).
All of these features make it possible to serialize and parse COSE-compliant CBOR, for example, ISO/IEC 18013-5:2021-compliant mobile driving license data.
In case you want to make use of them, there is a predefined Cbor.CoseCompliant instance.
However, some canonicalization steps (such as sorting keys) still need to be performed manually.
This functionality was contributed to us by Bernd Prünster.
Keeping generated serializers
One of the most requested features for serialization plugin was to continue to generate a serializer even if a custom one is specified for the class. It allows using a plugin-generated serializer in a fallback or delegate strategy, accessing type structure via descriptor, using default serialization behavior in inheritors that do not use custom serializers.
Starting with this release, you can specify the @KeepGeneratedSerializer annotation on the class declaration to instruct the plugin to continue generating the serializer.
In this case, the serializer will be accessible using the .generatedSerializer() function on the class's companion object.
This annotation is currently experimental. Kotlin 2.0.20 or higher is required for this feature to work.
You can check out the examples in the documentation and in the PRs: #2758, #2669.
Serializer for kotlin.uuid.Uuid
Kotlin 2.0.20 added a common class to represent UUIDs in a multiplatform code.
kotlinx.serialization 1.7.2 provides a corresponding Uuid.serializer() for it, making it possible to use it in @Serializable classes.
Note that for now, serializer should be provided manually with [@Contextual annotation](https://redirect.github.com/Kotlin/kotlinx.serialization/blob/master/docs/serializers.md#contex
Configuration
📅 Schedule: Branch creation - "before 4am on Monday" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
- [ ] If you want to rebase/retry this PR, check this box
This PR was generated by Mend Renovate. View the repository job log.
reckon requires JVM 11