.git-blame-ignore-revs

@@ -1,2 +1,5 @@
 # Scala Steward: Reformat with scalafmt 3.7.0
 7939505c0eb8b06e25c372c5bbe0da3272c65b81
+
+# Scala Steward: Reformat with scalafmt 3.8.2
+f5a756f05939939b4a30a4109f1a3b2cf472d85a

.github/dependabot.yml

@@ -0,0 +1,10 @@
+# Set update schedule for GitHub Actions
+
+version: 2
+updates:
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every week
+      interval: "weekly"

.github/workflows/check-lint.yml

@@ -7,5 +7,5 @@ jobs:
   check-lint:
     runs-on: ubuntu-20.04
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - run: ./scripts/check-lint.sh

.github/workflows/ci.yml

@@ -5,19 +5,20 @@ on:
   pull_request:
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       matrix:
-        java: [ '8', '11', '17' ]
+        java: [ '17', '21' ]
     env:
       JAVA_OPTS: -Xms2G -Xmx4G -Xss6M -XX:+UseG1GC -XX:ReservedCodeCacheSize=256M -Dfile.encoding=UTF-8
     name: Test using Java ${{ matrix.java }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Setup Java
-      uses: actions/setup-java@v3
+      uses: actions/setup-java@v4
       with:
         distribution: 'adopt'
         java-version: ${{ matrix.java }}
         cache: 'sbt'
+    - uses: sbt/setup-sbt@v1
     - run: sbt +test

.github/workflows/release.yml

@@ -8,11 +8,11 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Setup Java
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: 'adopt'
           java-version: '17'

.gitignore

@@ -13,6 +13,9 @@ target/
 # vscode
 /.vscode/
 
+# scala-cli
+/.scala-build/
+
 # scripts generated
 /scripts/.coursier
 /scripts/.scalafmt*

.scala-steward.conf

@@ -0,0 +1 @@
+updatePullRequests = "always"

.scalafmt.conf

@@ -1,5 +1,5 @@
 # Test upgrades: $ scripts/scalafmt --test 2> diff.txt
-version = 3.7.14
+version = 3.9.4
 runner.dialect = scala213source3
 preset = default
 

README.md

@@ -1,20 +1,16 @@
 # sconfig
 ![CI](https://github.com/ekrich/sconfig/workflows/CI/badge.svg)
 [![Scala.js](https://www.scala-js.org/assets/badges/scalajs-1.0.0.svg)](https://www.scala-js.org)
+[![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org)
 
-Configuration library written in [Scala](https://www.scala-lang.org/) which is a direct translation 
-of the original widely used Java library.
+Configuration library written in [Scala](https://www.scala-lang.org/) which is a direct translation of the original widely used Java library.
 
 [Scala JVM](https://www.scala-lang.org/), [Scala Native](https://scala-native.readthedocs.io/), and [Scala.js](https://www.scala-js.org/)
 are supported. Scala JVM is fully supported whereas the other platforms support a subset of the full API.
 
-For motivation and background about this project see the [PR](https://github.com/lightbend/config/pull/600) 
-to the original project. The TLDR is the library was ported to Scala to support Scala Native so
-[scalafmt](https://scalameta.org/scalafmt/) which uses HOCON configuration could be compiled into
-a native application.
+For motivation and background about this project see the [PR](https://github.com/lightbend/config/pull/600) to the original project. The TLDR is the library was ported to Scala to support Scala Native so [scalafmt](https://scalameta.org/scalafmt/) which uses HOCON configuration could be compiled into a native application.
 
-Care has been taken to keep the API the same but changes were needed when moving from the Java API.
-Using Java is also possible as demonstrated by including the working Java examples.
+Care has been taken to keep the API the same but changes were needed when moving from the Java API. Using Java is also possible as demonstrated by including the working Java examples.
 
 If you are looking for the original Java API, see
 [https://github.com/lightbend/config](https://github.com/lightbend/config).
@@ -38,26 +34,24 @@ All available versions can be seen at the [Maven Repository](https://mvnreposito
 ## Cross Build Versions
 [![Scala.js](https://www.scala-js.org/assets/badges/scalajs-1.0.0.svg)](https://www.scala-js.org)
 
-| Scala Version          | JVM | Scala.js (1.x)        | Native (0.4.x) |
+| Scala Version          | JVM | Scala.js (1.x)        | Native (0.5.x) |
 | ---------------------- | :-: | :-------------------: | :------------: |
 | 2.12.x                 | ✅  |          ✅           |       ✅       |
 | 2.13.x                 | ✅  |          ✅           |       ✅       |
 | 3.x.x                  | ✅  |          ✅           |       ✅       |
 
-Note: Scala 3 support on Scala Native 0.4.3-RC2 or greater. Scala 2.11 support through version 1.4.9.
+* Scala Native 0.5.x support from 0.7.0.
+* Scala 3 support on Scala Native 0.4.3-RC2 or greater.
+* Scala 2.11 support through version 1.4.9.
 
 ## Usage and Help
-[![Scaladoc](https://www.javadoc.io/badge/org.ekrich/sconfig_2.13.svg?label=scaladoc)](https://www.javadoc.io/doc/org.ekrich/sconfig_2.13)
 [![scaladoc](https://javadoc.io/badge/org.ekrich/sconfig_3.svg?label=scaladoc3)](https://javadoc.io/doc/org.ekrich/sconfig_3)
 [![Discord](https://img.shields.io/discord/633356833498595365.svg?label=&logo=discord&logoColor=ffffff&color=404244&labelColor=6A7EC2)](https://discord.gg/XSj6hQs)
 
 
-Please refer to the original library documentation [here](https://github.com/lightbend/config).
-This is to reduce the maintenance burden of this library.
+Please refer to the original library documentation [here](https://github.com/lightbend/config). This is to reduce the maintenance burden of this library.
 
-The intent is to keep the library in sync with the original but each PR needs to be be ported
-to maintain feature parity. The documentation could contain features that are not yet implemented
-in this library.
+The intent is to keep the library in sync with the original but each PR needs to be be ported to maintain feature parity. The documentation could contain features that are not yet implemented in this library.
 
 For specific changes, refer to the releases below.
 
@@ -66,45 +60,39 @@ For specific changes, refer to the releases below.
 [![sconfig Scala version support](https://index.scala-lang.org/ekrich/sconfig/sconfig/latest.svg)](https://index.scala-lang.org/ekrich/sconfig/sconfig)
 [![Latest scalafix version](https://index.scala-lang.org/scalacenter/scalafix/scalafix-core/latest.svg)](https://index.scala-lang.org/scalacenter/scalafix/scalafix-core)
 
-This project publishes a [scalafix](https://scalacenter.github.io/scalafix/) rule to migrate 
-existing Scala 2 source code that uses `com.typesafe.config.Config` to this implementation.
-Scalafix rules modify in place existing valid Scala code. Think of it as a fancy find-and-replace
-tool that is aware of the Scala type system and can therefore narrowly tailor the changes 
-being made. (Since scalafix changes the source code on your file system, it's best to commit 
-any changes prior to running the rule, in case something weird happens.)
+This project publishes a [scalafix](https://scalacenter.github.io/scalafix/) rule to migrate existing Scala 2 source code that uses `com.typesafe.config.Config` to this implementation. Scalafix rules modify in place existing valid Scala code. Think of it as a fancy find-and-replace tool that is aware of the Scala type system and can therefore narrowly tailor the changes being made. (Since scalafix changes the source code on your file system, it's best to commit any changes prior to running the rule, in case something weird happens.)
 
-The rule will replace `com.typesafe.config` package references with `org.ekrich.config`,
-and remove trailing parens on some methods (where the API changed from the Java implementation).
+The rule will replace `com.typesafe.config` package references with `org.ekrich.config`, and remove trailing parens on some methods (where the API changed from the Java implementation).
 
-Complete setup documentation and the current `scalafix` version can be found in the
-[scalafix user guide](https://scalacenter.github.io/scalafix/docs/users/installation.html).
-At a high level, the process is as follows:
+Complete setup documentation and the current `scalafix` version can be found in the [scalafix user guide](https://scalacenter.github.io/scalafix/docs/users/installation.html). At a high level, the process is as follows:
 
 1. Add scalafix to the project's `project/plugins.sbt` file using the version found above:
 
    ```scala
    addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "a.b.c")
    ```
-   
+
 2. Add this project to the project's `libraryDependencies`, but don't remove the old one yet!
 
-   (The old dependency needs to stay on the classpath until after the rule runs, because the 
-   code must compile before it will run.)
+   (The old dependency needs to stay on the classpath until after the rule runs, because the code must compile before it will run.)
 
-3. Run the scalafix sbt command shown below to apply the rule using the version of `sconfig`
-   selected. Replace the `x.y.z` below with the version (must be greater than version `1.4.5`
-   when scalafix was added):
+3. Run the scalafix sbt command shown below to apply the rule using the version of `sconfig` selected. Replace the `x.y.z` below with the version (must be greater than version `1.4.5` when scalafix was added):
 
     ```
     scalafixEnable; scalafixAll dependency:ReplaceTypesafeConfig@org.ekrich:sconfig-scalafix:x.y.x
     ```
-   
+
 4. Remove the old config dependency from the project's `libraryDependencies`
 5. Commit the changes
 
 ## Versions
 
-Release [1.5.1](https://github.com/ekrich/sconfig/releases/tag/v1.5.1) - (2023-09-14)<br/>
+Release [1.9.0](https://github.com/ekrich/sconfig/releases/tag/v1.9.0) - (2025-03-17)<br/>
+Release [1.8.1](https://github.com/ekrich/sconfig/releases/tag/v1.8.1) - (2024-11-05)<br/>
+Release [1.8.0](https://github.com/ekrich/sconfig/releases/tag/v1.8.0) - (2024-11-05)<br/>
+Release [1.7.0](https://github.com/ekrich/sconfig/releases/tag/v1.7.0) - (2023-04-16)<br/>
+Release [1.6.0](https://github.com/ekrich/sconfig/releases/tag/v1.6.0) - (2023-12-28)<br/>
+Release [1.5.1](https://github.com/ekrich/sconfig/releases/tag/v1.5.1) - (2023-09-15)<br/>
 Release [1.5.0](https://github.com/ekrich/sconfig/releases/tag/v1.5.0) - (2022-09-19)<br/>
 Release [1.4.9](https://github.com/ekrich/sconfig/releases/tag/v1.4.9) - (2022-01-25)<br/>
 Release [1.4.8](https://github.com/ekrich/sconfig/releases/tag/v1.4.8) - (2022-01-12)<br/>

build.sbt

@@ -8,8 +8,8 @@ addCommandAlias(
   ).mkString(";", ";", "")
 )
 
-val prevVersion = "1.5.1"
-val nextVersion = "1.5.2"
+val prevVersion = "1.8.0"
+val nextVersion = "1.9.0"
 
 // stable snapshot is not great for publish local
 def versionFmt(out: sbtdynver.GitDescribeOutput): String = {
@@ -25,9 +25,9 @@ val scalacOpts = dotcOpts ++ List(
   // 57 inferred return type Scala 2.13 cat=scala3-migration
   "-Wconf:msg=inferred:ws",
   // 2 deprecations Scala 2.12 Stack - fixed for 2.13
-  "-Wconf:msg=poorly-performing:ws"
+  "-Wconf:msg=poorly-performing:ws",
   // uncomment to see messages
-  // "-Wconf:any:warning-verbose"
+  "-Wconf:any:warning-verbose"
 )
 
 Compile / console / scalacOptions --= Seq(
@@ -43,17 +43,23 @@ val isScala3 = Def.setting {
   }
 }
 
-val scala212 = "2.12.18"
-val scala213 = "2.13.12"
-val scala3 = "3.3.1"
+val scala212 = "2.12.20"
+val scala213 = "2.13.16"
+val scala3 = "3.3.5"
 
-val javaTime = "1.1.9"
-val scCompat = "2.11.0"
+val javaTime = "1.3.0"
+val scCompat = "2.13.0"
 
-val versionsBase = Seq(scala212, scala213)
+// We use the 2.12 and 2.13 version that the scalafix library uses
+// and when the scalafix version gets updated the system will build
+// using those Scala version. The Scala versions above are versions
+// that get updated via Scala Steward and will match the scalafix
+// versions when scalafix version is updated and in sync with the
+// latest Scala versions.
+val versionsBase = _root_.scalafix.sbt.BuildInfo.supportedScalaVersions
 val versions = versionsBase :+ scala3
 
-ThisBuild / scalaVersion := scala3
+ThisBuild / scalaVersion := scala213
 ThisBuild / crossScalaVersions := versions
 ThisBuild / versionScheme := Some("early-semver")
 ThisBuild / mimaFailOnNoPrevious := false
@@ -116,14 +122,21 @@ lazy val sconfig = crossProject(JVMPlatform, NativePlatform, JSPlatform)
     scalacOptions ++= {
       if (isScala3.value) dotcOpts else scalacOpts
     },
-    libraryDependencies += "org.scala-lang.modules" %%% "scala-collection-compat" % scCompat,
-    testOptions += Tests.Argument(TestFrameworks.JUnit, "-a", "-s", "-v")
+    libraryDependencies ++= Seq(
+      "org.scala-lang.modules" %%% "scala-collection-compat" % scCompat,
+      "org.json4s" %%% "json4s-native-core" % "4.0.7" % Test
+    ),
+    testOptions += Tests.Argument(TestFrameworks.JUnit, "-a", "-s", "-v"),
+    // env vars for tests
+    Test / envVars ++= Map(
+      "testList.0" -> "0",
+      "testList.1" -> "1",
+      "testClassesPath" -> (Test / classDirectory).value.getPath
+    )
   )
   .jvmSettings(
     crossScalaVersions := versions,
     libraryDependencies ++= Seq(
-      ("io.crashbox" %% "spray-json" % "1.3.5-7" % Test)
-        .cross(CrossVersion.for3Use2_13),
       "com.github.sbt" % "junit-interface" % "0.13.3" % Test
       // includes junit 4.13.2
     ),
@@ -141,12 +154,6 @@ lazy val sconfig = crossProject(JVMPlatform, NativePlatform, JSPlatform)
     Test / fork := true,
     run / fork := true,
     Test / run / fork := true,
-    // env vars for tests
-    Test / envVars ++= Map(
-      "testList.0" -> "0",
-      "testList.1" -> "1",
-      "testClassesPath" -> (Test / classDirectory).value.getPath
-    ),
     // uncomment for debugging
     // Test / javaOptions += "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005",
     // mima settings
@@ -156,14 +163,20 @@ lazy val sconfig = crossProject(JVMPlatform, NativePlatform, JSPlatform)
   .nativeConfigure(_.enablePlugins(ScalaNativeJUnitPlugin))
   .nativeSettings(
     crossScalaVersions := versions,
-    nativeConfig ~= (_.withLinkStubs(true)),
+    Test / nativeConfig ~= (
+      _.withEmbedResources(true)
+    ),
     logLevel := Level.Info, // Info or Debug
     libraryDependencies += "org.ekrich" %%% "sjavatime" % javaTime % "provided"
   )
   .jsConfigure(_.enablePlugins(ScalaJSJUnitPlugin))
   .jsSettings(
     crossScalaVersions := versions,
-    libraryDependencies += "org.ekrich" %%% "sjavatime" % javaTime % "provided"
+    libraryDependencies ++= Seq(
+      "org.ekrich" %%% "sjavatime" % javaTime % "provided",
+      ("org.scala-js" %%% "scalajs-weakreferences" % "1.0.0")
+        .cross(CrossVersion.for3Use2_13)
+    )
   )
 
 lazy val `scalafix-rules` = (project in file("scalafix/rules"))

docs/SCALA-NATIVE.md

@@ -45,9 +45,40 @@ val maxCol = conf.getInt("maxColumn")
 val isGit = conf.getBoolean("project.git")
 ```
 
-### How to read a HOCON configuation file into a String for Scala Native
+## Using Reader - StringReader example
 
-In order to read the configuration file into a `String` you need to know the relative
+Both JS and Native now support `java.io.Reader` which allows using `sconfig`
+to parse all supported formats by passing a filename with extension. See the
+following examples from the shared `ConfigFactoryTest` file.
+
+```scala
+val filename = "/test01.properties"
+val fileStr =
+    """
+      |# test01.properties file
+      |fromProps.abc=abc
+      |fromProps.one=1
+      |fromProps.bool=true
+      |fromProps.specialChars=hello^^
+      """.stripMargin
+
+// create Reader
+var test01Reader = new StringReader(fileStr)
+
+val config = ConfigFactory.parseReader(
+  test01Reader,
+  ConfigParseOptions.defaults
+    .setSyntaxFromFilename(filename)
+)
+val specialChars = config.getString("fromProps.specialChars")
+```
+
+In Scala Native `java.io.FileReader` is available so you can create a
+`FileReader` from a `File`.
+
+### How to read a HOCON configuation file using Scala Native
+
+In order to read a configuration file you need to know the relative
 path from where the executable was started or use an absolute path. If the 
 Scala Native executable is `run` from `sbt` it will have the current working directory 
 equal to the directory at the base of your project where `sbt` was started. If curious
@@ -60,16 +91,21 @@ println(s"Working Dir: $dir")
 ```
 
 Continuing the same thought process you can use the following code to read the file
-into a `String` from a simple `sbt` project where the `src` directory is at the top
+from a simple `sbt` project where the `src` directory is at the top
 level of your project and you are using the `run` command. If you package your
 application or run the application executable directly, then making the path relative
 to the binary with the code above could be your best option. Another option is to use
-the `"user.home"` or the `"user.dir"` property to configure the file path.
+the `"user.home"` or the `"user.dir"` property to configure the file path. Note: When the
+executable is added to the path, the current working directory is where you start the
+executable from so keep that in mind
 
 ```scala
-import java.nio.file.{Files, Paths}
-val bytes = Files.readAllBytes(Paths.get("src/main/resources/myapp.conf"))
-val configStr = new String(bytes)
+import java.io.File
+val file = new File("src/main/resources/myapp.conf")
+// ConfigDocument
+val configDocument = ConfigDocumentFactory.parseFile(file)
+// or Config
+val config = ConfigFactory.parseFile(file)
 ```
 
 Using this code with the code above gives you a working solution to use `sconfig`

project/build.properties

@@ -1 +1 @@
-sbt.version=1.9.4
+sbt.version=1.10.11