Merge branch 'master' into emimunoz/53-action-preview

Author: munozemilio

README.md

@@ -6,6 +6,8 @@
 [![Build Status](https://travis-ci.org/Microsoft/botbuilder-java.svg?branch=master)](https://travis-ci.org/Microsoft/botbuilder-java)
 [![Coverage Status](https://coveralls.io/repos/github/microsoft/botbuilder-java/badge.svg?branch=823847c676b7dbb0fa348a308297ae375f5141ef)](https://coveralls.io/github/microsoft/botbuilder-java?branch=823847c676b7dbb0fa348a308297ae375f5141ef)
 [![roadmap badge](https://img.shields.io/badge/visit%20the-roadmap-blue.svg)](https://github.com/Microsoft/botbuilder-java/wiki/Roadmap)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Microsoft/botbuilder-java/blob/master/LICENSE)
+[![Gitter](https://img.shields.io/gitter/room/Microsoft/BotBuilder.svg)](https://gitter.im/Microsoft/BotBuilder)
 
 This repository contains code for the Java version of the Microsoft Bot Framework SDK. The Bot Framework SDK v4 enable developers to model conversation and build sophisticated bot applications.
 
@@ -31,7 +33,7 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio
 
 This project uses linting rules to enforce code standardization. These rules are specified in the file [bot-checkstyle.xml](./etc/bot-checkstyle.xml) with [CheckStyle](https://checkstyle.org/) and are hooked to Maven's build cycle.
 
-**INFO**: Since the CheckStyle plugin is hook to the build cycle, this makes the build **fail** in case there are linting warnings in the project files so be sure to check that the code doesn't break any rule.
+**INFO**: Since the CheckStyle and PMD plugins are hooked into the build cycle, this makes the build **fail** in cases where there are linting warnings in the project files.  Errors will be in the file ./target/checkstyle-result.xml and ./target/pmd.xml.
 
 CheckStyle is available in different flavours:
 - [Visual Studio Code plugin](https://marketplace.visualstudio.com/items?itemName=shengchen.vscode-checkstyle)
@@ -41,6 +43,32 @@ CheckStyle is available in different flavours:
 
 **INFO**: Be sure to configure your IDE to use the file [bot-checkstyle.xml](./etc/bot-checkstyle.xml) instead of the default rules.
 
+## Build and IDE
+
+Any IDE that can import and work with Maven projects should work.  As a matter of practice we use the command line to perform Maven builds.  If your IDE can be configured to defer build and run to Maven it should also work.
+- Java
+  - We use the [Azul JDK 8](https://www.azul.com/downloads/azure-only/zulu/?version=java-8-lts&architecture=x86-64-bit&package=jdk) to build and test with.  While not a requirement to develop the SDK with, it is recommended as this is what Azure is using for Java 1.8.  If you do install this JDK, make sure your IDE is targeting that JVM, and your path (from command line) and JAVA_HOME point to that.
+  
+- Visual Studio Code
+  - Extensions
+    - Java Extension Pack by Microsoft
+    - Checkstyle for Java by ShengChen (Optional)
+    - EditorConfig for VS Code by EditorConfig (Recommended)
+  - Recommended setup
+    - Open the settings for "Language Support for Java by RedHat" and set:
+      - Java > Format > Settings: Profile = "BotFramework"
+      - Java > Format > Settings: Url = "etc/botframework-java-formatter.xml"
+      - This will format the code (on command) to BotFramework style.
+    
+- IntelliJ
+  - Extensions
+    - Checkstyle by IDEA
+    - Eclipse Code Formatter by Vojtech-Krasa (Recommended)
+  - Recommended setup
+    - When importing the SDK for the first time, make sure "Auto import" is checked.
+    - If the Eclipse Code Formatter was installed:
+      - Got to Settings > Other Settings -> Eclipse Code Formatter, and set the formatter config file to etc/botframework-java-formatter.xml
+
 ## Reporting Security Issues
 
 Security issues and bugs should be reported privately, via email, to the Microsoft Security

etc/bot-checkstyle.xml

@@ -69,12 +69,12 @@
 
     <!-- Miscellaneous other checks.                   -->
     <!-- See http://checkstyle.sourceforge.net/config_misc.html -->
-    <module name="RegexpSingleline">
+    <!-- <module name="RegexpSingleline">
        <property name="format" value="\s+$"/>
        <property name="minimum" value="0"/>
        <property name="maximum" value="0"/>
        <property name="message" value="Line has trailing spaces."/>
-    </module>
+    </module> -->
 
     <!-- Checks for Headers                                -->
     <!-- See http://checkstyle.sourceforge.net/config_header.html   -->

etc/botframework-java-formatter.xml

@@ -7,7 +7,8 @@
 import java.util.concurrent.CompletableFuture;
 
 /**
- * Middleware to automatically call .SaveChanges() at the end of the turn for all BotState class it is managing.
+ * Middleware to automatically call .SaveChanges() at the end of the turn for
+ * all BotState class it is managing.
  */
 public class AutoSaveStateMiddleware implements Middleware {
     /**
@@ -67,15 +68,16 @@ public AutoSaveStateMiddleware add(BotState botState) {
     }
 
     /**
-     * Middleware implementation which calls savesChanges automatically at the end of the turn.
+     * Middleware implementation which calls savesChanges automatically at the end
+     * of the turn.
      *
      * @param turnContext The context object for this turn.
-     * @param next        The delegate to call to continue the bot middleware pipeline.
+     * @param next        The delegate to call to continue the bot middleware
+     *                    pipeline.
      * @return A task representing the asynchronous operation.
      */
     @Override
     public CompletableFuture<Void> onTurn(TurnContext turnContext, NextDelegate next) {
-        return next.next()
-            .thenCompose(result -> botStateSet.saveAllChanges(turnContext));
+        return next.next().thenCompose(result -> botStateSet.saveAllChanges(turnContext));
     }
 }

libraries/bot-builder/src/main/java/com/microsoft/bot/builder/ActivityHandler.java

@@ -12,8 +12,9 @@ public interface Bot {
     /**
      * When implemented in a bot, handles an incoming activity.
      *
-     * @param turnContext The context object for this turn. Provides information about the
-     *                    incoming activity, and other data needed to process the activity.
+     * @param turnContext The context object for this turn. Provides information
+     *                    about the incoming activity, and other data needed to
+     *                    process the activity.
      * @return A task that represents the work queued to execute.
      */
     CompletableFuture<Void> onTurn(TurnContext turnContext);