[Feature Request]: Code optimization - retrieve module relative path through dedicated function

[eriqua]

Description

Implement helper function to retrieve the module relative path given the full path, e.g., Get-FormattedModuleRelativePath

Replace lines like

$moduleRelative = $moduleRoot.Replace('\', '/').split('modules/')[1]

used e.g., by Pester test, with a call to that function

[AlexanderSehr]

Should link to

$moduleRelative = $moduleRoot.Replace('\', '/').split('modules/')[1]
$splitHyphens = $moduleRelative.split('-')
$splitHyphens = $splitHyphens | ForEach-Object { $_.substring(0, 1).toupper() + $_.substring(1) }
$splitHyphens = $splitHyphens -join ''
$fullModuleIdentifier = 'Microsoft.{0}' -f $splitHyphens.Replace('-', '')

[eriqua]

@AlexanderSehr so I get the function should return the module full resourceType and not only the relative path, correct? If so I guess we should go with something like Get-ModuleResourceType?

[eriqua]

Should also include an update to custom modules to include their suffix in the readme title

Example
modules\Web\sites\config--authsettingsv2\README.md

Site AuthSettingsV2 Config [Microsoft.Web/sites/config]

[AlexanderSehr]

@AlexanderSehr so I get the function should return the module full resourceType and not only the relative path, correct? If so I guess we should go with something like Get-ModuleResourceType?

Correct. So network/virtual-networks should return Microsoft.Network/virtualNetworks.

[eriqua]

Ref updated Set-DeploymentExamplesSection in Set-ModuleReadme for cleaner code to convert from kebab-case to camelCase or PascalCase:

    # Convert moduleName from kebab-case to camelCase
    $First, $Rest = $moduleName -Split '-',2
    $moduleNameCamelCase = $First.Tolower() + (Get-Culture).TextInfo.ToTitleCase($Rest) -Replace '-'
    # Convert moduleName from kebab-case to PascalCase
    $moduleNamePascalCase = (Get-Culture).TextInfo.ToTitleCase($moduleName) -Replace '-'