Merge pull request #1201 from JetBrains/192-vk-unity-templates

Add more file templates for Unity + live templates

Author: krasnotsvetov

resharper/resharper-unity/src/CSharp/Feature/Services/LiveTemplates/Scope/InUnityCSharpProject.cs

@@ -10,7 +10,7 @@ namespace JetBrains.ReSharper.Plugins.Unity.CSharp.Feature.Services.LiveTemplate
     // other scope points. A template can declare that it requires this scope point, and
     // the template will only be made available if a ScopeProvider "publishes" this scope
     // point based on the current context (e.g. the project is a Unity project)
-    public class InUnityCSharpProject : InLanguageSpecificProject
+    public class InUnityCSharpProject : InLanguageSpecificProject, IMandatoryScopePoint
     {
         private static readonly Guid DefaultUID = new Guid("B37325A3-4F0A-405B-8A5C-00ECA4ED3B30");
         private static readonly Guid QuickUID = new Guid("D32F297F-E422-4612-839A-FE76D9914B34");

resharper/resharper-unity/src/CSharp/Feature/Services/LiveTemplates/Scope/IsAvailableForClassAttribute.cs

@@ -0,0 +1,14 @@
+using System;
+using JetBrains.ReSharper.LiveTemplates.CSharp.Context;
+
+namespace JetBrains.ReSharper.Plugins.Unity.CSharp.Feature.Services.LiveTemplates.Scope
+{
+    public class IsAvailableForClassAttribute : InCSharpFile
+    {
+        private static readonly Guid ourDefaultGuid = new Guid("AE22FA37-D337-48D7-B570-1ADE437DE6E3");
+
+        public override Guid GetDefaultUID() => ourDefaultGuid;
+        public override string PresentableShortName => "Where attribute for class is allowed";
+        public override string ToString() => "Where attribute for class is allowed";
+    }
+}

resharper/resharper-unity/src/CSharp/Feature/Services/LiveTemplates/Scope/UnityTypeScopeProvider.cs

@@ -4,6 +4,7 @@
 using JetBrains.ReSharper.Feature.Services.LiveTemplates.Context;
 using JetBrains.ReSharper.Feature.Services.LiveTemplates.LiveTemplates;
 using JetBrains.ReSharper.Feature.Services.LiveTemplates.Scope;
+using JetBrains.ReSharper.Psi.CSharp.Tree;
 using JetBrains.ReSharper.Psi.Files;
 using JetBrains.ReSharper.Psi.Tree;
 
@@ -15,6 +16,7 @@ public class UnityTypeScopeProvider : ScopeProvider
         public UnityTypeScopeProvider()
         {
             Creators.Add(TryToCreate<MustBeInUnityType>);
+            Creators.Add(TryToCreate<IsAvailableForClassAttribute>);
         }
 
         public override IEnumerable<ITemplateScopePoint> ProvideScopePoints(TemplateAcceptanceContext context)
@@ -36,7 +38,16 @@ public override IEnumerable<ITemplateScopePoint> ProvideScopePoints(TemplateAcce
             var element = psiFile?.FindTokenAt(caretOffset - prefix.Length);
             var typeDeclaration = element?.GetContainingNode<ITypeDeclaration>();
             if (typeDeclaration == null)
+            {
+                var siblingNode = element?.GetNextMeaningfulSibling();
+                while (siblingNode is IAttributeList)
+                {
+                    siblingNode = element.GetNextMeaningfulSibling();
+                }
+                if (siblingNode is IClassDeclaration) 
+                    yield return new IsAvailableForClassAttribute();
                 yield break;
+            }
 
             var unityApi = context.Solution.GetComponent<UnityApi>();
             if (unityApi.IsUnityType(typeDeclaration.DeclaredElement))

resharper/resharper-unity/src/CSharp/Feature/Services/LiveTemplates/UnityQuickListDefaultSettings.cs

@@ -38,7 +38,14 @@ public override void InitDefaultSettings(ISettingsStorageMountPoint mountPoint)
             // TODO: Not sure if this would be better handled in a .dotSettings file
             var pos = 0;
             AddToQuickList(mountPoint, myProjectMainPoint, "MonoBehaviour", ++pos, "5ff5ac38-7207-4256-91ae-b5436552db13");
+            AddToQuickList(mountPoint, myProjectMainPoint, "ScriptableObject", ++pos, "1404A333-DA7C-47AC-8CB5-7C944DD1422D");
+            AddToQuickList(mountPoint, myProjectMainPoint, "StateMachineBehaviour", ++pos, "AFA01340-773E-488A-93D6-E19540AE2F1B");
             AddToQuickList(mountPoint, myProjectMainPoint, "PlayModeTest", ++pos, "0bcdbc13-d26e-4512-9750-fb930f532e88");
+            AddToQuickList(mountPoint, myProjectMainPoint, "CustomEditor", ++pos, "2E5D288C-A209-41EE-93B2-7CACDCAE18C6");
+            AddToQuickList(mountPoint, myProjectMainPoint, "EditorWindow", ++pos, "CA9DFEEA-D5B5-4DDC-933F-8D618D71538E");
+            AddToQuickList(mountPoint, myProjectMainPoint, "PropertyDrawer", ++pos, "7901AA8B-4060-4763-8FD5-B7B5384FABAA");
+            AddToQuickList(mountPoint, myProjectMainPoint, "ScriptableWizard", ++pos, "E1BD73A0-0145-4A1A-B4AA-7744144744AF");
+            AddToQuickList(mountPoint, myProjectMainPoint, "AssetPostprocessor", ++pos, "B669492E-B3A6-4F98-9998-9AF480374340");
             AddToQuickList(mountPoint, myProjectMainPoint, "EditModeTest", ++pos, "7b7fa2c7-0ee5-4d4f-bb1f-ddbeacdbfc94");
             AddToQuickList(mountPoint, myProjectMainPoint, "StandardSurfaceShader", ++pos, "4b8178a2-8110-4068-a788-43b8227564e5");
             AddToQuickList(mountPoint, myProjectMainPoint, "UnlitShader", ++pos, "fdbd3ad2-8db2-466a-a934-4ce25cb40564");

resharper/resharper-unity/src/CSharp/Feature/Services/LiveTemplates/UnityScopeCategoryUIProvider.cs

@@ -20,6 +20,8 @@ public UnityScopeCategoryUIProvider()
 
         public override IEnumerable<ITemplateScopePoint> BuildAllPoints()
         {
+            yield return new IsAvailableForClassAttribute();
+            yield return new InUnityCSharpProject();
             yield return new MustBeInUnityType();
             yield return new InUnityShaderLabFile();
         }
@@ -28,11 +30,16 @@ public override IEnumerable<ITemplateScopePoint> BuildAllPoints()
 
         public override string Present(ITemplateScopePoint point)
         {
+            if (point is IsAvailableForClassAttribute)
+                return "In C# file where class attribute is available";
+            if (point is InUnityCSharpProject)
+                return "In Unity project";
             if (point is MustBeInUnityType)
                 return "In Unity type where type members are allowed";
             if (point is InUnityShaderLabFile)
-                return "Anywhere in Unity ShaderLab file";
+                return "In Unity ShaderLab file";
             return base.Present(point);
+            
         }
     }
 }

resharper/resharper-unity/src/CSharp/Feature/Services/LiveTemplates/UnityScopeProvider.cs renamed to resharper/resharper-unity/src/CSharp/Feature/Services/LiveTemplates/UnityShaderLabScopeProvider.cs

@@ -11,9 +11,9 @@
 namespace JetBrains.ReSharper.Plugins.Unity.CSharp.Feature.Services.LiveTemplates
 {
     [ShellComponent]
-    public class UnityScopeProvider : ScopeProvider
+    public class UnityShaderLabScopeProvider : ScopeProvider
     {
-        public UnityScopeProvider()
+        public UnityShaderLabScopeProvider()
         {
             // Used when creating scope point from settings
             Creators.Add(TryToCreate<InUnityShaderLabFile>);

resharper/resharper-unity/src/Templates/File/AssetPostprocessor.md

@@ -0,0 +1,31 @@
+---
+guid: B669492E-B3A6-4F98-9998-9AF480374340
+image: UnityCSharp
+type: File
+reformat: True
+shortenReferences: True
+categories: unity
+customProperties: Extension=cs, FileName=AssetPostprocessor, ValidateFileName=True
+scopes: InUnityCSharpEditorFolder
+parameterOrder: HEADER, (CLASS), (NAMESPACE)
+HEADER-expression: fileheader()
+CLASS-expression: getAlphaNumericFileNameWithoutExtension
+NAMESPACE-expression: fileDefaultNamespace()
+---
+
+# Asset Postprocessor
+
+```
+$HEADER$using UnityEngine;
+using UnityEditor;
+
+namespace $NAMESPACE$ {
+  public class $CLASS$ : AssetPostprocessor
+  {
+    public static void OnPostprocessAllAssets(string[] importedAssets, string[] deletedAssets, string[] movedAssets, string[] movedFromAssetPaths)
+    {
+      $END$
+    }
+  }
+}
+```

resharper/resharper-unity/src/Templates/File/CustomEditor.md

@@ -0,0 +1,33 @@
+---
+guid: 2E5D288C-A209-41EE-93B2-7CACDCAE18C6
+image: UnityCSharp
+type: File
+reformat: True
+shortenReferences: True
+categories: unity
+customProperties: Extension=cs, FileName=CustomEditor, ValidateFileName=True
+scopes: InUnityCSharpEditorFolder
+parameterOrder: HEADER, (CLASS), (NAMESPACE), TYPE
+HEADER-expression: fileheader()
+CLASS-expression: getAlphaNumericFileNameWithoutExtension
+NAMESPACE-expression: fileDefaultNamespace()
+TYPE-expression: complete()
+---
+
+# Custom Editor
+
+```
+$HEADER$using UnityEditor;
+
+namespace $NAMESPACE$ {
+  [CustomEditor(typeof($TYPE$))]
+  public class $CLASS$ : Editor
+  {
+    public override void OnInspectorGUI() 
+    {
+      $END$
+      base.OnInspectorGUI();
+    }
+  }
+}
+```

resharper/resharper-unity/src/Templates/File/EditorWindow.md

@@ -0,0 +1,39 @@
+---
+guid: CA9DFEEA-D5B5-4DDC-933F-8D618D71538E
+image: UnityCSharp
+type: File
+reformat: True
+shortenReferences: True
+categories: unity
+customProperties: Extension=cs, FileName=EditorWindow, ValidateFileName=True
+scopes: InUnityCSharpEditorFolder
+parameterOrder: HEADER, (CLASS), (NAMESPACE), MENUITEM, TITLE 
+HEADER-expression: fileheader()
+CLASS-expression: getAlphaNumericFileNameWithoutExtension
+NAMESPACE-expression: fileDefaultNamespace()
+---
+
+# Editor Window
+
+```
+$HEADER$using UnityEngine;
+using UnityEditor;
+
+namespace $NAMESPACE$ {
+  public class $CLASS$ : EditorWindow
+  {
+    [MenuItem("$MENUITEM$")]
+    private static void ShowWindow() 
+    {
+      var window = GetWindow<$CLASS$>();
+      window.titleContent = new GUIContent("$TITLE$");
+      window.Show();
+    }
+
+    private void OnGUI() 
+    {
+      $END$
+    }
+  }
+}
+```

resharper/resharper-unity/src/Templates/File/PropertyDrawer.md

@@ -0,0 +1,33 @@
+---
+guid: 7901AA8B-4060-4763-8FD5-B7B5384FABAA
+image: UnityCSharp
+type: File
+reformat: True
+shortenReferences: True
+categories: unity
+customProperties: Extension=cs, FileName=PropertyDrawer, ValidateFileName=True
+scopes: InUnityCSharpEditorFolder
+parameterOrder: HEADER, (CLASS), (NAMESPACE), TYPE
+HEADER-expression: fileheader()
+CLASS-expression: getAlphaNumericFileNameWithoutExtension
+NAMESPACE-expression: fileDefaultNamespace()
+TYPE-expression: complete()
+---
+
+# Property Drawer
+
+```
+$HEADER$using UnityEngine;
+using UnityEditor;
+
+namespace $NAMESPACE$ {
+  [CustomPropertyDrawer(typeof($TYPE$))]
+  public class $CLASS$ : PropertyDrawer
+  {
+    public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)
+    {
+      $END$
+    }
+  }
+}
+```

resharper/resharper-unity/src/Templates/File/ScriptableObject.md

@@ -0,0 +1,30 @@
+---
+guid: 1404A333-DA7C-47AC-8CB5-7C944DD1422D
+image: UnityCSharp
+type: File
+reformat: True
+shortenReferences: True
+categories: unity
+customProperties: Extension=cs, FileName=ScriptableObject, ValidateFileName=True
+scopes: InUnityCSharpProject
+parameterOrder: HEADER, (CLASS), (NAMESPACE), FILENAME, MENUNAME
+HEADER-expression: fileheader()
+CLASS-expression: getAlphaNumericFileNameWithoutExtension()
+NAMESPACE-expression: fileDefaultNamespace()
+FILENAME-expression: complete()
+MENUNAME-expression: complete()
+---
+
+# Scriptable Object
+
+```
+$HEADER$using UnityEngine;
+
+namespace $NAMESPACE$ {
+  [CreateAssetMenu(fileName = "$FILENAME$", menuName = "$MENUNAME$", order = 0)]
+  public class $CLASS$ : ScriptableObject 
+  {
+    $END$
+  }
+}
+```

resharper/resharper-unity/src/Templates/File/ScriptableWizard.md

@@ -0,0 +1,46 @@
+---
+guid: E1BD73A0-0145-4A1A-B4AA-7744144744AF
+image: UnityCSharp
+type: File
+reformat: True
+shortenReferences: True
+categories: unity
+customProperties: Extension=cs, FileName=ScriptableWizard, ValidateFileName=True
+scopes: InUnityCSharpEditorFolder
+parameterOrder: HEADER, (CLASS), (NAMESPACE), MENUNAME, TITLE, CREATE, OTHER
+HEADER-expression: fileheader()
+CLASS-expression: getAlphaNumericFileNameWithoutExtension()
+NAMESPACE-expression: fileDefaultNamespace()
+MENUNAME-expression: complete()
+TITLE-expression: complete()
+CREATE-expression: complete()
+OTHER-expression: complete()
+---
+
+# Scriptable Wizard
+
+```
+$HEADER$using UnityEngine;
+using UnityEditor;
+
+namespace $NAMESPACE$ {
+  public class $CLASS$ : ScriptableWizard 
+  {
+    [MenuItem("$MENUNAME$")]
+    public static void CreateWizard()
+    {
+        DisplayWizard<$CLASS$>("$TITLE$", "$CREATE$", "$OTHER$");
+    }
+
+    public void OnWizardCreate()
+    {
+        $END$
+    }
+
+    public void OnWizardUpdate()
+    {
+    
+    }
+  }
+}
+```

resharper/resharper-unity/src/Templates/File/StateMachineBehaviour.md

@@ -0,0 +1,46 @@
+---
+guid: AFA01340-773E-488A-93D6-E19540AE2F1B
+image: UnityCSharp
+type: File
+reformat: True
+shortenReferences: True
+categories: unity
+customProperties: Extension=cs, FileName=StateMachineBehaviour, ValidateFileName=True
+scopes: InUnityCSharpProject
+parameterOrder: HEADER, (CLASS), (NAMESPACE)
+HEADER-expression: fileheader()
+CLASS-expression: getAlphaNumericFileNameWithoutExtension()
+NAMESPACE-expression: fileDefaultNamespace()
+---
+
+# State Machine Behaviour
+
+```
+$HEADER$using UnityEngine;
+
+namespace $NAMESPACE$ {
+  public class $CLASS$ : StateMachineBehaviour 
+  {
+    public override void OnStateEnter(Animator animator, AnimatorStateInfo stateInfo, int layerIndex)
+    {
+      $END$
+    }
+
+    public override void OnStateExit(Animator animator, AnimatorStateInfo stateInfo, int layerIndex)
+    {
+    }
+
+    public override void OnStateUpdate(Animator animator, AnimatorStateInfo stateInfo, int layerIndex)
+    {
+    }
+
+    public override void OnStateMove(Animator animator, AnimatorStateInfo stateInfo, int layerIndex)
+    {
+    }
+
+    public override void OnStateIK(Animator animator, AnimatorStateInfo stateInfo, int layerIndex)
+    {
+    }
+  }
+}
+```