Fix snippet for abstract method (#82)

josefpihrt · Dec 8, 2023 · d8b46c4 · d8b46c4
1 parent c25064e
commit d8b46c4
Show file tree

Hide file tree

Showing 13 changed files with 126 additions and 8 deletions.
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## [Unreleased]
 
+### Fixed
+
+- Fix snippets for abstract method ([PR](https://github.com/josefpihrt/snippetica/pull/82))
+
 ## [2.0.2] - 2023-11-05
 
 ## [2.0.1] - 2023-11-05

diff --git a/src/Snippetica.CodeGeneration.Common/KnownTags.cs b/src/Snippetica.CodeGeneration.Common/KnownTags.cs
@@ -36,6 +36,7 @@ public static class KnownTags
     public const string GenerateStaticModifier = GeneratePrefix + "StaticModifier";
     public const string GenerateVirtualModifier = GeneratePrefix + "VirtualModifier";
     public const string GenerateAbstractModifier = GeneratePrefix + "AbstractModifier";
+    public const string GenerateAbstractModifierRequired = "AbstractModifierRequired";
     public const string GenerateInlineModifier = GeneratePrefix + "InlineModifier";
     public const string GenerateConstModifier = GeneratePrefix + "ConstModifier";
     public const string GenerateConstExprModifier = GeneratePrefix + "ConstExprModifier";

diff --git a/...ippetica.CodeGeneration.Metadata/Snippetica.CSharp/AutoGeneration/Abstract/Method.snippet b/...ippetica.CodeGeneration.Metadata/Snippetica.CSharp/AutoGeneration/Abstract/Method.snippet
@@ -0,0 +1,43 @@
+<!--Copyright (c) Josef Pihrt. All rights reserved. Licensed under the Apache License, Version 2.0.-->
+<CodeSnippet Format="1.1.0" xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
+  <Header>
+    <Title>@type@ method</Title>
+    <Shortcut>m</Shortcut>
+    <Description>@type@ method declaration</Description>
+    <Author>Josef Pihrt</Author>
+    <SnippetTypes>
+      <SnippetType>Expansion</SnippetType>
+    </SnippetTypes>
+    <Keywords>
+      <Keyword>Meta-AbstractModifierRequired</Keyword>
+      <Keyword>Meta-GenerateAbstractModifier</Keyword>
+      <Keyword>Meta-GenerateAccessModifier</Keyword>
+      <Keyword>Meta-GenerateProtectedModifier</Keyword>
+    </Keywords>
+  </Header>
+  <Snippet>
+    <Declarations>
+      <Literal>
+        <ID>_modifiers</ID>
+        <ToolTip>Modifier(s)</ToolTip>
+        <Default>public</Default>
+      </Literal>
+      <Literal>
+        <ID>_parameters</ID>
+        <ToolTip>List of parameters</ToolTip>
+        <Default>T parameter</Default>
+      </Literal>
+      <Literal>
+        <ID>name</ID>
+        <ToolTip>Method name</ToolTip>
+        <Default>MethodName</Default>
+      </Literal>
+      <Literal>
+        <ID>type</ID>
+        <ToolTip>Return type</ToolTip>
+        <Default>void</Default>
+      </Literal>
+    </Declarations>
+    <Code Language="CSharp"><![CDATA[$_modifiers$ $type$ $name$($_parameters$);$end$]]></Code>
+  </Snippet>
+</CodeSnippet>
diff --git a/src/Snippetica.CodeGeneration.Metadata/Snippetica.CSharp/AutoGeneration/Method.snippet b/src/Snippetica.CodeGeneration.Metadata/Snippetica.CSharp/AutoGeneration/Method.snippet
@@ -9,7 +9,6 @@
       <SnippetType>Expansion</SnippetType>
     </SnippetTypes>
     <Keywords>
-      <Keyword>Meta-GenerateAbstractModifier</Keyword>
       <Keyword>Meta-GenerateAccessModifier</Keyword>
       <Keyword>Meta-GenerateProtectedModifier</Keyword>
       <Keyword>Meta-GenerateStaticModifier</Keyword>

diff --git a/...ica.CodeGeneration.Metadata/Snippetica.VisualBasic/AutoGeneration/Abstract/Method.snippet b/...ica.CodeGeneration.Metadata/Snippetica.VisualBasic/AutoGeneration/Abstract/Method.snippet
@@ -0,0 +1,55 @@
+<!--Copyright (c) Josef Pihrt. All rights reserved. Licensed under the Apache License, Version 2.0.-->
+<CodeSnippet Format="1.1.0" xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
+  <Header>
+    <Title>@type@ method</Title>
+    <Shortcut>m</Shortcut>
+    <Description>@type@ method declaration</Description>
+    <Author>Josef Pihrt</Author>
+    <SnippetTypes>
+      <SnippetType>Expansion</SnippetType>
+    </SnippetTypes>
+    <Keywords>
+      <Keyword>Meta-AbstractModifierRequired</Keyword>
+      <Keyword>Meta-GenerateAbstractModifier</Keyword>
+      <Keyword>Meta-GenerateAccessModifier</Keyword>
+      <Keyword>Meta-GenerateProtectedModifier</Keyword>
+      <Keyword>Meta-GenerateVoidType</Keyword>
+      <Keyword>Meta-NonUniqueShortcut</Keyword>
+    </Keywords>
+  </Header>
+  <Snippet>
+    <Declarations>
+      <Literal Editable="false">
+        <ID>_as</ID>
+        <ToolTip>As keyword</ToolTip>
+        <Default>As</Default>
+      </Literal>
+      <Literal>
+        <ID>_modifiers</ID>
+        <ToolTip>Modifier(s)</ToolTip>
+        <Default>Public</Default>
+      </Literal>
+      <Literal>
+        <ID>_parameters</ID>
+        <ToolTip>List of parameters</ToolTip>
+        <Default>parameter As T</Default>
+      </Literal>
+      <Literal>
+        <ID>_subOrFunction</ID>
+        <ToolTip>Sub or Function</ToolTip>
+        <Default>Function</Default>
+      </Literal>
+      <Literal>
+        <ID>name</ID>
+        <ToolTip>Method name</ToolTip>
+        <Default>MethodName</Default>
+      </Literal>
+      <Literal>
+        <ID>type</ID>
+        <ToolTip>Return type</ToolTip>
+        <Default>Object</Default>
+      </Literal>
+    </Declarations>
+    <Code Language="VB"><![CDATA[$_modifiers$ $_subOrFunction$ $name$($_parameters$) $_as$ $type$$end$]]></Code>
+  </Snippet>
+</CodeSnippet>
diff --git a/src/Snippetica.CodeGeneration.Metadata/Snippetica.VisualBasic/AutoGeneration/Method.snippet b/src/Snippetica.CodeGeneration.Metadata/Snippetica.VisualBasic/AutoGeneration/Method.snippet
@@ -9,7 +9,6 @@
       <SnippetType>Expansion</SnippetType>
     </SnippetTypes>
     <Keywords>
-      <Keyword>Meta-GenerateAbstractModifier</Keyword>
       <Keyword>Meta-GenerateAccessModifier</Keyword>
       <Keyword>Meta-GenerateProtectedModifier</Keyword>
       <Keyword>Meta-GenerateStaticModifier</Keyword>

diff --git a/src/Snippetica.CodeGeneration/Commands/MultiCommandCollection.cs b/src/Snippetica.CodeGeneration/Commands/MultiCommandCollection.cs
@@ -7,6 +7,15 @@ namespace Snippetica.CodeGeneration.Commands;
 
 public class MultiCommandCollection : Collection<MultiCommand>
 {
+    public MultiCommandCollection()
+    {
+    }
+
+    public MultiCommandCollection(IEnumerable<MultiCommand> commands)
+    {
+        AddRange(commands);
+    }
+
     public void AddRange(IEnumerable<MultiCommand> commands)
     {
         foreach (MultiCommand command in commands)

diff --git a/src/Snippetica.CodeGeneration/LanguageSnippetGenerator.cs b/src/Snippetica.CodeGeneration/LanguageSnippetGenerator.cs
@@ -41,14 +41,19 @@ protected override MultiCommandCollection CreateCommands(Snippet snippet)
 
         commands.AddMultiCommands(GetAccessModifierCommands(snippet));
 
+        var abstractModifierRequired = false;
+
         if (snippet.HasTag(KnownTags.GenerateStaticModifier))
             commands.AddMultiCommand(CommandUtility.StaticCommand, duplicateWhenEmpty: true);
 
         if (snippet.HasTag(KnownTags.GenerateVirtualModifier))
             commands.AddMultiCommand(CommandUtility.VirtualCommand, duplicateWhenEmpty: true);
 
         if (snippet.HasTag(KnownTags.GenerateAbstractModifier))
-            commands.AddMultiCommand(CommandUtility.AbstractCommand, duplicateWhenEmpty: true);
+        {
+            commands.AddMultiCommand(CommandUtility.AbstractCommand, duplicateWhenEmpty: false);
+            abstractModifierRequired = snippet.HasTag(KnownTags.GenerateAbstractModifierRequired);
+        }
 
         if (snippet.HasTag(KnownTags.GenerateConstModifier))
             commands.AddMultiCommand(CommandUtility.ConstCommand, duplicateWhenEmpty: true);
@@ -62,6 +67,9 @@ protected override MultiCommandCollection CreateCommands(Snippet snippet)
         if (snippet.HasTag(KnownTags.GenerateInitializer))
             commands.AddMultiCommand(CommandUtility.InitializerCommand, duplicateWhenEmpty: true);
 
+        if (abstractModifierRequired)
+            commands = new MultiCommandCollection(commands.Where(mc => mc.Commands.Any(c => c.Kind == CommandKind.AbstractModifier)));
+
         return commands;
     }
 

diff --git a/src/Snippetica.CodeGeneration/VisualStudioCode/VisualStudioCodeEnvironment.cs b/src/Snippetica.CodeGeneration/VisualStudioCode/VisualStudioCodeEnvironment.cs
@@ -164,7 +164,7 @@ protected override void SaveSnippets(SnippetGeneratorResult result)
 
         MDocument document = Document(
             Heading1(result.Language.GetTitle() + " Snippets"),
-            Inline("Please see ", Link("documentation", "https://josefpihrt.github.io/docs/snippetica/vscode"), " for further information."));
+            Inline("Please see ", Link("documentation", "https://josefpihrt.github.io/docs/snippetica/snippets/vscode/" + languageId), " for further information."));
 
         IOUtility.WriteAllText(Path.Combine(packageDirectoryPath, "README.md"), document.ToString());
     }

diff --git a/src/Snippetica.VisualStudioCode.Vsix.Dev/Snippetica.CSharp.Dev/package/README.md b/src/Snippetica.VisualStudioCode.Vsix.Dev/Snippetica.CSharp.Dev/package/README.md
@@ -1,3 +1,3 @@
 # C\# Snippets
 
-Please see [documentation](https://josefpihrt.github.io/docs/snippetica/vscode) for further information\.
+Please see [documentation](https://josefpihrt.github.io/docs/snippetica/snippets/vscode/csharp) for further information\.
diff --git a/src/Snippetica.VisualStudioCode.Vsix.Dev/Snippetica.Cpp.Dev/package/README.md b/src/Snippetica.VisualStudioCode.Vsix.Dev/Snippetica.Cpp.Dev/package/README.md
@@ -1,3 +1,3 @@
 # C\+\+ Snippets
 
-Please see [documentation](https://josefpihrt.github.io/docs/snippetica/vscode) for further information\.
+Please see [documentation](https://josefpihrt.github.io/docs/snippetica/snippets/vscode/cpp) for further information\.
diff --git a/...ippetica.VisualStudioCode.Vsix.Dev/Snippetica.VisualBasic.Dev/package/README.md b/...ippetica.VisualStudioCode.Vsix.Dev/Snippetica.VisualBasic.Dev/package/README.md
@@ -1,3 +1,3 @@
 # VB Snippets
 
-Please see [documentation](https://josefpihrt.github.io/docs/snippetica/vscode) for further information\.
+Please see [documentation](https://josefpihrt.github.io/docs/snippetica/snippets/vscode/vb) for further information\.
diff --git a/src/Snippetica.VisualStudioCode.Vsix/Snippetica.VisualBasic/package/README.md b/src/Snippetica.VisualStudioCode.Vsix/Snippetica.VisualBasic/package/README.md
@@ -1,3 +1,3 @@
-# Visual Basic Snippets
+# VB Snippets
 
 Please see [documentation](https://josefpihrt.github.io/docs/snippetica/snippets/vscode/vb) for further information\.