From 44d6dfa2c0b1b5790456c369f542b36101804d3f Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Tue, 28 Oct 2014 15:24:50 +0000 Subject: [PATCH] Include language in snippets so that their syntax can be highlighted cURL requests are marked as being bash and cURL responses are marked as being http. This allows their syntax to be highlighted in the resulting HTML. --- .../src/documentation/asciidoc/main.asciidoc | 2 +- .../src/documentation/asciidoc/main.asciidoc | 2 +- .../springframework/restdocs/core/DocumentationWriter.java | 7 +++++-- .../restdocs/core/RestDocumentationResultHandlers.java | 6 +++--- 4 files changed, 10 insertions(+), 7 deletions(-) diff --git a/rest-notes-spring-data-rest/src/documentation/asciidoc/main.asciidoc b/rest-notes-spring-data-rest/src/documentation/asciidoc/main.asciidoc index c766b93f..5f8e71db 100644 --- a/rest-notes-spring-data-rest/src/documentation/asciidoc/main.asciidoc +++ b/rest-notes-spring-data-rest/src/documentation/asciidoc/main.asciidoc @@ -3,7 +3,7 @@ Andy Wilkinson; :doctype: book :toc: :toclevels: 4 -:source-highlighter: prettify +:source-highlighter: highlightjs [introduction] = Introduction diff --git a/rest-notes-spring-hateoas/src/documentation/asciidoc/main.asciidoc b/rest-notes-spring-hateoas/src/documentation/asciidoc/main.asciidoc index a6ddf318..ab83ba4f 100644 --- a/rest-notes-spring-hateoas/src/documentation/asciidoc/main.asciidoc +++ b/rest-notes-spring-hateoas/src/documentation/asciidoc/main.asciidoc @@ -3,7 +3,7 @@ Andy Wilkinson; :doctype: book :toc: :toclevels: 4 -:source-highlighter: prettify +:source-highlighter: highlightjs [introduction] = Introduction diff --git a/spring-restdocs-core/src/main/java/org/springframework/restdocs/core/DocumentationWriter.java b/spring-restdocs-core/src/main/java/org/springframework/restdocs/core/DocumentationWriter.java index 872f3d15..c999e8ca 100644 --- a/spring-restdocs-core/src/main/java/org/springframework/restdocs/core/DocumentationWriter.java +++ b/spring-restdocs-core/src/main/java/org/springframework/restdocs/core/DocumentationWriter.java @@ -28,7 +28,7 @@ public class DocumentationWriter extends PrintWriter { } public void shellCommand(final DocumentationAction... actions) throws Exception { - codeBlock(new DocumentationAction() { + codeBlock("bash", new DocumentationAction() { @Override public void perform() throws Exception { @@ -54,8 +54,11 @@ public class DocumentationWriter extends PrintWriter { super.write(s); } - public void codeBlock(DocumentationAction... actions) throws Exception { + public void codeBlock(String language, DocumentationAction... actions) throws Exception { println(); + if (language != null) { + println("[source," + language + "]"); + } println("----"); for (DocumentationAction action : actions) { action.perform(); diff --git a/spring-restdocs-core/src/main/java/org/springframework/restdocs/core/RestDocumentationResultHandlers.java b/spring-restdocs-core/src/main/java/org/springframework/restdocs/core/RestDocumentationResultHandlers.java index f30b77fc..8fdbd64c 100644 --- a/spring-restdocs-core/src/main/java/org/springframework/restdocs/core/RestDocumentationResultHandlers.java +++ b/spring-restdocs-core/src/main/java/org/springframework/restdocs/core/RestDocumentationResultHandlers.java @@ -51,7 +51,7 @@ public abstract class RestDocumentationResultHandlers { @Override public void handle(MvcResult result, DocumentationWriter writer) throws Exception { - writer.codeBlock(new CurlResponseDocumentationAction(writer, result, + writer.codeBlock("http", new CurlResponseDocumentationAction(writer, result, getCurlConfiguration())); } }; @@ -64,7 +64,7 @@ public abstract class RestDocumentationResultHandlers { throws Exception { writer.shellCommand(new CurlRequestDocumentationAction(writer, result, getCurlConfiguration())); - writer.codeBlock(new CurlResponseDocumentationAction(writer, result, + writer.codeBlock("http", new CurlResponseDocumentationAction(writer, result, getCurlConfiguration())); } }; @@ -195,7 +195,7 @@ public abstract class RestDocumentationResultHandlers { printStream.close(); } } - + private PrintStream createPrintStream() throws FileNotFoundException {