Initializing the repository with a non-functional plugin.

.gitignore

@@ -0,0 +1,4 @@
+target/
+project/target/
+project/project/
+modules/core/target/

.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+---
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+        args: ['--fix=lf']
+        description: Enforces using only 'LF' line endings.
+      - id: trailing-whitespace
+  - repo: https://git.garrity.co/garrity-software/gs-pre-commit-scala
+    rev: v1.0.0
+    hooks:
+      - id: scalafmt

.scalafmt.conf

@@ -0,0 +1,72 @@
+// See: https://github.com/scalameta/scalafmt/tags for the latest tags.
+version = 3.7.17
+runner.dialect = scala3
+maxColumn = 80
+
+rewrite {
+    rules = [RedundantBraces, RedundantParens, Imports, SortModifiers]
+    imports.expand = true
+    imports.sort = scalastyle
+    redundantBraces.ifElseExpressions = true
+    redundantBraces.stringInterpolation = true
+}
+
+indent {
+    main = 2
+    callSite = 2
+    defnSite = 2
+    extendSite = 4
+    withSiteRelativeToExtends = 2
+    commaSiteRelativeToExtends = 2
+}
+
+align {
+    preset = more
+    openParenCallSite = false
+    openParenDefnSite = false
+}
+
+newlines {
+    implicitParamListModifierForce = [before,after]
+    topLevelStatementBlankLines = [
+        {
+            blanks = 1
+        }
+    ]
+    afterCurlyLambdaParams = squash
+}
+
+danglingParentheses {
+    defnSite = true
+    callSite = true
+    ctrlSite = true
+    exclude = []
+}
+
+verticalMultiline {
+    atDefnSite = true
+    arityThreshold = 2
+    newlineAfterOpenParen = true
+}
+
+comments {
+    wrap = standalone
+}
+
+docstrings {
+    style = "SpaceAsterisk"
+    oneline = unfold
+    wrap = yes
+    forceBlankLineBefore = true
+}
+
+project {
+  excludePaths = [
+    "glob:**target/**",
+    "glob:**.metals/**",
+    "glob:**.bloop/**",
+    "glob:**.bsp/**",
+    "glob:**metals.sbt",
+    "glob:**.git/**"
+  ]
+}

LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,126 @@
+# sbt-gs-calver
+
+CalVer plugin for Garrity Software projects. Typically used for library
+development.
+
+- [Usage](#usage)
+    - [Adding the Plugin](#adding-the-plugin)
+    - [Updating the Build File](#updating-the-build-file)
+    - [Publishing a Release](#publishing-a-release)
+- [Supported Setting Keys](#supported-setting-keys)
+    - [`calVer`](#calVer)
+- [Supported Command Line Properties](#supported-command-line-properties)
+    - [The `release` Property](#the-release-property)
+- [Supported Tasks](#supported-tasks)
+    - [`calVerInfo`](#calverinfo)
+- [Complete Example](#complete-example)
+
+## Usage
+
+This is an auto plugin that provides setting keys for version values.
+
+1. Add the plugin to your build.
+2. Update your build file to leverage the calculated CalVer values.
+3. Build releases using the `-Drelease` parameter.
+
+### Adding the Plugin
+
+**File: project/plugins.sbt**
+```scala
+resolvers += "Garrity Software Releases" at "https://maven.garrity.co/gs"
+
+addSbtPlugin("gs" % "sbt-gs-calver" % "0.1.0")
+```
+
+### Updating the Build File
+
+On any project within the build:
+
+```
+.settings(version := calVerSelected.value)
+```
+
+### Publishing a Release
+
+```
+sbt -Drelease=true publish
+```
+
+## Supported Setting Keys
+
+These are available in `build.sbt` once the plugin is added.
+
+### `calVerSelected`
+
+This setting should be used as the project version. Assign the value of this
+setting to the `version` setting:
+
+```scala
+lazy val `example` = project
+  .in(file("."))
+  .settings(version := calVerSelected.value)
+```
+
+### `calVerMajor`
+
+This setting should be used to calculate library names that are version-aware.
+This practice helps protect against binary compatibility issues stemming from
+different library versions existing as transitive dependencies.
+
+```scala
+lazy val `example` = project
+  .in(file("."))
+  .settings(version := calVerSelected.value)
+```
+
+## Supported Command Line Properties
+
+Properties are provided via `-D` parameters: `-D<name>=<value>`.
+
+### The `release` Property
+
+Value is either `true` or `false`. If this property is not set, `false` is 
+assumed. Releases are opt-in.
+
+## Supported Tasks
+
+### `calVerInfo`
+
+Invoking `sbt calVerInfo` will emit diagnostic version information at the `info`
+log level via the SBT logger.
+
+```
+sbt calVerInfo
+...
+[info] [CalVer] Version: 2024.1.18-eba621c
+...
+```
+
+## Complete Example
+
+### `plugins.sbt`
+
+```scala
+resolvers += "Garrity Software Releases" at "https://maven.garrity.co/gs"
+
+addSbtPlugin("gs" % "sbt-gs-calver" % "0.1.0")
+```
+
+### `build.sbt`
+
+```scala
+val scala3: String = "3.3.1"
+
+ThisBuild / organizationName     := "garrity software"
+ThisBuild / organization         := "gs"
+ThisBuild / scalaVersion         := scala3
+
+lazy val sharedSettings = Seq(
+  scalaVersion := scala3,
+  version      := calVerSelected.value
+)
+
+lazy val `gs-example` = project
+  .in(file("."))
+  .settings(sharedSettings)
+```

build.sbt

@@ -0,0 +1,86 @@
+ThisBuild / organizationName := "garrity software"
+ThisBuild / organization     := "gs"
+ThisBuild / versionScheme    := Some("semver-spec")
+
+externalResolvers := Seq(
+  "Garrity Software Releases" at "https://maven.garrity.co/gs",
+  "Garrity Software Maven Mirror" at "https://maven.garrity.co/releases"
+)
+
+val ProjectName: String = "sbt-gs-calver"
+val Description: String = "SBT 1.9.0+ plugin for Git-based semantic versioning."
+
+def getProperty[A](
+  name: String,
+  conv: String => A
+): Option[A] =
+  Option(System.getProperty(name)).map(conv)
+
+val VersionProperty: String = "version"
+val ReleaseProperty: String = "release"
+
+lazy val InputVersion: Option[String] =
+  getProperty(VersionProperty, identity)
+
+lazy val IsRelease: Boolean =
+  getProperty(ReleaseProperty, _.toBoolean).getOrElse(false)
+
+lazy val Modifier: String =
+  if (IsRelease) "" else "-SNAPSHOT"
+
+val DefaultVersion: String = "0.1.0-SNAPSHOT"
+
+lazy val SelectedVersion: String =
+  InputVersion
+    .map(v => s"$v$Modifier")
+    .getOrElse(DefaultVersion)
+
+lazy val publishSettings = Seq(
+  publishMavenStyle      := true,
+  Test / publishArtifact := false,
+  pomIncludeRepository   := Function.const(false),
+  scmInfo := Some(
+    ScmInfo(
+      url(s"https://git.garrity.co/garrity-software/$ProjectName"),
+      s"git@git.garrity.co:garrity-software/$ProjectName.git"
+    )
+  ),
+  description := Description,
+  licenses := List(
+    "Apache 2.0" -> url("https://www.apache.org/licenses/LICENSE-2.0.html")
+  ),
+  homepage := Some(
+    url(s"https://git.garrity.co/garrity-software/$ProjectName")
+  ),
+  publishTo := {
+    val repo = "https://maven.garrity.co/"
+    if (!IsRelease)
+      Some("Garrity Software Maven" at repo + "snapshots")
+    else
+      Some("Garrity Software Maven" at repo + "gs")
+  }
+)
+
+lazy val root = Project(ProjectName, file("."))
+  .enablePlugins(SbtPlugin)
+  .settings(publishSettings)
+  .settings(
+    name    := ProjectName,
+    version := SelectedVersion,
+    libraryDependencies ++= Seq(
+      "com.lihaoyi" %% "os-lib" % "0.9.3"
+    ),
+    pluginCrossBuild / sbtVersion := {
+      scalaBinaryVersion.value match {
+        // Minimum SBT version compatible with this plugin.
+        case "2.12" => "1.9.0"
+      }
+    },
+    scalacOptions := Seq(
+      "-unchecked",
+      "-deprecation",
+      "-feature",
+      "-encoding",
+      "utf8"
+    )
+  )

project/build.properties

@@ -0,0 +1 @@
+sbt.version=1.9.8

project/plugins.sbt

@@ -0,0 +1 @@
+credentials += Credentials(Path.userHome / ".sbt" / ".credentials")

src/main/scala/gs/CalVer.scala

@@ -0,0 +1,6 @@
+package gs
+
+case class CalVer(value: String)
+
+object CalVer {
+}

src/main/scala/gs/CalVerKeys.scala

@@ -0,0 +1,21 @@
+package gs
+
+import sbt._
+
+/** Defines all setting and task keys for the GS CalVer SBT Plugin.
+  */
+object CalVerKeys {
+
+  /** SBT Setting for the calculated CalVer.
+    */
+  lazy val calVer = settingKey[String](
+    "Calculated CalVer."
+  )
+
+  /** Task which emits the current version at the informational log level.
+    */
+  lazy val calVerInfo = taskKey[Unit](
+    "Dump the calculated version information."
+  )
+
+}

src/main/scala/gs/CalVerPlugin.scala

@@ -0,0 +1,31 @@
+package gs
+
+import sbt._
+
+object CalVerPlugin extends AutoPlugin {
+  override def trigger = allRequirements
+
+  val autoImport = CalVerKeys
+
+  import autoImport._
+
+  // Perform all version calculations and expose as a variable.
+  lazy val calVerDefaults: Seq[Setting[_]] = {
+    // Expose the relevant values as setting keys.
+    Seq(
+      calVer := ""
+    )
+  }
+
+  // Automatically exposed globally.
+  override lazy val globalSettings: Seq[Setting[_]] = calVerDefaults
+
+  // Add the custom task.
+  override lazy val buildSettings: Seq[Setting[_]] = Seq(
+    calVerInfo := {
+      val log = Keys.streams.value.log
+      log.info(s"[CalVer] Version: ${calVer.value}")
+    }
+  )
+
+}

src/main/scala/gs/Git.scala

@@ -0,0 +1,29 @@
+package gs
+
+//import java.io.File
+//import scala.util.Try
+
+object Git {
+
+  /*def getLatestSemVer(): SemVer = {
+    // Suppress all error output. Suppress exceptions for the failed process.
+    // Capture the standard output and parse it if the command succeeds.
+    val result = os
+      .proc("git", "describe", "--tags", "--abbrev=0")
+      .call(
+        stderr = os.ProcessOutput(
+          (
+            _,
+            _
+          ) => ()
+        ),
+        check = false
+      )
+
+    if (result.exitCode != 0)
+      SemVer.DefaultVersion
+    else
+      SemVer.parse(result.out.text()).getOrElse(SemVer.DefaultVersion)
+  }*/
+
+}

src/main/scala/gs/PluginProperties.scala

@@ -0,0 +1,45 @@
+package gs
+
+import sbt._
+import scala.util.Try
+
+/** Helper for managing all SBT command line properties (`-Dproperty=value`).
+  */
+object PluginProperties {
+
+  /** Helper to extract the value from `-Dproperty=value`.
+    *
+    * @param name
+    *   The property name.
+    * @param conv
+    *   The conversion function to the output type.
+    * @return
+    *   The converted value, or `None` if no value exists.
+    */
+  def getProperty[A](
+    name: String,
+    conv: String => A
+  ): Option[A] =
+    Option(System.getProperty(name)).map(conv)
+
+    /** Use one of the following to calculate an incremented release version:
+      *
+      *   - `sbt -Drelease=major`
+      *   - `sbt -Drelease=minor`
+      *   - `sbt -Drelease=patch`
+      */
+    val ReleaseProperty: String = "release"
+
+    /** The value of `-Drelease=<true|false>`, parsed and validated.
+     *
+     *  If no value is specified, `false` is assumed.
+      *
+      * @return
+      *   The `release` setting passed as input to SBT.
+      */
+    def isRelease(): Boolean =
+      getProperty(
+        ReleaseProperty,
+        raw => Try(raw.toBoolean).getOrElse(false)
+      ).getOrElse(false)
+}