Fix #65: assure incomplete input doesn't pass compilation

.travis.yml

@@ -10,24 +10,25 @@ before_cache:
   - find $HOME/.ivy2 -name "ivydata-*.properties" -delete
   - find $HOME/.sbt -name "*.lock" -delete
 
-jdk:
-  - oraclejdk8
-
-scala:
-  - 2.10.6
-  - 2.12.2
-  - 2.13.0-M1
-
 matrix:
   include:
-    - scala: 2.11.8
+    - scala: 2.10.6
+      env: TEST_SCRIPTED=0
+      jdk: oraclejdk8
+    - scala: 2.11.12
       env: TEST_SCRIPTED=1
       jdk: oraclejdk8
+    - scala: 2.12.4
+      env: TEST_SCRIPTED=0
+      jdk: oraclejdk8
+    - scala: 2.13.0-M3
+      env: TEST_SCRIPTED=0
+      jdk: oraclejdk8
 
 script:
   - sbt ++$TRAVIS_SCALA_VERSION core/compile core/publishLocal
   - sbt plugin/compile plugin/publishLocal
-  - "if [[ $TEST_SCRIPTED = 1 ]]; then sbt scripted; fi"
+  - "if [[ $TEST_SCRIPTED = 1 ]]; then sbt tests/scripted; fi"
 
 notifications:
   webhooks:

CHANGELOG.md

@@ -2,6 +2,33 @@
 
 This file summarizes **notable** changes for each release, but does not describe internal changes unless they are particularly exciting. For complete details please see the corresponding [milestones](https://github.com/tpolecat/tut/milestones?state=closed) and their associated issues.
 
+### <a name="0.6.2"></a>Work in Progress for Version 0.6.3
+
+- `fork in (Tut, run) := true` now works for real, sorry (thanks again @metasim).
+- Build is now modern and uses `sbt-release` (finally!) so publishing is no longer a nightmare.
+
+
+### <a name="0.6.2"></a>New and Noteworthy for Version 0.6.2
+
+This release forward-ports improvements from 0.5.5 and 0.5.6.
+
+- New `passthrough` modifier for code that generates markdown (thanks @metasim).
+- `fork in (Tut, run) := true` now works (thanks again @metasim).
+- `scalacOptions in Tut` now defaults to `scalacOptions in Test` which allows Scalameta to work properly (it doesn't work in console for some reason ... thanks @kailuowang and @suhasgaddam).
+- Fixes stack overflows with large input files and cleans up the FP micro-library.
+
+### <a name="0.6.1"></a>New and Noteworthy for Version 0.6.1
+
+This updates scala-xml to 1.0.6 as required by Scala 2.13.0-M1, and reverts removal of 2.10 support. Thanks :sparkles: Frank Thomas :sparkles: for this contribution.
+
+### <a name="0.6.0"></a>New and Noteworthy for Version 0.6.0
+
+First release for sbt 1.0, courtesy of sparkly :sparkles: Lars Hupel :sparkles:.
+
+------
+
+*See the `master` branch for further developments in the 0.5.x series.*
+
 ### <a name="0.5.2"></a>New and Noteworthy for Version 0.5.2
 
 Somehow :confused: tpolecat :confused: botched the 0.5.1 release, which didn't actually include the only change it was intended to include. This uh, fixes that.

README.md

@@ -1,193 +1,10 @@
 # tut
 
-<img src="https://api.travis-ci.org/tpolecat/tut.svg?branch=master"/><br>
+[![Travis CI](https://travis-ci.org/tpolecat/tut.svg?branch=series%2F0.6.x)](https://travis-ci.org/tpolecat/tut)
 [![Join the chat at https://gitter.im/tpolecat/tut](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/tpolecat/tut?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 <img alt="How'd you get so funky?" align=right src="tut.jpg"/>
 
 **tut** is a very simple documentation tool for Scala that reads Markdown files and interprets Scala code in `tut` sheds, allowing you to write documentation that is typechecked and run as part of your build.
 
-The current version is **0.5.2** (changelog [here](CHANGELOG.md), upgrade instructions for 0.5.x series [here](#0.5.x)) which runs on **Scala 2.10**, **2.11**, and **2.12**.
-
-Projects using **tut** include [doobie](https://github.com/tpolecat/doobie), [frameless](https://github.com/typelevel/frameless) and [cats](https://github.com/typelevel/cats). If you're using it and would like be added to the list, please submit a PR!
-
-**tut** is a [Typelevel](http://typelevel.org/) project. This means we embrace pure, typeful, functional programming, and provide a safe and friendly environment for teaching, learning, and contributing as described in the Typelevel [Code of Conduct](http://typelevel.org/conduct.html).
-
-### Quick Start (sbt)
-
-**1**. Add the following to `project/plugins.sbt`:
-
-```scala
-addSbtPlugin("org.tpolecat" % "tut-plugin" % "0.5.2")
-```
-
-**2**.  And add the following to `build.sbt`:
-
-```scala
-enablePlugins(TutPlugin)
-```
-
-**3**.  Write a tutorial in `src/main/tut/Foo.md`:
-
-    Here is how you add numbers:
-    ```tut
-    1 + 1
-    ```
-
-**4**.  At the `sbt>` prompt type `tut`, then look at the output in `target/<scala-version>/tut/Foo.md`:
-
-    Here is how you add numbers:
-    ```scala
-    scala> 1 + 1
-    res0: Int = 2
-    ```
-
-### Quick Start (standalone)
-
-In case you want to run **tut** without sbt, you can use **coursier** instead.
-
-**1**. Install the **coursier** [command-line launcher](https://github.com/alexarchambault/coursier#command-line-1).
-
-**2**. Run **tut**:
-
-```
-coursier launch -r "https://dl.bintray.com/tpolecat/maven/" org.tpolecat:tut-core_2.11:0.5.2 -- \
-  in out '.*\.md$' -classpath $(coursier fetch -p com.chuusai:shapeless_2.11:2.3.1)
-```
-
-This will process all `*.md` files in `in`, write them to `out`, while providing `com.chuusai:shapeless_2.11:2.3.1` in the classpath.
-Note that the Scala library always needs to be in the classpath.
-
-### Commands
-
-**tut** adds the following commands:
-
-| Command  | Explanation |
-|----------|-------------|
-| `tut`    | Moves the contents of `tutSourceDirectory` into `tutTargetDirectory`, interpreting code in `tut` sheds in any file whose name matches `tutNameFilter` (other files are copied but not interpreted). |
-| `tutQuick` | Like `tut` but compiles only files that have changed since last compilation. Note that this does *not* detect changes in Scala sources; it only looks at tut sources. |
-| <code>tutOnly&nbsp;&lt;path&gt;</code> | Does the same thing as `tut` but only for the specified path under `tutSourceDirectory`. Note that tab completion works for this command |
-
-Interpretation obeys the following particulars:
-
-- Each file is interpreted with an independent REPL session. Definitions earlier in the file are available later in the file.
-- Each REPL has the same classpath as your build's `Test` configuration, and by default also has the same scalac options and compiler plugins.
-- By default any error in interpretation (compilation failure or runtime exception) will cause the `tut` command to fail. If this command is part of your CI configuration then your build will fail. Yay!
-- **tut** captures output from the REPL, as well as anything your code writes to standard output (`System.out`). ANSI escapes are removed from this output, so colorized console output will show up as plaintext.
-- In modes that show REPL prompts (see below) blank lines *in between statements* are discarded and a single blank line is introduced between prompts, as in the normal REPL. Otherwise blank lines are neither introduced nor discarded. This is a change from prior versions.
-
-
-### Modifiers
-
-By default **tut** will interpret code in `tut` sheds as if it had been pasted into a Scala REPL. However sometimes you might want a definition without REPL noise, or might want to demonstrate non-compiling code (which would normally cause the build to fail). For these occasions **tut** provides a number of modifiers that you can add to the shed declaration. For instance,
-
-    ```tut:silent
-    import com.woozle.fnord._
-    ```
-
-will produce the following output, suppressing REPL noise:
-
-    ```scala
-    import com.woozle.fnord._
-    ```
-
-The following modifiers are supported. Note that you can use multiples if you like; for example you could use `tut:silent:fail` to show code that doesn't compile, without showing the compilation error.
-
-| Modifier    | Explanation |
-|-------------|-------------|
-| `:fail`      | Code in the shed *must* throw an exception or fail to compile. Successful interpretation will cause a build failure. |
-| `:nofail`    | Code in the shed *might* throw an exception or fail to compile. Such failure will *not* cause a build failure. Note that this modifier is **deprecated** in favor of `:fail`. |
-| `:silent`    | Suppresses REPL prompts and output; under this modifier the input and output text are identical. |
-| `:plain`     | Output will not have `scala` syntax highlighting. |
-| `:invisible` | Suppresses all output. This is not recommended since the point of **tut** is to provide code that the user can type in and expect to work. But in rare cases you might want one of these at the bottom of your file to clean up filesystem mess that your code left behind. |
-| `:book`      | Output will be suitable for copy and paste into the REPL. That is, there are no REPL prompts or margins, and output from the REPL is commented. |
-| `:evaluated` | Suppresses REPL prompts and input statement, output only will be the evaluated statement. |
-| `:decorate(param)` | Decorates the output scala code block with `param`, enclosed in this way: `{: param }`, for use with Kramdown. You can add several `decorate` modifiers if you wish. |
-| `:reset`    | Resets the REPL state prior to evaluating the code block. Use this option with care, as it has no visible indication and can be confusing to readers who are following along in their own REPLs. |
-
-### Settings
-
-**tut** also adds the following sbt settings, all of which have reasonable defaults. It is unlikely that you will need to change any of them, but here you go.
-
-| Setting | Explanation | Default Value |
-|---------|-------------|---------------|
-| `tutSourceDirectory`  | Location of **tut** source files. | `(sourceDirectory.value in Compile) / "tut"` |
-| `tutNameFilter`       | Regex specifying files that should be interpreted. | Names ending in `.md` `.txt` `.htm` `.html` |
-| `tutTargetDirectory`  | Destination for **tut** output. | `crossTarget.value / "tut"` |
-| `scalacOptions in Tut` | Compiler options that will be passed to the **tut** REPL. | Same as `Test` configuration. |
-| `tutPluginJars`       | List of compiler plugin jarfiles to be passed to the **tut** REPL. | Same as `Test` configuration. |
-
-It's possible to add tut-specific dependencies through the `% "tut"` modifier.
-For example:
-
-```scala
-libraryDependencies += "org.scalacheck" %% "scalacheck" % "1.13.5" % "tut"
-```
-
-### <a name="0.5.x"></a>Upgrading from 0.4.x
-
-The 0.5.x series includes a few breaking changes from 0.4.x.
-
-##### tutSettings
-
-Tut is now an autoplugin, and its settings are imported automatically when it's enabled:
-
-* remove `tutSettings`
-* add `enablePlugins(TutPlugin)`
-
-##### tutScalacOptions
-
-This setting does not exist anymore, but you can replace it with `(scalacOptions in Tut)` everywhere it was used.
-
-##### Warnings on unused imports
-
-Tut does not filter out `-Ywarn-unused-imports` from its `scalacOptions` anymore. If you need to re-enable that behaviour, simply add:
-
-```scala
-scalacOptions in Tut := (scalacOptions in Tut).value.filterNot(Set("-Ywarn-unused-import"))
-```
-
-##### Missing dependencies
-
-Tut does not inherit its CLASSPATH from the `Test` configuration anymore. If this breaks your build, you can add missing dependencies manually by using the `% "tut"` modifier. For example:
-
-```scala
-libraryDependencies += "org.scalacheck" %% "scalacheck" % "1.13.5" % "tut"
-```
-
-
-### Integration with sbt-microsites
-
-The [sbt-microsites plugin](https://47deg.github.io/sbt-microsites/) uses **tut** and **sbt-site** and some other odds and ends to turn your documentation into a really nice little website. It is entirely excellent and I recommend it highly.
-
-### Integration with sbt-site
-
-If you wish to use **tut**  with [sbt-site](https://github.com/sbt/sbt-site) add the following to `project/plugins.sbt` in your project to add SBT shell commands:
-
-```scala
-addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "0.8.1")
-```
-
-Then in your build sbt, link the files generated by tut to your site generation:
-
-```scala
-project("name").settings(site.addMappingsToSiteDir(tut, "tut"))
-```
-
-When the `makeSite` task is run in sbt, the typechecked tutorials from `src/main/tut` will be incorporated with the site generated by sbt-site in `target/site`.
-
-### Running the Tests
-
-There are a set of test markdown files and corresponding expected markdown output from **tut**.
-Run these tests from sbt with:
-
-```
-publishLocal
-tests/scripted
-```
-
-### Complaints and other Feedback
-
-Feedback of any kind is always appreciated.
-
-Issues and PR's are welcome, or just find me on Twitter or `#scala` on FreeNode or on [gitter](https://gitter.im/tpolecat/tut).
+Please proceed to the [**microsite**](http://tpolecat.github.io/tut/) for more information.