add pre-commit hook for dotnet-format (#4362)

Author: Chris Elion

.circleci/config.yml

@@ -113,6 +113,23 @@ jobs:
             # Need ruby for search-and-replace
             sudo apt-get update
             sudo apt-get install ruby-full
+
+            # install dotnet and the formatter - see https://docs.microsoft.com/en-us/dotnet/core/install/linux-debian#debian-9-
+            pushd ~
+            wget -O - https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor > microsoft.asc.gpg
+            sudo mv microsoft.asc.gpg /etc/apt/trusted.gpg.d/
+            wget https://packages.microsoft.com/config/debian/9/prod.list
+            sudo mv prod.list /etc/apt/sources.list.d/microsoft-prod.list
+            sudo chown root:root /etc/apt/trusted.gpg.d/microsoft.asc.gpg
+            sudo chown root:root /etc/apt/sources.list.d/microsoft-prod.list
+            popd
+
+            sudo apt-get install -y apt-transport-https && \
+              sudo apt-get update && \
+              sudo apt-get install -y dotnet-sdk-3.1 && \
+              dotnet tool install -g dotnet-format --version 4.1.131201
+
+            echo "Setting up venv"
             python3 -m venv venv
             . venv/bin/activate
             pip install --upgrade pip
@@ -131,6 +148,7 @@ jobs:
           name: Check Code Style using pre-commit
           command: |
             . venv/bin/activate
+            export PATH="$PATH:~/.dotnet/tools"
             pre-commit run --show-diff-on-failure --all-files
 
   markdown_link_check:

com.unity.ml-agents/.editorconfig renamed to .editorconfig

@@ -132,5 +132,9 @@ repos:
         name: validate release links
         language: script
         entry: utils/validate_release_links.py
-
+    -   id: dotnet-format
+        name: dotnet-format
+        language: script
+        entry: utils/run_dotnet_format.py
+        types: [c#]
 

.pre-commit-config.yaml

@@ -161,7 +161,7 @@ public void TestCollectObservationsAgentMarkers()
         {
             using (Measure.ProfilerMarkers(s_Markers))
             {
-                for(var i=0; i<k_MarkerTestSteps; i++)
+                for (var i = 0; i < k_MarkerTestSteps; i++)
                 {
                     RunAgent<CollectObservationsAgent>(k_NumAgentSteps, 7, ObservableAttributeOptions.Ignore);
                 }

DevProject/Assets/ML-Agents/Scripts/Tests/Performance/SensorPerformanceTests.cs

@@ -1,4 +1,4 @@
-#if UNITY_CLOUD_BUILD
+#if UNITY_CLOUD_BUILD
 using UnityEditor;
 
 public class DisableBurstFromMenu

Project/Assets/ML-Agents/Editor/DisableBurstFromMenu.cs

@@ -13,7 +13,8 @@ public class CrawlerAgent : Agent
     Vector3 m_WalkDir; //Direction to the target
     Quaternion m_WalkDirLookRot; //Will hold the rotation to our target
 
-    [Header("Target To Walk Towards")] [Space(10)]
+    [Header("Target To Walk Towards")]
+    [Space(10)]
     public TargetController target; //Target the agent will walk towards.
 
     [Header("Body Parts")] [Space(10)] public Transform body;
@@ -27,20 +28,23 @@ public class CrawlerAgent : Agent
     public Transform leg3Lower;
 
 
-    [Header("Orientation")] [Space(10)]
+    [Header("Orientation")]
+    [Space(10)]
     //This will be used as a stabilized model space reference point for observations
     //Because ragdolls can move erratically during training, using a stabilized reference transform improves learning
     public OrientationCubeController orientationCube;
 
     JointDriveController m_JdController;
 
-    [Header("Reward Functions To Use")] [Space(10)]
+    [Header("Reward Functions To Use")]
+    [Space(10)]
     public bool rewardMovingTowardsTarget; // Agent should move towards target
 
     public bool rewardFacingTarget; // Agent should face the target
     public bool rewardUseTimePenalty; // Hurry up
 
-    [Header("Foot Grounded Visualization")] [Space(10)]
+    [Header("Foot Grounded Visualization")]
+    [Space(10)]
     public bool useFootGroundedVisualization;
 
     public MeshRenderer foot0;
@@ -208,8 +212,8 @@ void RewardFunctionMovingTowards()
         {
             throw new ArgumentException(
                 "NaN in movingTowardsDot.\n" +
-                $" orientationCube.transform.forward: {orientationCube.transform.forward}\n"+
-                $" body.velocity: {m_JdController.bodyPartsDict[body].rb.velocity}\n"+
+                $" orientationCube.transform.forward: {orientationCube.transform.forward}\n" +
+                $" body.velocity: {m_JdController.bodyPartsDict[body].rb.velocity}\n" +
                 $" maximumWalkingSpeed: {maximumWalkingSpeed}"
             );
         }
@@ -226,7 +230,7 @@ void RewardFunctionFacingTarget()
         {
             throw new ArgumentException(
                 "NaN in movingTowardsDot.\n" +
-                $" orientationCube.transform.forward: {orientationCube.transform.forward}\n"+
+                $" orientationCube.transform.forward: {orientationCube.transform.forward}\n" +
                 $" body.forward: {body.forward}"
             );
         }

Project/Assets/ML-Agents/Examples/Crawler/Scripts/CrawlerAgent.cs

@@ -50,7 +50,7 @@ public void Update()
         // Send stats via SideChannel so that they'll appear in TensorBoard.
         // These values get averaged every summary_frequency steps, so we don't
         // need to send every Update() call.
-        if ((Time.frameCount % 100)== 0)
+        if ((Time.frameCount % 100) == 0)
         {
             m_Recorder.Add("TotalScore", totalScore);
         }

Project/Assets/ML-Agents/Examples/FoodCollector/Scripts/FoodCollectorSettings.cs

@@ -40,29 +40,29 @@ public override void WriteDiscreteActionMask(IDiscreteActionMask actionMask)
         // Mask the necessary actions if selected by the user.
         if (maskActions)
         {
-           // Prevents the agent from picking an action that would make it collide with a wall
+            // Prevents the agent from picking an action that would make it collide with a wall
             var positionX = (int)transform.position.x;
             var positionZ = (int)transform.position.z;
             var maxPosition = (int)m_ResetParams.GetWithDefault("gridSize", 5f) - 1;
 
             if (positionX == 0)
             {
-                actionMask.WriteMask(0, new []{ k_Left});
+                actionMask.WriteMask(0, new[] { k_Left });
             }
 
             if (positionX == maxPosition)
             {
-                actionMask.WriteMask(0, new []{k_Right});
+                actionMask.WriteMask(0, new[] { k_Right });
             }
 
             if (positionZ == 0)
             {
-                actionMask.WriteMask(0, new []{k_Down});
+                actionMask.WriteMask(0, new[] { k_Down });
             }
 
             if (positionZ == maxPosition)
             {
-                actionMask.WriteMask(0, new []{k_Up});
+                actionMask.WriteMask(0, new[] { k_Up });
             }
         }
     }

Project/Assets/ML-Agents/Examples/GridWorld/Scripts/GridAgent.cs

@@ -2,7 +2,7 @@
 
 using UnityEngine;
 
-namespace  MLAgentsExamples
+namespace MLAgentsExamples
 {
     public class AdjustTrainingTimescale : MonoBehaviour
     {

Project/Assets/ML-Agents/Examples/SharedAssets/Scripts/AdjustTrainingTimescale.cs

@@ -1,10 +1,10 @@
-using UnityEngine;
+using UnityEngine;
 
 namespace Unity.MLAgentsExamples
 {
     public class DirectionIndicator : MonoBehaviour
     {
-       
+
         public bool updatedByAgent; //should this be updated by the agent? If not, it will use local settings
         public Transform transformToFollow; //ex: hips or body
         public Transform targetToLookAt; //target in the scene the indicator will point to