Merge pull request #42 from PlagueHO/Issue-41

BREAKING CHANGE: Update to new CI Pipeline - Fixes #41

Author: PlagueHO

.MetaTestOptIn.json

@@ -3,62 +3,8 @@
 ###############################################################################
 * text eol=crlf
 
-###############################################################################
-# Set default behavior for command prompt diff.
-#
-# This is need for earlier builds of msysgit that does not have it on by
-# default for csharp files.
-# Note: This is only used by command line
-###############################################################################
-#*.cs     diff=csharp
-
-###############################################################################
-# Set the merge driver for project and solution files
-#
-# Merging from the command prompt will add diff markers to the files if there
-# are conflicts (Merging from VS is not affected by the settings below, in VS
-# the diff markers are never inserted). Diff markers may cause the following
-# file extensions to fail to load in VS. An alternative would be to treat
-# these files as binary and thus will always conflict and require user
-# intervention with every merge. To do so, just uncomment the entries below
-###############################################################################
-#*.sln       merge=binary
-#*.csproj    merge=binary
-#*.vbproj    merge=binary
-#*.vcxproj   merge=binary
-#*.vcproj    merge=binary
-#*.dbproj    merge=binary
-#*.fsproj    merge=binary
-#*.lsproj    merge=binary
-#*.wixproj   merge=binary
-#*.modelproj merge=binary
-#*.sqlproj   merge=binary
-#*.wwaproj   merge=binary
-
-###############################################################################
-# behavior for image files
-#
-# image files are treated as binary by default.
-###############################################################################
-*.jpg   binary
-*.png   binary
-*.gif   binary
-*.exe   binary
-
-###############################################################################
-# diff behavior for common document formats
-#
-# Convert binary document formats to text before diffing them. This feature
-# is only available from the command line. Turn it on by uncommenting the
-# entries below.
-###############################################################################
-#*.doc   diff=astextplain
-#*.DOC   diff=astextplain
-#*.docx  diff=astextplain
-#*.DOCX  diff=astextplain
-#*.dot   diff=astextplain
-#*.DOT   diff=astextplain
-#*.pdf   diff=astextplain
-#*.PDF   diff=astextplain
-#*.rtf   diff=astextplain
-#*.RTF   diff=astextplain
+# Ensure any exe files are treated as binary
+*.exe binary
+*.jpg binary
+*.xl* binary
+*.pfx binary

.codecov.yml

@@ -2,14 +2,9 @@
 *.user
 *.coverage
 .vs
+.vscode
 .psproj
 .sln
-DscResource.Tests
-DscResource.Tests/*
-Modules/xNetworking/DscResource.Tests
-Modules/xNetworking/DscResource.Tests/*
-node_modules
-node_modules/*
 markdownissues.txt
 TestResults.xml
-launch.json
+output/

.gitattributes

@@ -1,11 +1,6 @@
 @{
-    <#
-        For the custom rules to work, the DscResource.Tests repo must be
-        cloned. It is automatically clone as soon as any unit or
-        integration tests are run.
-    #>
-    CustomRulePath = '.\DSCResource.Tests\DscResource.AnalyzerRules'
-
+    CustomRulePath      = '.\output\RequiredModules\DscResource.AnalyzerRules'
+    includeDefaultRules = $true
     IncludeRules   = @(
         # DSC Resource Kit style guideline rules.
         'PSAvoidDefaultValueForMandatoryParameter',
@@ -43,11 +38,7 @@
         'PSUseDeclaredVarsMoreThanAssignments',
         'PSUsePSCredentialType',
 
-        <#
-            This is to test all the DSC Resource Kit custom rules.
-            The name of the function-blocks of each custom rule start
-            with 'Measure*'.
-        #>
         'Measure-*'
     )
+
 }

.gitignore

@@ -1,15 +1,38 @@
-// Place your settings in this file to overwrite default and user settings.
 {
     "powershell.codeFormatting.openBraceOnSameLine": false,
-    "powershell.codeFormatting.newLineAfterOpenBrace": false,
+    "powershell.codeFormatting.newLineAfterOpenBrace": true,
     "powershell.codeFormatting.newLineAfterCloseBrace": true,
     "powershell.codeFormatting.whitespaceBeforeOpenBrace": true,
     "powershell.codeFormatting.whitespaceBeforeOpenParen": true,
     "powershell.codeFormatting.whitespaceAroundOperator": true,
     "powershell.codeFormatting.whitespaceAfterSeparator": true,
     "powershell.codeFormatting.ignoreOneLineBlock": false,
+    "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationAfterEveryPipeline",
     "powershell.codeFormatting.preset": "Custom",
+    "powershell.codeFormatting.alignPropertyValuePairs": true,
     "files.trimTrailingWhitespace": true,
     "files.insertFinalNewline": true,
-    "powershell.scriptAnalysis.settingsPath": ".vscode\\analyzersettings.psd1"
+    "powershell.scriptAnalysis.settingsPath": ".vscode\\analyzersettings.psd1",
+    "powershell.scriptAnalysis.enable": true,
+    "files.associations": {
+        "*.ps1xml": "xml"
+    },
+    "cSpell.words": [
+        "COMPANYNAME",
+        "ICONURI",
+        "LICENSEURI",
+        "PROJECTURI",
+        "RELEASENOTES",
+        "buildhelpers",
+        "endregion",
+        "gitversion",
+        "icontains",
+        "keepachangelog",
+        "notin",
+        "pscmdlet",
+        "steppable"
+    ],
+    "[markdown]": {
+        "files.encoding": "utf8"
+    }
 }

.vscode/analyzersettings.psd1

@@ -1,62 +1,12 @@
-# Versions
+# Change log for FileContentDsc
 
-## Unreleased
+The format is based on and uses the types of changes according to [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
 
 - Transferred ownership to DSCCommunity.org -
   fixes [Issue #31](https://github.com/dsccommunity/FileContentDsc/issues/39).
-
-## 1.3.0.0
-
-- Opted into Common Tests 'Common Tests - Validate Localization' -
-  fixes [Issue #31](https://github.com/PlagueHO/FileContentDsc/issues/32).
-- Combined all `FileContent.ResourceHelper` module functions into
-  `FileContent.Common` module - fixes [Issue #32](https://github.com/PlagueHO/FileContentDsc/issues/32).
-- Renamed all localization strings so that they are detected by
-  'Common Tests - Validate Localization'.
-- Correct style violations in unit tests:
-  - Adding `Get`, `Set` and `Test` tags to appropriate `describe` blocks.
-  - Removing uneccesary `#region` blocks.
-  - Conversion of double quotes to single quotes where possible.
-  - Replace variables with string litterals in `describe` block description.
-- KeyValuePairFile:
-  - Improve unit tests to simplify and cover additional test cases.
-  - Fix error occuring when file is empty or does not exist - fixes [Issue #34](https://github.com/PlagueHO/FileContentDsc/issues/34).
-
-## 1.2.0.0
-
-- Added .VSCode settings for applying DSC PSSA rules - fixes [Issue #25](https://github.com/PlagueHO/FileContentDsc/issues/25).
-- Added an Encoding parameter to the KeyValuePairFile and ReplaceText
-  resources - fixes [Issue #5](https://github.com/PlagueHO/FileContentDsc/issues/5).
-
-## 1.1.0.0
-
-- Enabled PSSA rule violations to fail build - Fixes [Issue #6](https://github.com/PlagueHO/FileContentDsc/issues/6).
-- Updated tests to meet Pester v4 standard.
-- Added Open Code of Conduct.
-- Refactored module folder structure to move resource
-  to root folder of repository and remove test harness - Fixes [Issue #11](https://github.com/PlagueHO/FileContentDsc/issues/11).
-- Converted Examples to support format for publishing to PowerShell
-  Gallery.
-- Refactor Test-TargetResource to return $false in all DSC resource - Fixes
-  [Issue #12](https://github.com/PlagueHO/FileContentDsc/issues/13).
-- Correct configuration names in Examples - fixes [Issue #15](https://github.com/PowerShell/FileContentDsc/issues/15).
-- Refactor Test/Set-TargetResource in ReplaceText to be able to add a key if it
-  doesn't exist but should -Fixes
-  [Issue#20](https://github.com/PlagueHO/FileContentDsc/issues/20).
-- Opted into common tests:
-  - Common Tests - Validate Example Files To Be Published
-  - Common Tests - Validate Markdown Links
-  - Common Tests - Relative Path Length
-  - Common Tests - Relative Path Length
-- Correct test context description in IniSettingsFile tests to include 'When'.
-- Change IniSettingsFile unit tests to be non-destructive - fixes [Issue #22](https://github.com/PowerShell/FileContentDsc/issues/22).
-- Update to new format LICENSE.
-
-## 1.0.0.0
-
-- DSR_ReplaceText:
-  - Created new resource for replacing text in text files.
-- DSR_KeyValuePairFile:
-  - Created new resource for setting key value pairs in text files.
-- DSR_IniSettingsFile:
-  - Created new resource for setting Windows INI file settings.
+- BREAKING CHANGE: Changed resource prefix from MSFT to DSC.
+- Updated to use continuous delivery pattern using Azure DevOps - fixes
+  [Issue #41](https://github.com/dsccommunity/FileContentDsc/issues/41).