Skip to content

Commit 83a175a

Browse files
committed
Doc updates, no longer forcing Scala version or options
1 parent e0398d8 commit 83a175a

File tree

9 files changed

+53
-25
lines changed

9 files changed

+53
-25
lines changed

doc/src/faq/audit.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1-
# Removing Unused Files from a Projectile Application
1+
# Removing Unused Files
2+
3+
## Auditing
4+
5+
On occasion, you'll remove something from your input.
6+
Because exporting the project never deletes files, you may need to run Projectile's auditing to clean up the trash.
7+
8+
GUI:
9+
Simply click "Audit" from the home page, and you'll see a report listing orphaned files (and other project checks).
10+
You can click "Fix All" to clean up the orphaned files and apply other cleanups
11+
12+
CLI:
13+
Run `projectile audit`, and you'll see a report listing orphaned files (and other project checks).
14+
You can run `projectile audit --fix` to clean up the orphaned files and apply other cleanups.
215

3-
TODO, sorry...

doc/src/faq/feature.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Enabling Features
2+
3+
Projectile projects can grow from a small utility to a intricate admin app.
4+
See the @ref[feature list](../codegen/database.md) for details on the available features for database projects.
5+
6+
Adding features enables new generated code. To do so, either run `projectile feature-set` (which will show detailed instructions), or click "Edit Features" in the project's page.

doc/src/faq/gui.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Accessing the Projectile GUI
1+
# Accessing the GUI
22

33
## Installing
44

doc/src/faq/index.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,15 @@
22

33
@@@ index
44

5-
* [Running the GUI](gui.md)
6-
* [Adding a new enum type](newenum.md)
7-
* [Adding a new table](newtable.md)
5+
* [Accessing the GUI](gui.md)
6+
* [Enabling Features](feature.md)
7+
* [Adding New Enums](newenum.md)
8+
* [Adding New Tables](newtable.md)
9+
* [Setting Model Packages](package.md)
810
* [Removing unused files](audit.md)
911

1012
@@@
1113

12-
TODO
14+
This is a work in progress, and will grow to include new solutions.
15+
16+
@@toc { depth=1 }

doc/src/faq/newenum.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1-
# Adding New Enums to a Projectile Application
1+
# Adding New Enums
22

3-
TODO, sorry...
3+
If you have a database project, you'll need to refresh the database after new types are added.
4+
To refresh, run `projectile refresh` or use the GUI.
5+
6+
If you have a Thrift or GraphQL project, the available types will be detected automatically.
7+
8+
Once you've added a new enum type, you can run `projectile update` (or click the update button on the project's detail page).
9+
It will display the newly added enums, now you may want to @ref[change the enum's package](package.md).

doc/src/faq/newtable.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1-
# Adding New Tables to a Projectile Application
1+
# Adding New Tables
2+
3+
If you have a database project, you'll need to refresh the database after new tables are added.
4+
To refresh, run `projectile refresh` or use the GUI.
5+
6+
If you have a Thrift or GraphQL project, the available types will be detected automatically.
7+
8+
Once you've added a new table or model type, you can run `projectile update` (or click the update button on the project's detail page).
9+
It will display the newly added models, now you may want to @ref[change the model's package](package.md).
210

3-
TODO, sorry...

doc/src/faq/package.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Setting Model Packages
2+
3+
By default, newly-added enums and models are part of the root package.
4+
This is fine to start, but for larger applications, you'll want to assign packages to group things together.
5+
6+
To do so, either run `projectile package-set` (which will show detailed instructions), or load the enum or model in the GUI.

project/Common.scala

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ object Common {
1010
val useLatest = false
1111

1212
object Versions {
13-
val app = "2.0.0-SNAPSHOT"
13+
val app = "1.19.1"
1414
val scala212 = "2.12.9"
1515
val scala213 = "2.13.0"
1616
val scala = if(useLatest) { scala213 } else { scala212 }

projectile-sbt-admin/src/main/scala/com/kyleu/projectile/sbt/ProjectilePlayProject.scala

-13
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,6 @@ object ProjectilePlayProject extends AutoPlugin {
3131
// Projectile
3232
libraryDependencies += autoImport.projectileLib("admin"),
3333

34-
// Scala
35-
scalaVersion := "2.12.9",
36-
37-
scalacOptions ++= Seq(
38-
"-target:jvm-1.8", "-encoding", "UTF-8", "-feature", "-deprecation", "-explaintypes", "-feature", "-unchecked",
39-
"–Xcheck-null", "-Xlint", "-Xcheckinit", "-Yrangepos", "-Ywarn-dead-code", "-Ywarn-numeric-widen"
40-
),
41-
42-
scalacOptions in (Compile, console) ~= (_.filterNot(Set("-Ywarn-unused:imports", "-Xfatal-warnings"))),
43-
scalacOptions in (Compile, doc) := Seq("-encoding", "UTF-8"),
44-
45-
evictionWarningOptions in update := EvictionWarningOptions.default.withWarnTransitiveEvictions(false).withWarnDirectEvictions(false),
46-
4734
// Packaging
4835
topLevelDirectory in Universal := None,
4936
packageSummary := description.value,

0 commit comments

Comments
 (0)