Merge pull request #72 from jonas/gh-67-gitbook-mappings

#67 gitbook mappings

README.md

@@ -5,7 +5,7 @@
 
 [ ![Download](https://api.bintray.com/packages/sbt/sbt-plugin-releases/sbt-site/images/download.svg) ](https://bintray.com/sbt/sbt-plugin-releases/sbt-site-imported/_latestVersion)
 
-This sbt plugin generates project websites from static content, [Jekyll], [Sphinx], [Pamflet], [Nanoc], [GitBook], and/or [Asciidoctor], and can optionally include generated ScalaDoc. It is designed to work hand-in-hand with publishing plugins like [sbt-ghpages].
+This sbt plugin generates project websites from static content, [Jekyll], [Sphinx], [Pamflet], [Nanoc], [GitBook], [Paradox] and/or [Asciidoctor], and can optionally include generated ScalaDoc. It is designed to work hand-in-hand with publishing plugins like [sbt-ghpages].
 
 **Table of Contents**
 
@@ -25,7 +25,7 @@ This sbt plugin generates project websites from static content, [Jekyll], [Sphin
 	- [Packaging and Publishing](#packaging-and-publishing)
 	- [Advanced Usage](#advanced-usage)
 	- [License](#license)
-	
+
 ## Usage
 
 `sbt-site` is deployed as an `AutoPlugin`. To enable, simply add the following to your `project/plugins.sbt` file:
@@ -46,34 +46,34 @@ When you run `makeSite`, your project's webpage is generated in the `target/site
 
 The `src/site` directory can be overridden via the `siteSourceDirectory` key:
 
-```
+```sbt
 siteSourceDirectory <<= target / "generated-stuff"
 ```
 
 Additional files outside of `siteSourceDirectory` can be added individually via the `siteMappings` key:
 
-```
+```sbt
 siteMappings ++= Seq(file1 -> "location.html", file2 -> "image.png")
 ```
 
 ### Static Content with Variable Substitution
 The site plugin supports basic variable substitution when copying files from `src/site-preprocess`. To enable, add this to your `build.sbt` file:
 
-```
+```sbt
 enablePlugins(PreprocessPlugin)
 ```
 
 Variables are delimited by surrounding the name with `@` symbols (e.g. `@VERSION@`). Values are assigned to variables via the setting `preprocessVars: [Map[String, String]]`. For example:
 
-```
+```sbt
 preprocessVars := Map("VERSION" -> version.value, "DATE" -> new Date().toString)
 ```
 
 Note that the plugin will generate an error if a variable is found in the source file with no matching value in `preprocessVars`.
 
 The setting `preprocessIncludeFilter` is used to define the filename extensions that should be processed when `makeSite` is run.
 
-```
+```sbt
 preprocessIncludeFilter := "*.md" | "*.markdown"
 ```
 
@@ -82,26 +82,26 @@ The default filter is `"*.txt" | "*.html" | "*.md" | "*.rst"`.
 ### Jekyll Site Generation
 The `sbt-site` plugin has direct support for running [Jekyll]. This is useful for supporting custom Jekyll plugins that are not allowed when publishing to GitHub, or hosting a Jekyll site on your own server. To add Jekyll support, enable the associated plugin:
 
-```
+```sbt
 enablePlugins(JekyllPlugin)
 ```
 
 This assumes you have a Jekyll project in the `src/jekyll` directory. To change this, set the key `sourceDirectory` in the `Jekyll` scope:
 
-```
+```sbt
 sourceDirectory in Jekyll := sourceDirectory.value / "hyde"
 ```
 
 To redirect the output to a subdirectory of `target/site`, use the `siteSubdirName` key in `Jekyll` scope:
 
-```
+```sbt
 // Puts output in `target/site/notJekyllButHyde`
 siteSubdirName in Jekyll := "notJekyllButHyde"
 ```
 
 One common issue with Jekyll is ensuring that everyone uses the same version for generating a website. There is special support for ensuring the version of gems. To do so, add the following to your `build.sbt` file:
 
-```
+```sbt
 requiredGems := Map(
   "jekyll" -> "0.11.2",
   "liquid" -> "2.3.0"
@@ -111,19 +111,19 @@ requiredGems := Map(
 ### Sphinx Site Generation
 The `sbt-site` plugin has direct support for building [Sphinx] projects. To enable Sphinx site generation, simply enable the associated plugin in your `build.sbt` file:
 
-```
+```sbt
 enablePlugins(SphinxPlugin)
 ```
 
 This assumes you have a Sphinx project under the `src/sphinx` directory. To change this, set the `sourceDirectory` key in the `Sphinx` scope:
 
-```
+```sbt
 sourceDirectory in Sphinx := sourceDirectory.value / "androsphinx"
 ```
 
 Similarly, the output can be redirected to a subdirectory of `target/site` via the `siteSubdirName` key in `Sphinx` scope:
 
-```
+```sbt
 // Puts output in `target/site/giza`
 siteSubdirName in Sphinx := "giza"
 ```
@@ -132,19 +132,19 @@ siteSubdirName in Sphinx := "giza"
 
 The `sbt-site` plugin has direct support for building [Pamflet] projects. To enable Pamflet site generation, simply enable the associated plugin in your `build.sbt` file:
 
-```
+```sbt
 enablePlugins(PamfletPlugin)
 ```
 
 This assumes you have a Pamflet project under the `src/pamflet` directory. To change this, set the `sourceDirectory` key in the `Pamflet` scope:
 
-```
+```sbt
 sourceDirectory in Pamflet := sourceDirectory.value / "papyrus"
 ```
 
 Similarly, the output can be redirected to a subdirectory of `target/site` via the `siteSubdirName` key in `Pamflet` scope:
 
-```
+```sbt
 // Puts output in `target/site/parchment`
 siteSubdirName in Pamflet := "parchment"
 ```
@@ -153,19 +153,19 @@ siteSubdirName in Pamflet := "parchment"
 
 The `sbt-site` plugin has direct support for building [Nanoc] projects. To enable Nanoc site generation, simply enable the associated plugin in your `build.sbt` file:
 
-```
+```sbt
 enablePlugins(NanocPlugin)
 ```
 
 This assumes you have a Nanoc project under the `src/nanoc` directory. To change this, set the `sourceDirectory` key in the `Nanoc` scope:
 
-```
+```sbt
 sourceDirectory in Nanoc := sourceDirectory.value / "conan"
 ```
 
 Similarly, the output can be redirected to a subdirectory of `target/site` via the `siteSubdirName` key in `Nanoc` scope:
 
-```
+```sbt
 // Puts output in `target/site/conan`
 siteSubdirName in Nanoc := "conan"
 ```
@@ -174,19 +174,19 @@ siteSubdirName in Nanoc := "conan"
 ### Asciidoctor Site Generation
 The `sbt-site` plugin has direct support for building [Asciidoctor] projects. To enable Asciidoctor site generation, simply enable the associated plugin in your `build.sbt` file:
 
-```
+```sbt
 enablePlugins(AsciidoctorPlugin)
 ```
 
 This assumes you have an Asciidoctor project under the `src/asciidoctor` directory. To change this, set the `sourceDirectory` key in the `Asciidoctor` scope:
 
-```
+```sbt
 sourceDirectory in Asciidoctor := sourceDirectory.value / "asciimd"
 ```
 
 Similarly, the output can be redirected to a subdirectory of `target/site` via the `siteSubdirName` key in `Asciidoctor` scope:
 
-```
+```sbt
 // Puts output in `target/site/asciimd`
 siteSubdirName in Asciidoctor := "asciimd"
 ```
@@ -196,26 +196,26 @@ siteSubdirName in Asciidoctor := "asciimd"
 
 The `sbt-site` plugin has direct support for building [GitBook] projects. To enable GitBook site generation, simply enable the associated plugin in your `build.sbt` file:
 
-```
+```sbt
 enablePlugins(GitBookPlugin)
 ```
 
 This assumes you have a GitBook project under the `src/gitbook` directory. To change this, set the `sourceDirectory` key in the `GitBook` scope:
 
-```
+```sbt
 sourceDirectory in GitBook := sourceDirectory.value / "doc"
 ```
 
 Similarly, the output can be redirected to a subdirectory of `target/site` via the `siteSubdirName` key in `GitBook` scope:
 
-```
+```sbt
 // Puts output in `target/site/book`
 siteSubdirName in GitBook := "book"
 ```
 
 The plugin can also be configured to manage all GitBook setup and installation by configuring a dedicated directory in which GitBook's npm packages can be installed.
 
-```scala
+```sbt
 gitbookInstallDir in GitBook := Some(baseDirectory.value / "node_modules" / "gitbook")
 ```
 
@@ -236,31 +236,31 @@ sourceDirectory in Paradox := sourceDirectory.value / "doc"
 ## ScalaDoc APIs
 To include ScalaDoc with your site, add the following line to your `build.sbt`:
 
-```
+```sbt
 enablePlugins(SiteScaladocPlugin)
 ```
 
 This will default to putting the ScalaDoc under the `latest/api` directory on the website. You can change this with the `siteSubdirName` key in the `SiteScaladoc` scope:
 
-```
+```sbt
 // Puts ScalaDoc output in `target/site/api/wip`
 siteSubdirName in SiteScaladoc := "api/wip"
 ```
 
-## Publishing to Github Pages
+## Publishing to GitHub Pages
 
 See the [sbt-ghpages] plugin for information about publishing to [GitHub Pages]. We expect other publishing mechanisms to be supported in the future.
 
 ## Previewing the Site
 To preview your generated site, run `previewSite`, which launches a web server on port 4000 and attempts to connect your browser to [http://localhost:4000/](http://localhost:4000/). To change the server port, use the key `previewFixedPort`:
 
-```
+```sbt
 previewFixedPort := Some(9999)
 ```
 
 To disable browser auto-open, use the key `previewLaunchBrowser`:
 
-```
+```sbt
 previewLaunchBrowser := false
 ```
 
@@ -269,17 +269,17 @@ To create a zip package of the site run `package-site`.
 
 To also include this zip file as an artifact when running `publish`, add the following to your `build.sbt`:
 
-```
+```sbt
 publishSite
 ```
 
-See the [`sbt-ghpages`](sbt-ghpages) plugin documentation for simplified publishing to [GitHub Pages].
+See the [sbt-ghpages] plugin documentation for simplified publishing to [GitHub Pages].
 
 ## Advanced Usage
 
-If you need to run a generator on more than one source directory, bypassing the `AutoPlugin` system and defining one or more sbt `Configuration`s is necessary. For example, suppose you two Pamflet source directories and want them each generated as a subdirectory under `target/site`. A `build.sbt` might look something like this:
+If you need to run a generator on more than one source directory, bypassing the `AutoPlugin` system and defining one or more sbt `Configuration`s is necessary. For example, suppose you have two Pamflet source directories and want them each generated as a subdirectory under `target/site`. A `build.sbt` might look something like this:
 
-```
+```sbt
 // Define two `Configuration` instances.
 val Site1 = config("site1")
 
@@ -316,7 +316,7 @@ Each of the other generators follow a similar pattern (e.g. `JekyllPlugin.jekyll
 [pamflet]: http://pamflet.databinder.net
 [nanoc]: http://nanoc.ws/
 [asciidoctor]: http://asciidoctor.org
-[gitbook]: https://help.gitbook.com/
+[gitbook]: https://toolchain.gitbook.com/
 [sphinx]: http://sphinx-doc.org
 [GitHub Pages]: https://pages.github.com
-[GitBook]: https://www.gitbook.com
+[paradox]: https://github.com/lightbend/paradox

src/main/scala/com/typesafe/sbt/site/gitbook/GitBookPlugin.scala

@@ -26,11 +26,13 @@ object GitBookPlugin extends AutoPlugin {
     inConfig(config)(
       Seq(
         includeFilter := AllPassFilter,
+        excludeFilter := HiddenFileFilter,
         gitbookInstallDir := None,
         mappings := generate(
           sourceDirectory.value,
           target.value,
           includeFilter.value,
+          excludeFilter.value,
           gitbookInstallDir.value,
           streams.value
         ),
@@ -42,7 +44,7 @@ object GitBookPlugin extends AutoPlugin {
       SiteHelpers.addMappingsToSiteDir(mappings in config, siteSubdirName in config)
 
   /** Run gitbook commands. */
-  private[sbt] def generate(src: File, target: File, inc: FileFilter, installDir: Option[File], s: TaskStreams): Seq[(File, String)] = {
+  private[sbt] def generate(src: File, target: File, inc: FileFilter, exc: FileFilter, installDir: Option[File], s: TaskStreams): Seq[(File, String)] = {
     val runEnv = installDir.map("HOME" -> _.getAbsolutePath).toSeq
     def run(cmd: String*) =
       Process(cmd.toSeq, Some(src), runEnv: _*) ! s.log match {
@@ -81,9 +83,8 @@ object GitBookPlugin extends AutoPlugin {
     }
 
     // Figure out what was generated.
-    for {
-      (file, name) <- (target ** inc --- target pair relativeTo(target))
-    } yield file -> name
+    val files = (target ** inc) --- (target ** exc) --- target
+    files pair relativeTo(target)
   }
 
   private[sbt] def bookJson(src: File): File = src / "book.json"

src/sbt-test/gitbook/ignore-dot-files/.bookignore

@@ -0,0 +1,5 @@
+project/
+target/
+boot/
+global/
+*.sbt

src/sbt-test/gitbook/ignore-dot-files/.gitignore

@@ -0,0 +1 @@
+_book

src/sbt-test/gitbook/ignore-dot-files/README.md

@@ -0,0 +1,12 @@
+# Hello, GitBook!
+
+The SBT site plugin can build your http://gitbook.com[GitBook] documentation.
+
+## First Section
+
+ - item 1
+ - item 2
+
+```scala
+case class User(name: String, age: Int)
+```

src/sbt-test/gitbook/ignore-dot-files/SUMMARY.md

@@ -0,0 +1 @@
+# Summary

src/sbt-test/gitbook/ignore-dot-files/book.json

@@ -0,0 +1,3 @@
+{
+  "gitbook": "3.x.x"
+}  

src/sbt-test/gitbook/ignore-dot-files/build.sbt

@@ -0,0 +1,30 @@
+name := "test"
+
+enablePlugins(GitBookPlugin)
+
+sourceDirectory in GitBook := baseDirectory.value
+siteSubdirName in GitBook := "docs"
+
+val gitHeadPath = ".git/HEAD"
+
+initialize := {
+  // Create .git test file before running makeSite
+  IO.write(baseDirectory.value / gitHeadPath, "test")
+}
+
+TaskKey[Unit]("checkContent") := {
+  val dest = (target in makeSite).value / (siteSubdirName in GitBook).value
+
+  val generatedGitFile = baseDirectory.value / gitHeadPath
+  assert(generatedGitFile.exists, s"${generatedGitFile.getAbsolutePath} did not exist")
+
+  for (path <- Seq("index.html")) {
+    val file = dest / path
+    assert(file.exists, s"${file.getAbsolutePath} did not exist")
+  }
+
+  for (path <- Seq(gitHeadPath, ".gitignore", ".bookignore", "target", "project")) {
+    val file = dest / path
+    assert(!file.exists, s"${file.getAbsolutePath} should not exist")
+  }
+}

src/sbt-test/gitbook/ignore-dot-files/project/plugins.sbt

@@ -0,0 +1 @@
+addSbtPlugin("com.typesafe.sbt" % "sbt-site" % sys.props("project.version"))

src/sbt-test/gitbook/ignore-dot-files/test

@@ -0,0 +1,2 @@
+> make-site
+> checkContent