Customization Migration Guide: Farm Solutions to SPFx¶

Add-PSSnapin Microsoft.SharePoint.PowerShell

# List all farm solutions
Get-SPSolution | ForEach-Object {
    [PSCustomObject]@{
        Name              = $_.Name
        SolutionId        = $_.SolutionId
        Deployed          = $_.Deployed
        DeployedWebApps   = ($_.DeployedWebApplications | Select-Object -ExpandProperty Url) -join "; "
        ContainsGlobalAssembly = $_.ContainsGlobalAssembly
        ContainsWebAppResource = $_.ContainsWebApplicationResource
        ContainsCasPolicy = $_.ContainsCasPolicy
        LastModified      = $_.LastOperationEndTime
    }
} | Export-Csv -Path "C:\Migration\farm-solutions.csv" -NoTypeInformation

# List sandbox solutions per site collection
Get-SPSite -Limit All | ForEach-Object {
    $site = $_
    $_.Solutions | ForEach-Object {
        [PSCustomObject]@{
            SiteUrl    = $site.Url
            Name       = $_.Name
            SolutionId = $_.SolutionId
            Status     = $_.Status
            HasAssembly = $_.HasAssembly
        }
    }
} | Export-Csv -Path "C:\Migration\sandbox-solutions.csv" -NoTypeInformation

# Extract and analyze a WSP file (it is a CAB file)
$wspPath = "C:\Solutions\MyCustomSolution.wsp"
$extractPath = "C:\Solutions\Extracted"

# Extract using expand (WSP is a CAB)
expand $wspPath -F:* $extractPath

# Analyze the manifest
[xml]$manifest = Get-Content "$extractPath\manifest.xml"

# List assemblies
$manifest.Solution.Assemblies.Assembly | ForEach-Object {
    [PSCustomObject]@{
        Location      = $_.Location
        DeploymentTarget = $_.DeploymentTarget
    }
}

# List features
$manifest.Solution.Features.Feature | ForEach-Object {
    [PSCustomObject]@{
        Location = $_.Location
    }
}

# Create a custom theme using PnP PowerShell
Connect-PnPOnline -Url "https://contoso-admin.sharepoint.com" -Interactive

$theme = @{
    "themePrimary"         = "#0078d4"
    "themeLighterAlt"      = "#f3f9fd"
    "themeLighter"         = "#d0e7f8"
    "themeLight"           = "#a9d3f2"
    "themeTertiary"        = "#5ba9e5"
    "themeSecondary"       = "#1a86d9"
    "themeDarkAlt"         = "#006cbe"
    "themeDark"            = "#005ba1"
    "themeDarker"          = "#004377"
    "neutralLighterAlt"    = "#faf9f8"
    "neutralLighter"       = "#f3f2f1"
    "neutralLight"         = "#edebe9"
    "neutralQuaternaryAlt" = "#e1dfdd"
    "neutralQuaternary"    = "#d0d0d0"
    "neutralTertiaryAlt"   = "#c8c6c4"
    "neutralTertiary"      = "#a19f9d"
    "neutralSecondary"     = "#605e5c"
    "neutralPrimaryAlt"    = "#3b3a39"
    "neutralPrimary"       = "#323130"
    "neutralDark"          = "#201f1e"
    "black"                = "#000000"
    "white"                = "#ffffff"
}

Add-PnPTenantTheme -Identity "Contoso Corporate" -Palette $theme -IsInverted $false

# Build and package SPFx solution
gulp bundle --ship
gulp package-solution --ship

# Deploy to tenant app catalog
Connect-PnPOnline -Url "https://contoso.sharepoint.com/sites/appcatalog" -Interactive

Add-PnPApp -Path ".\sharepoint\solution\my-webpart.sppkg" `
    -Scope Tenant `
    -Publish `
    -Overwrite

# Deploy to a specific site
Install-PnPApp -Identity "my-webpart-client-side-solution" -Scope Site