commit 390f9a92c37f7952a23c812b9bbf8712ee6329d8 Author: Pat Garrity Date: Fri Jan 12 22:23:04 2024 -0600 Baseline plugin version. diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..89fee26 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +target/ +project/target/ +project/project/ +modules/core/target/ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..4489a18 --- /dev/null +++ b/.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 diff --git a/.scalafmt.conf b/.scalafmt.conf new file mode 100644 index 0000000..80e6cc9 --- /dev/null +++ b/.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/**" + ] +} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..bd999af --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# gs-sbt-plugin + +General SBT plugin for Garrity Software projects. This plugin should not be used +for non-GS projects. + +## Usage + +**File: project/plugins.sbt** +```scala +resolvers += "Garrity Software Releases" at "https://maven.garrity.co/gs" + +addSbtPlugin("gs" % "gs-sbt-plugin" % "0.1.0") +``` + +**File: build.sbt** +```scala +ThisBuild / gsProjectName := "project-name" +``` diff --git a/build.sbt b/build.sbt new file mode 100644 index 0000000..45b1f8a --- /dev/null +++ b/build.sbt @@ -0,0 +1,83 @@ +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-garrity-software" +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, + 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" + ) + ) diff --git a/project/build.properties b/project/build.properties new file mode 100644 index 0000000..abbbce5 --- /dev/null +++ b/project/build.properties @@ -0,0 +1 @@ +sbt.version=1.9.8 diff --git a/project/plugins.sbt b/project/plugins.sbt new file mode 100644 index 0000000..291bb34 --- /dev/null +++ b/project/plugins.sbt @@ -0,0 +1 @@ +credentials += Credentials(Path.userHome / ".sbt" / ".credentials") diff --git a/src/main/scala/gs/Gs.scala b/src/main/scala/gs/Gs.scala new file mode 100644 index 0000000..c17c553 --- /dev/null +++ b/src/main/scala/gs/Gs.scala @@ -0,0 +1,59 @@ +package gs; + +object Gs { + /** + * Standard compiler options used by GS projects. + */ + val CompilerOptions: Seq[String] = Seq( + "-encoding", + "utf8", // Set source file character encoding. + "-deprecation", // Emit warning and location for usages of deprecated APIs. + "-feature", // Emit warning and location for usages of features that should be imported explicitly. + "-explain", // Explain errors in more detail. + "-unchecked", // Enable additional warnings where generated code depends on assumptions. + "-explain-types", // Explain type errors in more detail. + "-Xfatal-warnings", // Fail the compilation if there are any warnings. + "-language:strictEquality", // Enable multiversal equality (require CanEqual) + "-Wunused:implicits", // Warn if an implicit parameter is unused. + "-Wunused:explicits", // Warn if an explicit parameter is unused. + "-Wunused:imports", // Warn if an import selector is not referenced. + "-Wunused:locals", // Warn if a local definition is unused. + "-Wunused:privates", // Warn if a private member is unused. + "-Ysafe-init" // Enable the experimental safe initialization check. + ) + + /** + * Definition of the Apache 2.0 license. This is the default license for GS + * open source projects. + */ + val Apache2: (String, java.net.URL) = + "Apache 2.0" -> sbt.url("https://www.apache.org/licenses/LICENSE-2.0.html") + + /** + * Host of the GS Git server. + */ + val GitHost: String = "git.garrity.co" + + /** + * Organization name used to organize projects in Git. + */ + val GitOrganization: String = "garrity-software" + + /** + * Calculate the Git repository for a project. + * + * @param projectName The project name. + * @return The HTTPS Git repository URL. + */ + def gitRepo(projectName: String): String = + s"https://$GitHost/$GitOrganization/$projectName" + + /** + * Calculate the Git SSH target for a project. + * + * @param projectName The project name. + * @return The SSH target. + */ + def gitSsh(projectName: String): String = + s"git@$GitHost:$GitOrganization/${projectName}.git" +} diff --git a/src/main/scala/gs/GsKeys.scala b/src/main/scala/gs/GsKeys.scala new file mode 100644 index 0000000..6d7502e --- /dev/null +++ b/src/main/scala/gs/GsKeys.scala @@ -0,0 +1,17 @@ +package gs + +import sbt._ + +/** Defines all setting and task keys for the GS SBT Plugin. + */ +object GsKeys { + + /** + * Required setting for projects using the Garrity Software plugin. This + * value must match the Git repository name. This value is used to configure + * publishing and generate sub-project names. + */ + lazy val gsProjectName = settingKey[String]( + "Name of the project and Git repository." + ) +} diff --git a/src/main/scala/gs/GsPlugin.scala b/src/main/scala/gs/GsPlugin.scala new file mode 100644 index 0000000..84f0633 --- /dev/null +++ b/src/main/scala/gs/GsPlugin.scala @@ -0,0 +1,41 @@ +package gs + +import sbt._ +import sbt.Keys._ + +object GsPlugin extends AutoPlugin { + override def trigger = allRequirements + + val autoImport = GsKeys + + import autoImport._ + + override def projectSettings: Seq[Setting[_]] = Seq( + publishMavenStyle := true, + Test / Keys.publishArtifact := false, + pomIncludeRepository := Function.const(false), + scmInfo := Some( + ScmInfo( + browseUrl = url(Gs.gitRepo(gsProjectName.value)), + connection = Gs.gitSsh(gsProjectName.value) + ) + ), + licenses := List(Gs.Apache2), + homepage := Some(url(Gs.gitRepo(gsProjectName.value))), + organizationName := "garrity software", + organization := "gs", + organizationHomepage := Some(url("https://garrity.co/")), + publishTo := { + val repo = "https://maven.garrity.co/" + if (Keys.version.value.endsWith("SNAPSHOT")) + Some("Garrity Software Maven" at repo + "snapshots") + else + Some("Garrity Software Maven" at repo + "releases") + }, + scalacOptions := { + val prev = Keys.scalacOptions.value + prev ++ Gs.CompilerOptions + } + ) + +}