Release Plan

For previous releases see Release History

Release 1.2

Release 1.2.0

• change -SonarQubeRulesPath to have a more generic name (-ExtraRulesPath or -ScriptAnalyzerRulesPath)
  • allow parameter to take multiple sets of rules
  • modify checks to call PSScriptAnayzer with each rule set
• add the ability to specify which checks to run (-Include)
  • if not specified then this will be equivalent to -Include All
• add the ability to specify which checks to not run (-Exlude)
  • if not specified then this will be equivalent to -Exclude None

Release 1.2.1

• add -ProjectPath to point to the root of a project and adjust tests accordingly
  • Gives the ability to host public and private functions and tests
• add new check(s):
  • whether -ProjectPath path adheres to project template layout (folder structure)
  • when using -ProjectPath whether or not unit tests exist for module functions
  • when using -ProjectPath public functions should have verb-noun format (e.g. Get-File)
  • when using -ProjectPath private functions should not have - in them (e.g. GetFile)
• update documentation to document project layout and additional test

Release 1.3

Release 1.3.0

• add parameter to allow HelpElementsRules.psd1 file/location to be specified (-HelpRulesPath)
  • make the default to the same folder as the checks (therefore making the parameter optional)
• rename file to be HelpRules.psd1? to match parameter
• document HelpRules file format

Release 1.3.1

• add commandlets to manage the HelpElementRules.psd1 datafile for help comment quality checks
  • view rules
  • add rule
  • remove rule
  • update rule
  • validate rules
• convert HelpElementRules file to be json to allow support for PowerShell 4 ? (only if rest of system appears to work under PowerShell 4)

Release 1.4

Release 1.4.0

• add integration tests
  • module test
  • script test
  • code fixes from faults discovered by testing
• improve error message/failed test messages so that they are more meaningful

Release 1.4.1

• further testing on different platforms
  • Server 2016
  • Server 2019
  • Linux (distros to be confirmed)
    • Ubuntu 20.04
    • Other distros
  • PowerShell 4.x ?
  • PowerShell 6.x ?
  • PowerShell 7.2
  • Extra PSScriptAnalyzer rules (used by VSCode)
  • code fixes from faults discovered by testing

Release 1.5 and beyond

Release versions to be confirmed

• create build system to auto-compile the module and publish to the PSGallery
• further improve help and wiki content

Future Plans

If there is something that you think would be useful please use the Discussions area and we can talk it through