Template - VSCode: Add extensions.json (#469)

gaelcolas · Apr 17, 2024 · d00110a · d00110a
1 parent 5b43dd8
commit d00110a
Show file tree

Hide file tree

Showing 8 changed files with 31 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Added extensions.json for vscode
+
 ### Changed
 
 - Update template for SECURITY.md and add it to Sampler repository as well.

diff --git a/Sampler/Templates/Sampler/plasterManifest.xml b/Sampler/Templates/Sampler/plasterManifest.xml
@@ -667,6 +667,12 @@
           condition='${PLASTER_PARAM_ModuleType} -in @("dsccommunity","CompleteSample") -or ${PLASTER_PARAM_Features} -Contains ("All") -or ${PLASTER_PARAM_Features} -Contains ("vscode")'
     />
 
+    <!-- VSCODE SETTINGS -->
+    <file source='../VscodeConfig/extensions.json'
+          destination='${PLASTER_PARAM_ModuleName}/.vscode/extensions.json'
+          condition='${PLASTER_PARAM_ModuleType} -in @("dsccommunity","CompleteSample") -or ${PLASTER_PARAM_Features} -Contains ("All") -or ${PLASTER_PARAM_Features} -Contains ("vscode")'
+    />
+
     <!-- VSCODE SETTINGS -->
     <file source='../VscodeConfig/tasks.json'
           destination='${PLASTER_PARAM_ModuleName}/.vscode/tasks.json'

diff --git a/Sampler/Templates/VscodeConfig/extensions.json b/Sampler/Templates/VscodeConfig/extensions.json
@@ -0,0 +1,8 @@
+{
+    "recommendations": [
+        "davidanson.vscode-markdownlint",
+        "ms-vscode.powershell",
+        "streetsidesoftware.code-spell-checker",
+        "redhat.vscode-yaml"
+    ]
+}
diff --git a/Sampler/Templates/VscodeConfig/plasterManifest.xml b/Sampler/Templates/VscodeConfig/plasterManifest.xml
@@ -4,7 +4,7 @@
   <metadata>
     <name>VscodeConfig</name>
     <id>48fd55d5-306a-4f98-b65f-a516f652d228</id>
-    <version>0.0.1</version>
+    <version>0.0.2</version>
     <title>VscodeConfig Template</title>
     <description>A template to add a .vscode config with settings, Analyzersettings and tasks to a Sampler Project</description>
     <author>Gael Colas</author>
@@ -30,5 +30,10 @@
           destination='.vscode/tasks.json'
     />
 
+    <!-- VSCODE EXTENSIONS -->
+    <file source='extensions.json'
+          destination='.vscode/extensions.json'
+    />
+
   </content>
 </plasterManifest>
diff --git a/.../Integration/PlasterTemplates/Sampler/CompleteSamplePlasterTemplate.Integration.Tests.ps1 b/.../Integration/PlasterTemplates/Sampler/CompleteSamplePlasterTemplate.Integration.Tests.ps1
@@ -83,6 +83,7 @@ Describe 'Complete Module Plaster Template' {
                 '.vscode/analyzersettings.psd1'
                 '.vscode/settings.json'
                 '.vscode/tasks.json'
+                '.vscode/extensions.json'
                 'source/ModuleDsc.psd1'
                 'source/ModuleDsc.psm1'
                 # 'source/Modules/Folder.Common/Folder.Common.psm1'

diff --git a/tests/Integration/PlasterTemplates/Sampler/CustomModulePlasterTemplate.Integration.Tests.ps1 b/tests/Integration/PlasterTemplates/Sampler/CustomModulePlasterTemplate.Integration.Tests.ps1
@@ -84,6 +84,7 @@ Describe 'Custom Module Plaster Template' {
                 '.vscode/analyzersettings.psd1'
                 '.vscode/settings.json'
                 '.vscode/tasks.json'
+                '.vscode/extensions.json'
                 'source/ModuleDsc.psd1'
                 'source/ModuleDsc.psm1'
                 'source/Classes/1.class1.ps1'
@@ -237,6 +238,7 @@ Describe 'Custom Module Plaster Template' {
                 '.vscode/analyzersettings.psd1'
                 '.vscode/settings.json'
                 '.vscode/tasks.json'
+                '.vscode/extensions.json'
                 'source/ModuleDsc.psd1'
                 'source/ModuleDsc.psm1'
                 'source/Classes/1.class1.ps1'
@@ -391,6 +393,7 @@ Describe 'Custom Module Plaster Template' {
                 '.vscode/analyzersettings.psd1'
                 '.vscode/settings.json'
                 '.vscode/tasks.json'
+                '.vscode/extensions.json'
                 'source/ModuleDsc.psd1'
                 'source/ModuleDsc.psm1'
                 'source/Classes/1.class1.ps1'
@@ -545,6 +548,7 @@ Describe 'Custom Module Plaster Template' {
                 '.vscode/analyzersettings.psd1'
                 '.vscode/settings.json'
                 '.vscode/tasks.json'
+                '.vscode/extensions.json'
                 'source/ModuleDsc.psd1'
                 'source/ModuleDsc.psm1'
                 'source/Classes/1.class1.ps1'

diff --git a/tests/Integration/PlasterTemplates/Sampler/DscCommunityPlasterTemplate.Integration.Tests.ps1 b/tests/Integration/PlasterTemplates/Sampler/DscCommunityPlasterTemplate.Integration.Tests.ps1
@@ -70,6 +70,7 @@ Describe 'DSC Community Plaster Template' {
                 '.vscode/analyzersettings.psd1'
                 '.vscode/settings.json'
                 '.vscode/tasks.json'
+                '.vscode/extensions.json'
                 'source/en-US/about_ModuleDsc.help.txt'
                 'source/ModuleDsc.psd1'
                 'source/ModuleDsc.psm1'

diff --git a/...tegration/PlasterTemplates/VscodeConfig/VscodeConfigPlasterTemplate.Integration.tests.ps1 b/...tegration/PlasterTemplates/VscodeConfig/VscodeConfigPlasterTemplate.Integration.tests.ps1
@@ -31,6 +31,7 @@ Describe 'Vscode repo config files Plaster Template' {
 
                 # Files (relative to module folder)
                 '.vscode/analyzersettings.psd1'
+                '.vscode/extensions.json'
                 '.vscode/settings.json'
                 '.vscode/tasks.json'
             )