You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pekko.apache.org by md...@apache.org on 2023/02/01 17:26:02 UTC
[incubator-pekko-sbt-paradox] 01/01: Initial commit
This is an automated email from the ASF dual-hosted git repository.
mdedetrich pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-pekko-sbt-paradox.git
commit 25848b57b5c83a7b0026c4abbf8c7e9c11d78752
Author: Matthew de Detrich <ma...@aiven.io>
AuthorDate: Wed Feb 1 18:25:24 2023 +0100
Initial commit
---
.github/workflows/format.yml | 24 +++
.gitignore | 20 +++
.scalafmt.conf | 77 +++++++++
LICENSE | 201 +++++++++++++++++++++++
README.md | 41 +++++
build.sbt | 67 ++++++++
plugin/org/apache/pekko/PekkoParadoxPlugin.scala | 44 +++++
project/build.properties | 1 +
project/plugins.sbt | 4 +
9 files changed, 479 insertions(+)
diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml
new file mode 100644
index 0000000..9d330b6
--- /dev/null
+++ b/.github/workflows/format.yml
@@ -0,0 +1,24 @@
+name: Scalafmt
+
+permissions: read-all
+
+on:
+ pull_request:
+ branches: ['**']
+
+jobs:
+ build:
+ name: Code is formatted
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout current branch (full)
+ uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
+ persist-credentials: false
+
+ - name: Check project is formatted
+ uses: jrouly/scalafmt-native-action@v2
+ with:
+ version: '3.7.1'
+ arguments: '--list --mode diff-ref=origin/main'
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..7232a54
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,20 @@
+### SBT template
+# Simple Build Tool
+# http://www.scala-sbt.org/release/docs/Getting-Started/Directories.html#configuring-version-control
+
+dist/*
+target/
+lib_managed/
+src_managed/
+project/boot/
+project/plugins/project/
+.history
+.cache
+.lib/
+
+### Scala template
+*.class
+*.log
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
diff --git a/.scalafmt.conf b/.scalafmt.conf
new file mode 100644
index 0000000..e9ade36
--- /dev/null
+++ b/.scalafmt.conf
@@ -0,0 +1,77 @@
+version = 3.7.1
+runner.dialect = scala213
+project.git = false
+style = defaultWithAlign
+docstrings.style = Asterisk
+docstrings.wrap = false
+indentOperator.preset = spray
+maxColumn = 120
+lineEndings = preserve
+rewrite.rules = [RedundantParens, SortImports, AvoidInfix]
+indentOperator.exemptScope = all
+align.preset = some
+align.tokens."+" = [
+ {
+ code = "~>"
+ owners = [
+ { regex = "Term.ApplyInfix" }
+ ]
+ }
+]
+literals.hexDigits = upper
+literals.hexPrefix = lower
+binPack.unsafeCallSite = always
+binPack.unsafeDefnSite = always
+binPack.indentCallSiteSingleArg = false
+binPack.indentCallSiteOnce = true
+newlines.avoidForSimpleOverflow = [slc]
+newlines.source = keep
+newlines.beforeMultiline = keep
+align.openParenDefnSite = false
+align.openParenCallSite = false
+align.allowOverflow = true
+optIn.breakChainOnFirstMethodDot = false
+optIn.configStyleArguments = false
+danglingParentheses.preset = false
+spaces.inImportCurlyBraces = true
+rewrite.neverInfix.excludeFilters = [
+ and
+ min
+ max
+ until
+ to
+ by
+ eq
+ ne
+ "should.*"
+ "contain.*"
+ "must.*"
+ in
+ ignore
+ be
+ taggedAs
+ thrownBy
+ synchronized
+ have
+ when
+ size
+ only
+ noneOf
+ oneElementOf
+ noElementsOf
+ atLeastOneElementOf
+ atMostOneElementOf
+ allElementsOf
+ inOrderElementsOf
+ theSameElementsAs
+ theSameElementsInOrderAs
+]
+rewriteTokens = {
+ "⇒": "=>"
+ "→": "->"
+ "←": "<-"
+}
+project.excludeFilters = [
+ "scripts/authors.scala"
+]
+project.layout = StandardConvention
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..f49a4e1
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,201 @@
+ 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.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..de8969e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# Pekko SBT Paradox
+
+This plugin is intended to extend the [sbt-paradox](https://github.com/lightbend/paradox) plugin with some settings
+along with providing the Apache Pekko theme.
+
+It is intended as a shared doc theme for the [Apache Pekko](https://github.com/apache/?q=pekko&type=all&language=&sort=)
+umbrella of projects, and not as a public theme to use on "any" project.
+
+This project is largely based on the original [akka-paradox](https://github.com/akka/akka-paradox) plugin. Credits go
+to the original [contributors](https://github.com/akka/akka-paradox/graphs/contributors) of the project.
+
+## Usage
+
+Use the sbt plugin for Pekko Paradox:
+```sbt
+addSbtPlugin("org.apache.pekko" % "pekko-sbt-paradox" % "<version>")
+```
+
+Enable it instead of the upstream ParadoxPlugin:
+```sbt
+import org.apache.pekko.PekkoParadoxPlugin
+
+enablePlugins(PekkoParadoxPlugin)
+```
+
+For more settings refer to the [Paradox documentation](https://developer.lightbend.com/docs/paradox/latest/)
+
+## Testing
+
+When you have made changes to akka-paradox, you can test it locally with:
+
+```
+sbt publishLocal sbtPlugin/scripted
+```
+
+This should show:
+
+```
+Pausing in /tmp/sbt_e457458e/simple
+Press enter to continue.
+```
diff --git a/build.sbt b/build.sbt
new file mode 100644
index 0000000..f2944c5
--- /dev/null
+++ b/build.sbt
@@ -0,0 +1,67 @@
+scalaVersion := "2.13.10"
+
+licenses += "Apache-2.0" -> url("https://www.apache.org/licenses/LICENSE-2.0.html")
+
+lazy val apacheBaseRepo = "repository.apache.org"
+
+def apacheNexusCredentials: Seq[Credentials] =
+ (sys.env.get("NEXUS_USER"), sys.env.get("NEXUS_PW")) match {
+ case (Some(user), Some(password)) =>
+ Seq(Credentials("Sonatype Nexus Repository Manager", apacheBaseRepo, user, password))
+ case _ =>
+ Seq.empty
+ }
+
+lazy val publishSettings = Seq(
+ credentials ++= apacheNexusCredentials,
+ organizationName := "Apache Software Foundation",
+ organizationHomepage := Some(url("https://www.apache.org")),
+ sonatypeCredentialHost := apacheBaseRepo,
+ sonatypeProfileName := "org.apache.pekko",
+ startYear := Some(2022),
+ developers := List(
+ Developer(
+ "pekko-contributors",
+ "Apache Pekko Contributors",
+ "dev@pekko.apache.org",
+ url("https://github.com/apache/incubator-pekko/graphs/contributors"))),
+ publishMavenStyle := true,
+ pomIncludeRepository := (_ => false))
+
+lazy val pekkoParadox = project
+ .in(file("."))
+ .settings(
+ publish / skip := true)
+ .aggregate(pekkoTheme, pekkoPlugin)
+
+lazy val pekkoTheme = project
+ .in(file("theme"))
+ .enablePlugins(ParadoxThemePlugin)
+ .settings(
+ organization := "org.apache.pekko",
+ name := "pekko-theme-paradox")
+ .settings(publishSettings)
+
+lazy val pekkoPlugin = project
+ .in(file("plugin"))
+ .enablePlugins(SbtPlugin)
+ .settings(
+ sbtPlugin := true,
+ organization := "org.apache.pekko",
+ name := "pekko-sbt-paradox",
+ scriptedLaunchOpts := {
+ scriptedLaunchOpts.value ++
+ Seq("-Xmx1024M", "-Dplugin.version=" + version.value)
+ },
+ scriptedBufferLog := false,
+ addSbtPlugin(
+ // When updating the sbt-paradox version,
+ // remember to also update project/plugins.sbt
+ "com.lightbend.paradox" % "sbt-paradox" % "0.10.3"),
+ addSbtPlugin("com.lightbend.paradox" % "sbt-paradox-apidoc" % "1.0.0"),
+ addSbtPlugin("com.lightbend.paradox" % "sbt-paradox-project-info" % "3.0.0"),
+ Compile / resourceGenerators += Def.task {
+ val file = (Compile / resourceManaged).value / "pekko-paradox.properties"
+ IO.write(file, s"pekko.paradox.version=${version.value}")
+ Seq(file)
+ }).settings(publishSettings)
diff --git a/plugin/org/apache/pekko/PekkoParadoxPlugin.scala b/plugin/org/apache/pekko/PekkoParadoxPlugin.scala
new file mode 100644
index 0000000..02e96fd
--- /dev/null
+++ b/plugin/org/apache/pekko/PekkoParadoxPlugin.scala
@@ -0,0 +1,44 @@
+package org.apache.pekko
+
+import sbt._
+import sbt.Keys._
+import com.lightbend.paradox.markdown.{ ContainerBlockDirective, Directive, Writer }
+import com.lightbend.paradox.sbt.ParadoxPlugin
+import org.pegdown.Printer
+import org.pegdown.ast.{ DirectiveNode, Visitor }
+
+object PekkoParadoxPlugin extends AutoPlugin {
+
+ import ParadoxPlugin.autoImport._
+
+ val version = ParadoxPlugin.readProperty("pekko-paradox.properties", "pekko.paradox.version")
+
+ override def requires = ParadoxPlugin
+
+ override def trigger = noTrigger
+
+ override def projectSettings: Seq[Setting[_]] = pekkoParadoxSettings(Compile)
+
+ def pekkoParadoxGlobalSettings: Seq[Setting[_]] = Seq(
+ paradoxTheme := Some("org.apache.pekko" % "pekko-theme-paradox" % version),
+ paradoxNavigationDepth := 1,
+ paradoxNavigationExpandDepth := Some(1),
+ paradoxNavigationIncludeHeaders := true,
+ paradoxDirectives += SidenoteDirective)
+
+ def pekkoParadoxSettings(config: Configuration): Seq[Setting[_]] = pekkoParadoxGlobalSettings ++ inConfig(config)(Seq(
+ // scoped settings here
+ ))
+
+ object SidenoteDirective extends ContainerBlockDirective("sidenote") with (Writer.Context => Directive) {
+ def apply(context: Writer.Context): Directive = SidenoteDirective
+
+ def render(node: DirectiveNode, visitor: Visitor, printer: Printer): Unit = {
+ val classes = node.attributes.classesString
+ printer.print(s"""<div class="sidenote $classes">""")
+ node.contentsNode.accept(visitor)
+ printer.print("""</div>""")
+ }
+ }
+
+}
diff --git a/project/build.properties b/project/build.properties
new file mode 100644
index 0000000..46e43a9
--- /dev/null
+++ b/project/build.properties
@@ -0,0 +1 @@
+sbt.version=1.8.2
diff --git a/project/plugins.sbt b/project/plugins.sbt
new file mode 100644
index 0000000..f54aa59
--- /dev/null
+++ b/project/plugins.sbt
@@ -0,0 +1,4 @@
+// When updating the sbt-paradox version,
+// remember to also update build.sbt
+addSbtPlugin("com.lightbend.paradox" % "sbt-paradox-theme" % "0.10.3")
+addSbtPlugin("com.github.sbt" % "sbt-ci-release" % "1.5.11")
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org