vlovgr/ciris
54.9
Adequate · 6 November 2026
3.2k
lines of production code
Scala
primary language
4
measurements over time
What this system is
Features
Add Circe integration for JSON configuration decoding and Secret serialization
The \modules/circe\ module now provides integration with the Circe JSON library, allowing users to decode configuration values directly from JSON strings into arbitrary types via \circeConfigDecoder\, parse raw JSON into \io.circe.Json\ using \jsonConfigDecoder\, and automatically serialize/deserialize \Secret\[A\]\ wrappers using Circe's \Encoder\ and \Decoder\ instances. This enables seamless handling of JSON-formatted secrets and configuration values within the ciris configuration system.
modules/circe · high confidence
Add JVM-specific file and environment configuration sources
The JVM core module now includes platform-specific implementations for reading environment variables and loading file contents. Users can load configuration from files using the \file\ method, which reads content synchronously using UTF-8 or a specified charset; if the file does not exist, the value is missing, and if it cannot be read (e.g., the path is a directory), the load fails with an error. This change also introduces corresponding tests for these JVM-specific behaviors using the munit framework.
modules/core/jvm · high confidence
Add Scala Native support for core configuration loading
This change introduces a new \modules/core/native\ module that provides Scala Native-specific implementations for the Ciris runtime platform. It adds \CirisRuntimePlatform\ and \ConfigKeyRuntimePlatform\ traits to handle environment variable and file-based configuration loading on Native targets, including synchronous file reading with UTF-8 or custom charset support and proper error handling for unreadable files. Corresponding test suites using Munit and ScalaCheck are added to verify environment variable retrieval, file content loading, missing file handling, and directory-access error reporting.
modules/core/native · high confidence
Add YAML configuration decoding support
Users can now decode configuration values from YAML format using the new \circeYamlConfigDecoder\ and \yamlConfigDecoder\ in the \ciris.circe.yaml\ package. This feature leverages the \io.circe.yaml\ library to parse YAML strings into Circe \Json\ objects and subsequently decode them into target types, providing detailed error messages for parsing and decoding failures while supporting redaction for sensitive data.
modules/circe-yaml · high confidence
Add http4s integration for decoding network types
Users can now decode configuration values directly into http4s and ip4s types, including Host, Hostname, IpAddress, Port, Uri, and Origin. This new integration in the http4s module provides implicit ConfigDecoders that parse string configuration entries into these specific domain objects, simplifying the setup of network-related configuration.
modules/http4s · high confidence
Add internal SHA-1 digest implementation
The library now includes a native Scala implementation of the SHA-1 digest algorithm within the \ciris.internal.digest\ package. This addition introduces \GeneralDigest\, \SHA1Digest\, and helper utilities like \Pack\ to compute SHA-1 hashes, exposing a \sha1Hex\ function for generating hexadecimal hash strings. This allows the library to perform digest operations without relying on external cryptographic providers for this specific algorithm.
modules/core/shared/src/main/scala/ciris/internal · high confidence
Add squants integration for parsing quantity values
Users can now automatically parse configuration values into squants Quantity types (such as Time) using the new ConfigDecoder. This integration allows string-based configuration entries to be directly converted into typed squants objects, with built-in error handling for invalid formats.
modules/squants/shared · high confidence
New AWS SSM Parameter Store integration with automatic retry handling
Added \AwsSsmParameters\ in the \ciris.http4s.aws\ module, enabling retrieval of decrypted values from the AWS Systems Manager Parameter Store via http4s. The implementation includes a default retry policy to handle throttled requests and normalizes error types, ensuring that parameter names are included in unexpected errors for better debugging.
modules/http4s-aws/shared/src/main · high confidence
Removals
Removal of Squants config readers in JVM module
The \SquantsConfigReaders\ trait and the \ciris.squants\ package object have been removed from the JVM module. This eliminates the implicit \ConfigReader\ instances for various Squants physical quantities (such as capacitance, energy, mass, pressure, and temperature), meaning users can no longer automatically parse these specific units from configuration sources within this module.
modules/squants/jvm · high confidence
Removal of built-in config readers
The built-in config readers for primitive types (Boolean, Int, Long, etc.), Java time classes (LocalDate, Instant, etc.), Java NIO paths, URIs, URLs, UUIDs, and derived readers (Option) have been removed from the \ciris.readers\ package. Users can no longer rely on these implicit \ConfigReader\ instances being available by default and must provide their own implementations or use a separate module that supplies them.
modules/core/shared/src/main/scala/ciris/readers · high confidence
Behavioural changes
Core configuration loading API refactored with new types and error handling
The core configuration loading mechanism has been significantly restructured. The previous \ConfigReader\ and \ConfigSource\ abstractions have been replaced by a parameterized \ConfigDecoder\[A, B\]\ for type-safe decoding and a new \ConfigKey\ for describing configuration sources (environment variables, system properties). Configuration state is now represented by the \ConfigEntry\ sealed trait (with \Default\, \Failed\, and \Loaded\ cases) and exposed to users via \ConfigValue\. Error handling is improved with a new \ConfigError\ hierarchy supporting accumulation (\and\/\or\), redaction of sensitive details, and a new \ConfigException\ for throwing. Sensitive values are now wrapped in a \Secret\ class that displays only a short SHA-1 hash, and a \UseOnceSecret\ type is introduced for secure, single-use access to sensitive data like passwords.
modules/core/shared/src/main/scala/ciris · high confidence
Migrate Ciris integration from ConfigReader to ConfigDecoder
The enumeratum module's integration with the Ciris configuration library has been updated to use Ciris's newer \ConfigDecoder\ API, replacing the deprecated \ConfigReader\ mechanism. This change involves removing the legacy \EnumeratumConfigReaders\ trait and introducing new \Ciris\ and \CirisEnum\ traits (along with specific implementations for value enums like \IntCirisEnum\ and \StringCirisEnum\) that provide \ConfigDecoder\ instances. Users relying on this integration will need to ensure they are using a version of Ciris that supports \ConfigDecoder\ and may need to adjust their imports or implicit resolution to use the new \CirisEnum\ mixin.
modules/enumeratum · high confidence
Project rebrand to Ciris and documentation overhaul
The project has been rebranded from 'Ciris' to 'Ciris' (with updated branding assets) and the README has been completely rewritten to direct users to the new microsite at https://cir.is for documentation. The build configuration has been updated to use Scala 2.13 as the runner dialect, and the scalafmt version has been bumped to 3.11.5. Additionally, the project now includes a .jvmopts file with default JVM settings (UTF-8 encoding, G1GC, memory limits) and a new .mergify.yml configuration to automatically merge scala-steward PRs. The license file has been updated to reflect copyright years 2017-2026.
(repo-wide) · high confidence
Refined integration migrated from ConfigReader to ConfigDecoder
The integration with the Refined library has been updated to use the new ConfigDecoder API instead of the deprecated ConfigReader. This change replaces the previous implementation (which relied on runtime reflection via WeakTypeTag) with a modern macro-based approach that works across Scala 2 and Scala 3, ensuring that configuration values are refined according to their types during decoding.
modules/refined · high confidence
Test coverage
Added comprehensive property-based tests for core Ciris types; Added tests for AwsSsmParameters.
Dependencies
Build infrastructure modernized with SBT 1.13 and updated plugins
The build system has been upgraded from SBT 0.13.15 to 1.13.0, accompanied by a comprehensive update of build plugins: sbt-buildinfo to 0.13.2, sbt-ci-release to 1.12.1, sbt-unidoc to 0.6.1, sbt-doctest to 0.12.5, sbt-mima-plugin to 1.1.5, sbt-header to 5.11.0, sbt-scala-native-crossproject to 1.4.0, sbt-scalajs-crossproject to 1.4.0, sbt-scalajs to 1.21.0, sbt-scala-native to 0.5.12, sbt-mdoc to 2.9.2, and sbt-scalafmt to 2.6.1. Legacy plugins such as sbt-microsites, sbt-release, and the old scala-native crossproject plugins have been removed. Additionally, custom build logic in \project/LatestVersion.scala\ and \project/SourceGenerators.scala\ has been deleted, likely replaced by generated load configs or other build mechanisms.
project · high confidence
Update build dependencies and add website package.json
The build configuration has been updated to use newer versions of core libraries, including cats-effect 3.7.1, circe 0.14.15, http4s 0.23.38, and refined 0.11.3, alongside Scala 3.3.8. A new website/package.json file has been added to manage the Docusaurus static site generator (version 1.6.2) for the project's documentation site.
(dependencies) · high confidence
Written by cca.canine.dev from the codebase's own history, inside the signed delivery this page is composed from.
How this codebase got here
Score
- CAI 52 → 55 (+2.7)
- Rubric changed (rubric-2026.10.5 → rubric-2026.11.2) — scores are not directly comparable.
Lenses
- Code Health 75 → 75 (+0.0)
- Architecture 99 → 99 (+0.0)
- Maturity 38 → 43 (+4.1)
- Readiness 49 → 58 (+9.6)
- Security 79 → 65 (-13.9)
Resolved (2)
- Off-boarding risk: anonymized user #1
- Outdated: io.circe:circe-yaml_3
New (2)
- Dependency hygiene PARTLY measured — sbt declarations read, dependency currency not (Maven Central unreachable)
- Off-boarding risk: anonymized user #1
Changes since last survey
- 13 commits — 13 feature/other, 0 fixes
By area
- (root) — 5 commits
- (repo) — 3 commits
- .github/profile-picture.png — 1 commit
- .github/social-preview.png — 1 commit
- docs/img — 1 commit
- project/build.properties — 1 commit
- project/plugins.sbt — 1 commit
Notable commits
- change: Add GitHub profile picture
- change: Add GitHub social preview image
- change: Change Typelevel shield to link to typelevel.org
- change: Change to use logo instead of separate favicon
- change: Change to use new Typelevel project shields
- change: Merge pull request #1023 from scala-steward/update/scala3-library-3.3.9
- change: Merge pull request #1024 from scala-steward/update/sbt-1.13.1
- change: Merge pull request #1026 from scala-steward/update/doctest-runtime-0.13.3
- change: Remove footer on the website
- change: Update discord invite link to project channel
- change: Update doctest-runtime, sbt-doctest to 0.13.3
- change: Update sbt, scripted-plugin to 1.13.1
- change: Update scala3-library, ... to 3.3.9
Written by cca.canine.dev from the codebase's own history, inside the signed delivery this page is composed from.
Survey your own repository
vlovgr/ciris was measured the same way every project in this corpus was: the same rubric, at a pinned commit, with the result published in full. Point a surveyor at a repository you know and see whether you agree with it.
About this page
- The score is its most recent published measurement, taken on 6 November 2026 at a pinned commit. It is not a live figure and does not change until the project is measured again.
- Measured at commit a5c7c0a9b16ddaa0cfbb892ebcc82d9db1cc9dc5 — the exact code this score is about.
- Scored under rubric-2026.11.2 — the same rubric and the same method as every other entry in this index.
- Measured by Canine Code Analyzer (cca.canine.dev) using cca measure-2026.11.3+preprod-60d1b390edf0.