diff --git a/README.md b/README.md index eff2f4e..958d6bb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ + + # play-doc [![Twitter Follow](https://img.shields.io/twitter/follow/playframework?label=follow&style=flat&logo=twitter&color=brightgreen)](https://twitter.com/playframework) diff --git a/build.sbt b/build.sbt index 99eaa92..40400b0 100644 --- a/build.sbt +++ b/build.sbt @@ -1,3 +1,9 @@ +// Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. + +import de.heikoseeberger.sbtheader.HeaderPlugin.autoImport.HeaderPattern.commentBetween +import de.heikoseeberger.sbtheader.CommentStyle +import de.heikoseeberger.sbtheader.FileType +import de.heikoseeberger.sbtheader.LineCommentCreator // Customise sbt-dynver's behaviour to make it work with tags which aren't v-prefixed (ThisBuild / dynverVTagPrefix) := false @@ -9,7 +15,7 @@ Global / onLoad := (Global / onLoad).value.andThen { s => } lazy val `play-doc` = (project in file(".")) - .enablePlugins(Omnidoc, SbtTwirl) + .enablePlugins(Omnidoc, SbtTwirl, HeaderPlugin) .settings( organization := "org.playframework", organizationName := "The Play Framework Project", @@ -23,7 +29,23 @@ lazy val `play-doc` = (project in file(".")) "contact@playframework.com", url("https://github.com/playframework") ), - pomIncludeRepository := { _ => false }, + headerLicense := Some( + HeaderLicense.Custom( + "Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. " + ) + ), + headerMappings ++= Map( + FileType("sbt") -> HeaderCommentStyle.cppStyleLineComment, + FileType("properties") -> HeaderCommentStyle.hashLineComment, + FileType("md") -> CommentStyle(new LineCommentCreator(""), commentBetween("")) + ), + (Compile / headerSources) ++= + ((baseDirectory.value ** ("*.properties" || "*.md" || "*.sbt")) + --- (baseDirectory.value ** "target" ** "*") + --- (baseDirectory.value / "src/test/resources" ** "*")).get ++ + (baseDirectory.value / "project" ** "*.scala" --- (baseDirectory.value ** "target" ** "*")).get, + (Test / headerResources) := Seq(), + pomIncludeRepository := { _ => false }, scalacOptions ++= { CrossVersion.partialVersion(scalaVersion.value) match { case Some((2, _)) => @@ -71,6 +93,7 @@ scalacOptions ++= Seq( addCommandAlias( "validateCode", List( + "headerCheckAll", "scalafmtSbtCheck", "scalafmtCheckAll", ).mkString(";") diff --git a/project/Omnidoc.scala b/project/Omnidoc.scala index 1ee7e79..7eacbb6 100644 --- a/project/Omnidoc.scala +++ b/project/Omnidoc.scala @@ -1,3 +1,7 @@ +/* + * Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. + */ + import sbt._ import sbt.Keys._ import sbt.Package.ManifestAttributes diff --git a/project/build.properties b/project/build.properties index e8a1e24..a47b4b2 100644 --- a/project/build.properties +++ b/project/build.properties @@ -1 +1,3 @@ +# Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. + sbt.version=1.9.7 diff --git a/project/plugins.sbt b/project/plugins.sbt index f3d9684..a3b1e20 100644 --- a/project/plugins.sbt +++ b/project/plugins.sbt @@ -1,3 +1,6 @@ +// Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. + addSbtPlugin("org.playframework.twirl" % "sbt-twirl" % "2.0.1") addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.5.2") addSbtPlugin("com.github.sbt" % "sbt-ci-release" % "1.5.12") +addSbtPlugin("de.heikoseeberger" % "sbt-header" % "5.10.0") diff --git a/src/main/java/play/doc/CodeReferenceNode.java b/src/main/java/play/doc/CodeReferenceNode.java index 777433c..897341c 100644 --- a/src/main/java/play/doc/CodeReferenceNode.java +++ b/src/main/java/play/doc/CodeReferenceNode.java @@ -1,3 +1,7 @@ +/* + * Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. + */ + package play.doc; import org.pegdown.ast.AbstractNode; diff --git a/src/main/java/play/doc/CodeReferenceParser.java b/src/main/java/play/doc/CodeReferenceParser.java index 3616f79..d86e18b 100644 --- a/src/main/java/play/doc/CodeReferenceParser.java +++ b/src/main/java/play/doc/CodeReferenceParser.java @@ -1,3 +1,7 @@ +/* + * Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. + */ + package play.doc; import org.parboiled.Rule; diff --git a/src/main/java/play/doc/TocNode.java b/src/main/java/play/doc/TocNode.java index d90d77a..31f9a32 100644 --- a/src/main/java/play/doc/TocNode.java +++ b/src/main/java/play/doc/TocNode.java @@ -1,3 +1,7 @@ +/* + * Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. + */ + package play.doc; import org.pegdown.ast.AbstractNode; diff --git a/src/main/java/play/doc/TocParser.java b/src/main/java/play/doc/TocParser.java index 01406e2..8d5a5a2 100644 --- a/src/main/java/play/doc/TocParser.java +++ b/src/main/java/play/doc/TocParser.java @@ -1,3 +1,7 @@ +/* + * Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. + */ + package play.doc; import org.parboiled.Rule; diff --git a/src/main/java/play/doc/VariableNode.java b/src/main/java/play/doc/VariableNode.java index be7e11c..123e71a 100644 --- a/src/main/java/play/doc/VariableNode.java +++ b/src/main/java/play/doc/VariableNode.java @@ -1,3 +1,7 @@ +/* + * Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. + */ + package play.doc; import org.pegdown.ast.AbstractNode; diff --git a/src/main/java/play/doc/VariableParser.java b/src/main/java/play/doc/VariableParser.java index 7cbdb2a..3e4e06a 100644 --- a/src/main/java/play/doc/VariableParser.java +++ b/src/main/java/play/doc/VariableParser.java @@ -1,3 +1,7 @@ +/* + * Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. + */ + package play.doc; import org.parboiled.Rule; diff --git a/src/main/scala/play/doc/FileRepository.scala b/src/main/scala/play/doc/FileRepository.scala index 14aa878..c277bf9 100644 --- a/src/main/scala/play/doc/FileRepository.scala +++ b/src/main/scala/play/doc/FileRepository.scala @@ -1,3 +1,7 @@ +/* + * Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. + */ + package play.doc import java.io.FileInputStream diff --git a/src/main/scala/play/doc/PageIndex.scala b/src/main/scala/play/doc/PageIndex.scala index 0a1b257..5325a87 100644 --- a/src/main/scala/play/doc/PageIndex.scala +++ b/src/main/scala/play/doc/PageIndex.scala @@ -1,3 +1,7 @@ +/* + * Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. + */ + package play.doc import org.apache.commons.io.IOUtils diff --git a/src/main/scala/play/doc/PlayDoc.scala b/src/main/scala/play/doc/PlayDoc.scala index 21364b2..d4526f2 100644 --- a/src/main/scala/play/doc/PlayDoc.scala +++ b/src/main/scala/play/doc/PlayDoc.scala @@ -1,3 +1,7 @@ +/* + * Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. + */ + package play.doc import java.io.InputStream diff --git a/src/main/scala/play/doc/PlayDocTemplates.scala b/src/main/scala/play/doc/PlayDocTemplates.scala index 8a73f77..125f15a 100644 --- a/src/main/scala/play/doc/PlayDocTemplates.scala +++ b/src/main/scala/play/doc/PlayDocTemplates.scala @@ -1,3 +1,7 @@ +/* + * Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. + */ + package play.doc /** diff --git a/src/main/scala/play/doc/PrettifyVerbatimSerializer.scala b/src/main/scala/play/doc/PrettifyVerbatimSerializer.scala index 87b109d..96a32e7 100644 --- a/src/main/scala/play/doc/PrettifyVerbatimSerializer.scala +++ b/src/main/scala/play/doc/PrettifyVerbatimSerializer.scala @@ -1,3 +1,7 @@ +/* + * Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. + */ + package play.doc import org.pegdown.Printer diff --git a/src/test/scala/play/doc/FileRepositorySpec.scala b/src/test/scala/play/doc/FileRepositorySpec.scala index 7a6f122..439132d 100644 --- a/src/test/scala/play/doc/FileRepositorySpec.scala +++ b/src/test/scala/play/doc/FileRepositorySpec.scala @@ -1,3 +1,7 @@ +/* + * Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. + */ + package play.doc import org.specs2.mutable.Specification diff --git a/src/test/scala/play/doc/PageIndexSpec.scala b/src/test/scala/play/doc/PageIndexSpec.scala index 14ee236..93b3c9c 100644 --- a/src/test/scala/play/doc/PageIndexSpec.scala +++ b/src/test/scala/play/doc/PageIndexSpec.scala @@ -1,3 +1,7 @@ +/* + * Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. + */ + package play.doc import java.io.File diff --git a/src/test/scala/play/doc/PlayDocSpec.scala b/src/test/scala/play/doc/PlayDocSpec.scala index 113bca3..00f4d2f 100644 --- a/src/test/scala/play/doc/PlayDocSpec.scala +++ b/src/test/scala/play/doc/PlayDocSpec.scala @@ -1,3 +1,7 @@ +/* + * Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. + */ + package play.doc import org.specs2.mutable._