├── PSModuleOverview.psd1 ├── README.md ├── LICENSE ├── azure-pipelines.yml ├── PSModuleOverview.psm1 └── .gitignore /PSModuleOverview.psd1: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ChrisLGardner/PSModuleOverview/HEAD/PSModuleOverview.psd1 -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PSModuleOverview 2 | 3 | A simple PowerShell module for generating a markdown file with all the commands from a specified module for use as a basis for a readme or similar. 4 | 5 | ## New-ModuleOverview 6 | 7 | Generates a Markdown file with a short description of each public command in a module. 8 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2019 Chris Gardner 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /azure-pipelines.yml: -------------------------------------------------------------------------------- 1 | name: $(Major).$(Minor).$(rev:r) 2 | 3 | variables: 4 | Major: 1 5 | Minor: 0 6 | 7 | resources: 8 | - repo: self 9 | 10 | trigger: 11 | - master 12 | 13 | pool: 14 | name: Hosted VS2017 15 | steps: 16 | - task: richardfennellBM.BM-VSTS-Versioning-Task.Version-PowerShellModule-Task.VersionPowerShellModule@2 17 | displayName: 'Version PowerShell Modules' 18 | inputs: 19 | VersionRegex: '\d+\.\d+\.\d+' 20 | 21 | 22 | - task: richardfennellBM.BM-VSTS-PesterRunner-Task.Pester-Task.Pester@8 23 | displayName: 'Pester Test Runner' 24 | inputs: 25 | scriptFolder: '$(System.DefaultWorkingDirectory)\Tests\*' 26 | resultsFile: '$(System.DefaultWorkingDirectory)\Test.xml' 27 | CodeCoverageOutputFile: '$(System.DefaultWorkingDirectory)\Coverage.xml' 28 | CodeCoverageFolder: '$(System.DefaultWorkingDirectory)\PSModuleDevelopment.psm1' 29 | enabled: false 30 | 31 | - task: PublishTestResults@2 32 | displayName: 'Publish Test Results **/Test.xml' 33 | inputs: 34 | testResultsFormat: NUnit 35 | testResultsFiles: '**/Test.xml' 36 | enabled: false 37 | condition: succeededOrFailed() 38 | 39 | - task: PublishCodeCoverageResults@1 40 | displayName: 'Publish code coverage from $(System.DefaultWorkingDirectory)\Coverage.xml' 41 | inputs: 42 | summaryFileLocation: '$(System.DefaultWorkingDirectory)\Coverage.xml' 43 | enabled: false 44 | condition: succeededOrFailed() 45 | 46 | - task: CopyFiles@2 47 | displayName: 'Copy Files to: $(Build.ArtifactStagingDirectory)' 48 | inputs: 49 | Contents: | 50 | **\*.psm1 51 | **\*.psd1 52 | **\LICENSE 53 | TargetFolder: '$(Build.ArtifactStagingDirectory)' 54 | 55 | - task: PublishBuildArtifacts@1 56 | displayName: 'Publish Artifact: PSModuleOverview' 57 | condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master')) 58 | inputs: 59 | ArtifactName: PSModuleOverview 60 | -------------------------------------------------------------------------------- /PSModuleOverview.psm1: -------------------------------------------------------------------------------- 1 | function New-ModuleOverview { 2 | <# 3 | .SYNOPSIS 4 | Generates a Markdown file with a short description of each public command in a module. 5 | 6 | .DESCRIPTION 7 | Finds all the public commands in a specified module and produces a simple Markdown file detailing the description or synopsis (user choice) for each. 8 | 9 | .PARAMETER ModuleName 10 | Name of the module to generate an overview for. If the module isn't already loaded then it will be loaded. 11 | 12 | .PARAMETER Path 13 | Output path for the Markdown file. Must end in .md. 14 | 15 | .PARAMETER HelpContent 16 | Which piece of help content should be used in the generated content, either Synopsis or Description. Defaults to Synopsis 17 | 18 | .PARAMETER Append 19 | Append to the end of an existing Markdown file. 20 | 21 | .EXAMPLE 22 | New-ModuleOverview -ModuleName TLS -Path .\readme.md 23 | 24 | This will generate an overview of the TLS module and output it to readme.md in the current directory. 25 | 26 | .EXAMPLE 27 | New-ModuleOverview -ModuleName DISM -Path .\readme.md -Append 28 | 29 | This will generate an overview of the DISM module and output it to an existing readme.md in the current directory. 30 | 31 | .EXAMPLE 32 | New-ModuleOverview -ModuleName PSScheduledJob -Path .\readme.md -HelpContent Description 33 | 34 | This will generate an overview of the PSScheduledJob module using the description from each help comment and output it to readme.md in the current directory. 35 | 36 | #> 37 | 38 | [cmdletbinding()] 39 | param ( 40 | [Alias('Name')] 41 | [string]$ModuleName, 42 | 43 | [ValidateScript({ 44 | if ($_.Extension -ne '.md') { 45 | throw 'Path should be to a Markdown (md) file.' 46 | } 47 | $true 48 | })] 49 | [Alias('Fullname','FilePath')] 50 | [System.Io.Fileinfo]$Path, 51 | 52 | [ValidateSet('Description','Synopsis')] 53 | [string]$HelpContent = 'Synopsis', 54 | 55 | [Switch]$Append 56 | ) 57 | 58 | if (-not(Get-Module $ModuleName)) { 59 | Import-Module -Name $ModuleName 60 | } 61 | 62 | $OutString = "# About $ModuleName*`n`n" 63 | $Commands = Get-Command -Module $ModuleName 64 | 65 | Foreach ($Command in $Commands) { 66 | $OutString += "## $($Command.Name)`n`n" 67 | try { 68 | if ($HelpContent -eq 'Description') { 69 | $OutString += "$((Get-Help $Command.Name).Description.Text)`n`n`n" 70 | } 71 | else { 72 | $OutString += "$((Get-Help $Command.Name).Synopsis)`n`n`n" 73 | } 74 | } 75 | catch { 76 | if ($_.FullyQualifiedErrorId -like 'TypeNotFound*') { 77 | Write-Warning "Failed to get help for $($Command.Name) due to: $($_.Exception.Message)" 78 | } 79 | else { 80 | Write-Error $_ -ErrorAction Continue 81 | } 82 | } 83 | } 84 | 85 | if ($Append) { 86 | Add-Content -Value $OutString -Path $Path 87 | } 88 | else { 89 | Set-Content -Value $OutString -Path $Path -Force 90 | } 91 | 92 | } 93 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | ## 4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore 5 | 6 | # User-specific files 7 | *.suo 8 | *.user 9 | *.userosscache 10 | *.sln.docstates 11 | 12 | # User-specific files (MonoDevelop/Xamarin Studio) 13 | *.userprefs 14 | 15 | # Build results 16 | [Dd]ebug/ 17 | [Dd]ebugPublic/ 18 | [Rr]elease/ 19 | [Rr]eleases/ 20 | x64/ 21 | x86/ 22 | bld/ 23 | [Bb]in/ 24 | [Oo]bj/ 25 | [Ll]og/ 26 | 27 | # Visual Studio 2015/2017 cache/options directory 28 | .vs/ 29 | # Uncomment if you have tasks that create the project's static files in wwwroot 30 | #wwwroot/ 31 | 32 | # Visual Studio 2017 auto generated files 33 | Generated\ Files/ 34 | 35 | # MSTest test Results 36 | [Tt]est[Rr]esult*/ 37 | [Bb]uild[Ll]og.* 38 | 39 | # NUNIT 40 | *.VisualState.xml 41 | TestResult.xml 42 | 43 | # Build Results of an ATL Project 44 | [Dd]ebugPS/ 45 | [Rr]eleasePS/ 46 | dlldata.c 47 | 48 | # Benchmark Results 49 | BenchmarkDotNet.Artifacts/ 50 | 51 | # .NET Core 52 | project.lock.json 53 | project.fragment.lock.json 54 | artifacts/ 55 | **/Properties/launchSettings.json 56 | 57 | # StyleCop 58 | StyleCopReport.xml 59 | 60 | # Files built by Visual Studio 61 | *_i.c 62 | *_p.c 63 | *_i.h 64 | *.ilk 65 | *.meta 66 | *.obj 67 | *.iobj 68 | *.pch 69 | *.pdb 70 | *.ipdb 71 | *.pgc 72 | *.pgd 73 | *.rsp 74 | *.sbr 75 | *.tlb 76 | *.tli 77 | *.tlh 78 | *.tmp 79 | *.tmp_proj 80 | *.log 81 | *.vspscc 82 | *.vssscc 83 | .builds 84 | *.pidb 85 | *.svclog 86 | *.scc 87 | 88 | # Chutzpah Test files 89 | _Chutzpah* 90 | 91 | # Visual C++ cache files 92 | ipch/ 93 | *.aps 94 | *.ncb 95 | *.opendb 96 | *.opensdf 97 | *.sdf 98 | *.cachefile 99 | *.VC.db 100 | *.VC.VC.opendb 101 | 102 | # Visual Studio profiler 103 | *.psess 104 | *.vsp 105 | *.vspx 106 | *.sap 107 | 108 | # Visual Studio Trace Files 109 | *.e2e 110 | 111 | # TFS 2012 Local Workspace 112 | $tf/ 113 | 114 | # Guidance Automation Toolkit 115 | *.gpState 116 | 117 | # ReSharper is a .NET coding add-in 118 | _ReSharper*/ 119 | *.[Rr]e[Ss]harper 120 | *.DotSettings.user 121 | 122 | # JustCode is a .NET coding add-in 123 | .JustCode 124 | 125 | # TeamCity is a build add-in 126 | _TeamCity* 127 | 128 | # DotCover is a Code Coverage Tool 129 | *.dotCover 130 | 131 | # AxoCover is a Code Coverage Tool 132 | .axoCover/* 133 | !.axoCover/settings.json 134 | 135 | # Visual Studio code coverage results 136 | *.coverage 137 | *.coveragexml 138 | 139 | # NCrunch 140 | _NCrunch_* 141 | .*crunch*.local.xml 142 | nCrunchTemp_* 143 | 144 | # MightyMoose 145 | *.mm.* 146 | AutoTest.Net/ 147 | 148 | # Web workbench (sass) 149 | .sass-cache/ 150 | 151 | # Installshield output folder 152 | [Ee]xpress/ 153 | 154 | # DocProject is a documentation generator add-in 155 | DocProject/buildhelp/ 156 | DocProject/Help/*.HxT 157 | DocProject/Help/*.HxC 158 | DocProject/Help/*.hhc 159 | DocProject/Help/*.hhk 160 | DocProject/Help/*.hhp 161 | DocProject/Help/Html2 162 | DocProject/Help/html 163 | 164 | # Click-Once directory 165 | publish/ 166 | 167 | # Publish Web Output 168 | *.[Pp]ublish.xml 169 | *.azurePubxml 170 | # Note: Comment the next line if you want to checkin your web deploy settings, 171 | # but database connection strings (with potential passwords) will be unencrypted 172 | *.pubxml 173 | *.publishproj 174 | 175 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 176 | # checkin your Azure Web App publish settings, but sensitive information contained 177 | # in these scripts will be unencrypted 178 | PublishScripts/ 179 | 180 | # NuGet Packages 181 | *.nupkg 182 | # The packages folder can be ignored because of Package Restore 183 | **/[Pp]ackages/* 184 | # except build/, which is used as an MSBuild target. 185 | !**/[Pp]ackages/build/ 186 | # Uncomment if necessary however generally it will be regenerated when needed 187 | #!**/[Pp]ackages/repositories.config 188 | # NuGet v3's project.json files produces more ignorable files 189 | *.nuget.props 190 | *.nuget.targets 191 | 192 | # Microsoft Azure Build Output 193 | csx/ 194 | *.build.csdef 195 | 196 | # Microsoft Azure Emulator 197 | ecf/ 198 | rcf/ 199 | 200 | # Windows Store app package directories and files 201 | AppPackages/ 202 | BundleArtifacts/ 203 | Package.StoreAssociation.xml 204 | _pkginfo.txt 205 | *.appx 206 | 207 | # Visual Studio cache files 208 | # files ending in .cache can be ignored 209 | *.[Cc]ache 210 | # but keep track of directories ending in .cache 211 | !*.[Cc]ache/ 212 | 213 | # Others 214 | ClientBin/ 215 | ~$* 216 | *~ 217 | *.dbmdl 218 | *.dbproj.schemaview 219 | *.jfm 220 | *.pfx 221 | *.publishsettings 222 | orleans.codegen.cs 223 | 224 | # Including strong name files can present a security risk 225 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 226 | #*.snk 227 | 228 | # Since there are multiple workflows, uncomment next line to ignore bower_components 229 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 230 | #bower_components/ 231 | 232 | # RIA/Silverlight projects 233 | Generated_Code/ 234 | 235 | # Backup & report files from converting an old project file 236 | # to a newer Visual Studio version. Backup files are not needed, 237 | # because we have git ;-) 238 | _UpgradeReport_Files/ 239 | Backup*/ 240 | UpgradeLog*.XML 241 | UpgradeLog*.htm 242 | ServiceFabricBackup/ 243 | *.rptproj.bak 244 | 245 | # SQL Server files 246 | *.mdf 247 | *.ldf 248 | *.ndf 249 | 250 | # Business Intelligence projects 251 | *.rdl.data 252 | *.bim.layout 253 | *.bim_*.settings 254 | *.rptproj.rsuser 255 | 256 | # Microsoft Fakes 257 | FakesAssemblies/ 258 | 259 | # GhostDoc plugin setting file 260 | *.GhostDoc.xml 261 | 262 | # Node.js Tools for Visual Studio 263 | .ntvs_analysis.dat 264 | node_modules/ 265 | 266 | # Visual Studio 6 build log 267 | *.plg 268 | 269 | # Visual Studio 6 workspace options file 270 | *.opt 271 | 272 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 273 | *.vbw 274 | 275 | # Visual Studio LightSwitch build output 276 | **/*.HTMLClient/GeneratedArtifacts 277 | **/*.DesktopClient/GeneratedArtifacts 278 | **/*.DesktopClient/ModelManifest.xml 279 | **/*.Server/GeneratedArtifacts 280 | **/*.Server/ModelManifest.xml 281 | _Pvt_Extensions 282 | 283 | # Paket dependency manager 284 | .paket/paket.exe 285 | paket-files/ 286 | 287 | # FAKE - F# Make 288 | .fake/ 289 | 290 | # JetBrains Rider 291 | .idea/ 292 | *.sln.iml 293 | 294 | # CodeRush 295 | .cr/ 296 | 297 | # Python Tools for Visual Studio (PTVS) 298 | __pycache__/ 299 | *.pyc 300 | 301 | # Cake - Uncomment if you are using it 302 | # tools/** 303 | # !tools/packages.config 304 | 305 | # Tabs Studio 306 | *.tss 307 | 308 | # Telerik's JustMock configuration file 309 | *.jmconfig 310 | 311 | # BizTalk build output 312 | *.btp.cs 313 | *.btm.cs 314 | *.odx.cs 315 | *.xsd.cs 316 | 317 | # OpenCover UI analysis results 318 | OpenCover/ 319 | 320 | # Azure Stream Analytics local run output 321 | ASALocalRun/ 322 | 323 | # MSBuild Binary and Structured Log 324 | *.binlog 325 | 326 | # NVidia Nsight GPU debugger configuration file 327 | *.nvuser 328 | 329 | # MFractors (Xamarin productivity tool) working folder 330 | .mfractor/ 331 | --------------------------------------------------------------------------------