Skip to content

Commit

Permalink
Merge pull request #11265 from PromanSEW/remove-play-enhancer
Browse files Browse the repository at this point in the history
[2.8.x] Remove play-enhancer from docs, project is dead
  • Loading branch information
mergify[bot] committed May 5, 2022
2 parents a931af7 + d4230ca commit 57fe175
Show file tree
Hide file tree
Showing 9 changed files with 1 addition and 86 deletions.
2 changes: 0 additions & 2 deletions documentation/build.sbt
Expand Up @@ -4,7 +4,6 @@

import com.typesafe.play.docs.sbtplugin.Imports._
import com.typesafe.play.docs.sbtplugin._
import com.typesafe.play.sbt.enhancer.PlayEnhancer
import play.core.PlayVersion
import playbuild.JavaVersion
import playbuild.CrossJava
Expand All @@ -18,7 +17,6 @@ val DocsApplication = config("docs").hide

lazy val main = Project("Play-Documentation", file("."))
.enablePlugins(PlayDocsPlugin, SbtTwirl)
.disablePlugins(PlayEnhancer)
.settings(
// Avoid the use of deprecated APIs in the docs
scalacOptions ++= Seq("-deprecation"),
Expand Down
Expand Up @@ -116,7 +116,7 @@ Additionally, Ebean has been upgraded to 4.5.x, which pulls in a few of the feat

### Bytecode enhancement

[[Play's bytecode enhancement|PlayEnhancer]], which generates getters and setters for Java properties, has been pulled out of the core of Play into a separately managed project that can have its own lifecycle. To enable it, add the following to your `project/plugins.sbt` file:
Play's bytecode enhancement, which generates getters and setters for Java properties, has been pulled out of the core of Play into a separately managed project that can have its own lifecycle. To enable it, add the following to your `project/plugins.sbt` file:

```scala
addSbtPlugin("com.typesafe.sbt" % "sbt-play-enhancer" % "1.1.0")
Expand Down
1 change: 0 additions & 1 deletion documentation/manual/working/commonGuide/build/Build.md
Expand Up @@ -7,7 +7,6 @@ This section gives details about Play's build system.
- [[About sbt settings|sbtSettings]]
- [[Manage application dependencies|sbtDependencies]]
- [[Working with sub-projects|sbtSubProjects]]
- [[Play enhancer|PlayEnhancer]]
- [[Aggregating reverse routers|AggregatingReverseRouters]]
- [[Improving Compilation Times|CompilationSpeed]]
- [[Cookbook|sbtCookbook]]
Expand Down
52 changes: 0 additions & 52 deletions documentation/manual/working/commonGuide/build/PlayEnhancer.md

This file was deleted.

22 changes: 0 additions & 22 deletions documentation/manual/working/commonGuide/build/code/enhancer.sbt

This file was deleted.

1 change: 0 additions & 1 deletion documentation/manual/working/commonGuide/build/index.toc
Expand Up @@ -3,7 +3,6 @@ BuildOverview:Overview of the build system
sbtSettings:About sbt settings
sbtDependencies:Manage application dependencies
sbtSubProjects:Working with sub-projects
PlayEnhancer:Play enhancer
AggregatingReverseRouters:Aggregating reverse routers
CompilationSpeed:Improving Compilation Times
sbtCookbook:Cookbook
Expand Down
@@ -1,8 +1,6 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->
# Handling form submission

Before you start with Play forms, read the documentation on the [[Play enhancer|PlayEnhancer]]. The Play enhancer generates accessors for fields in Java classes for you, so that you don't have to generate them yourself. You may decide to use this as a convenience. All the examples below show manually writing accessors for your classes.

## Enabling/Disabling the forms module

By default, Play includes the Java forms module (`play-java-forms`) when enabling the `PlayJava` sbt plugin, so there is nothing to enable if you already have `enablePlugins(PlayJava)` on your project.
Expand Down
2 changes: 0 additions & 2 deletions documentation/manual/working/javaGuide/main/tests/JavaTest.md
Expand Up @@ -80,8 +80,6 @@ In this way, the `UserService.isAdmin` method can be tested by mocking the `User

@[test-model-test](code/javaguide/tests/ModelTest.java)

> **Note:** Applications using Ebean ORM may be written to rely on Play's automatic getter/setter generation. If this is your case, check how [[Play enhancer sbt plugin|PlayEnhancer]] works.
## Unit testing controllers

You can test your controllers using Play's [test helpers](api/java/play/test/Helpers.html) to extract useful properties.
Expand Down
3 changes: 0 additions & 3 deletions documentation/project/plugins.sbt
Expand Up @@ -10,9 +10,6 @@ lazy val playDocsPlugin = ProjectRef(Path.fileProperty("user.dir").getParentFile
// Required for Production.md
addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "0.14.5")

// Required for PlayEnhancer.md
addSbtPlugin("com.typesafe.sbt" % "sbt-play-enhancer" % "1.2.2")

// Add headers to example sources
addSbtPlugin("de.heikoseeberger" % "sbt-header" % "5.7.0")
addSbtPlugin("com.lightbend.sbt" % "sbt-java-formatter" % "0.5.1")
Expand Down

0 comments on commit 57fe175

Please sign in to comment.