feat: Build and layout updates ( Fixes #2 )

Also adding config and icons.

Author: James Brundage

CodersUnite/Assets/BlueSky.svg

@@ -1,6 +1,34 @@
+<#
+.SYNOPSIS
+    Builds the website.
+.DESCRIPTION
+    Builds a static site using PowerShell.
+
+    * The site will be configured using any `config.*` files.
+    * Functions and filters will be loaded from any `functions.*` or `filters.*` files.
+    * All files will be processed using `buildFile.ps1` (any `*.*.ps1` file should be run).
+.EXAMPLE
+    ./build.ps1
+#>
+param(
+[string[]]
+$FilePath,
+
+[string]
+$Root = $PSScriptRoot
+)
+
 # Push into the script root directory
 if ($PSScriptRoot) { Push-Location $PSScriptRoot }
 
+# Creation of a sitewide object to hold configuration information.
+$Site = [Ordered]@{}
+$Site.Files = 
+    if ($filePath) { Get-ChildItem -Recurse -File -Path $FilePath } 
+    else { Get-ChildItem -Recurse -File }
+
+$Site.PSScriptRoot = "$PSScriptRoot"
+
 #region Common Functions and Filters
 $functionFileNames = 'functions', 'function', 'filters', 'filter'
 $functionPattern   = "(?>$($functionFileNames -join '|'))\.ps1$"
@@ -13,10 +41,6 @@ foreach ($file in $functionFiles) {
 }
 #endregion Common Functions and Filters
 
-# Creation of a sitewide object to hold configuration information.
-$Site = [Ordered]@{}
-$Site.Files = Get-ChildItem -Recurse -File
-
 # Set an alias to buildFile.ps1
 Set-Alias BuildFile ./buildFile.ps1
 
@@ -34,6 +58,11 @@ $gitHubEvent =
 if (Test-Path 'CNAME') {
     $Site.CNAME = $CNAME = (Get-Content -Path 'CNAME' -Raw).Trim()
     $Site.RootUrl = "https://$CNAME/"
+} elseif (
+    ($site.PSScriptRoot | Split-Path -Leaf) -like '*.*'
+) {
+    $site.CNAME = $CNAME = ($site.PSScriptRoot | Split-Path -Leaf)
+    $site.RootUrl = "https://$CNAME/"
 }
 
 # If we have a config.json file, it can be used to set the site configuration.
@@ -70,7 +99,7 @@ if (Test-Path 'config.ps1') {
 }
 
 # Start the clock
-$lastBuildTime = [DateTime]::Now
+$site['LastBuildTime'] = $lastBuildTime = [DateTime]::Now
 #region Build Files
 
 # Start the clock on the build process
@@ -119,8 +148,188 @@ if ($lastBuild) {
 $newLastBuild | ConvertTo-Json -Depth 2 > lastBuild.json
 #endregion lastBuild.json
 
+#region sitemap.xml
+if (-not $Site.NoSitemap) {
+    $siteMapXml = @(
+        '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">'
+        :nextPage foreach ($key in $site.PagesByUrl.Keys | Sort-Object { "$_".Length}) {
+            $keyUri = $key -as [Uri]
+            $page = $site.PagesByUrl[$key]
+            if ($site.Disallow) {
+                foreach ($disallow in $site.Disallow) {
+                    if ($keyUri.LocalPath -like "*$disallow*") { continue nextPage }
+                    if ($keyUri.AbsoluteUri -like "*$disallow*") { continue nextPage }
+                }
+            }
+            if ($page.NoIndex) { continue }
+            if ($page.NoSitemap) { continue }
+            if ($page.OutputFile.Extension -ne '.html') { continue }
+            "<url>"
+            "<loc>$key</loc>"
+            if ($site.PagesByUrl[$key].Date -is [DateTime]) {
+                "<lastmod>$($site.PagesByUrl[$key].Date.ToString('yyyy-MM-dd'))</lastmod>"
+            }
+            "</url>"
+        }
+        '</urlset>'
+    ) -join ' ' -as [xml]
+    if ($siteMapXml) {
+        $siteMapXml.Save((
+            Join-Path $site.PSScriptRoot sitemap.xml
+        ))
+    }
+}
+#endregion sitemap.xml
+
+#region index.rss
+if (-not $Site.NoRss) {
+    $pagesByDate = $site.PagesByUrl.GetEnumerator() | 
+        Sort-Object { $_.Value.Date } -Descending
+    $rssXml = @(
+        '<rss version="2.0">'
+            '<channel>'
+            "<title>$([Security.SecurityElement]::Escape($(
+                if ($site.Title) { $site.Title } else { $site.CNAME }
+            )))</title>"
+            "<link>$($site.RootUrl)</link>"        
+            "<description>$([Security.SecurityElement]::Escape($(
+                if ($site.Description) { $site.Description } else { $site.Title }
+            )))</description>"
+            "<pubDate>$($pagesByDate[0].Value.Date.ToString('R'))</pubDate>"
+            "<lastBuildDate>$($lastBuildTime.ToString('R'))</lastBuildDate>"
+            "<language>$([Security.SecurityElement]::Escape($site.Language))</language>"        
+            :nextPage foreach ($keyValue in $pagesByDate) {
+                $key = $keyValue.Key
+                $keyUri = $key -as [Uri]
+                $page = $keyValue.Value
+                if ($site.Disallow) {
+                    foreach ($disallow in $site.Disallow) {
+                        if ($keyUri.LocalPath -like "*$disallow*") { continue nextPage }
+                        if ($keyUri.AbsoluteUri -like "*$disallow*") { continue nextPage }
+                    }
+                }
+                if ($site.PagesByUrl[$key].NoIndex) { continue }
+                if ($site.PagesByUrl[$key].NoSitemap) { continue }
+                if ($site.PagesByUrl[$key].OutputFile.Extension -ne '.html') { continue }
+                "<item>"
+                "<title>$([Security.SecurityElement]::Escape($(
+                    if ($page.Title) { $page.Title }
+                    elseif ($site.Title) { $site.Title }
+                    else { $site.CNAME }
+                )))</title>"
+                if ($site.PagesByUrl[$key].Date -is [DateTime]) {
+                    "<pubDate>$($site.PagesByUrl[$key].Date.ToString('R'))</pubDate>"
+                }
+                "<description>$([Security.SecurityElement]::Escape($(
+                    if ($page.Description) { $page.Description }
+                    elseif ($site.Description) { $site.Description }
+                )))</description>"
+                "<link>$key</link>"
+                "<guid isPermaLink='true'>$key</guid>"
+                "</item>"
+            }
+            '</channel>'
+        '</rss>'
+    ) -join ' ' -as [xml]
+    
+    if ($rssXml) {
+        $rssOutputPath = Join-Path $site.PSScriptRoot 'RSS' | Join-Path -ChildPath 'index.rss'
+        if (-not (Test-Path $rssOutputPath)) {
+            # Create the file if it doesn't exist
+            $null = New-Item -ItemType File -Force $rssOutputPath
+        }
+        $rssXml.Save($rssOutputPath)
+    }
+}
+
+
+#endregion index.rss
+
+#region robots.txt
+if (-not $Site.NoRobots) {
+    @(
+        "User-agent: *"
+        if ($site.Disallow) {
+            foreach ($disallow in $site.Disallow) {
+                "Disallow: $disallow"
+            }
+        }
+        if ($site.Allow) {
+            foreach ($allow in $site.Allow) {
+                "Allow: $allow"
+            }
+        }
+        if ($site.CNAME -and -not $site.NoSitemap) {
+            "Sitemap: https://$($site.CNAME)/sitemap.xml"
+        }
+    ) > robots.txt
+}
+#endregion robots.txt
+
+#region index.json
+if (-not $Site.NoIndex) {
+    $fileIndex =
+        if ($filePath) { Get-ChildItem -Recurse -File -Path $FilePath }
+        else { Get-ChildItem -Recurse -File }    
+
+    $replacement = 
+        if ($filePath) {
+            "^" + ([regex]::Escape($filePath) -replace '\*','.{0,}?')
+        } else {
+            "^" + [regex]::Escape("$pwd")
+        }
+
+    $indexObject    = [Ordered]@{}
+    $gitCommand     = $ExecutionContext.SessionState.InvokeCommand.GetCommand('git', 'Application')
+    foreach ($file in $fileIndex) {
+        $gitDates = 
+            try { 
+                (& $gitCommand log --follow --format=%ci --date default $file.FullName *>&1) -as [datetime[]]
+            } catch {
+                $null
+            }
+        $LASTEXITCODE = 0
+        
+        $indexObject[$file.FullName -replace $replacement] = [Ordered]@{
+            Name        = $file.Name            
+            Length      = $file.Length
+            Extension   = $file.Extension
+            CreatedAt   = 
+                if ($gitDates) {
+                    $gitDates[-1]
+                } else {
+                     $file.CreationTime
+                }
+            LastWriteTime = 
+                if ($gitDates) {
+                    $gitDates[0]
+                } else {
+                    $file.LastWriteTime
+                }
+        }
+    }
+        
+    foreach ($indexKey in $indexObject.Keys) {
+        if (-not $indexObject[$indexKey].CreatedAt) {
+            if ($indexObject["$indexKey.ps1"].CreatedAt) {
+                $indexObject[$indexKey].CreatedAt = $indexObject["$indexKey.ps1"].CreatedAt
+            }
+        }
+        if (-not $indexObject[$indexKey].LastWriteTime) {
+            if ($indexObject["$indexKey.ps1"].LastWriteTime) {
+                $indexObject[$indexKey].LastWriteTime = $indexObject["$indexKey.ps1"].LastWriteTime
+            }            
+        }
+    }
+    
+    $indexObject | ConvertTo-Json -Depth 4 > index.json
+}
+#endregion index.json
+
 #region archive.zip
-#Create an archive of the current deployment.
-Compress-Archive -Path $pwd -DestinationPath "archive.zip" -CompressionLevel Optimal -Force
+if ($site.Archive) {
+    # Create an archive of the current deployment.
+    Compress-Archive -Path $pwd -DestinationPath "archive.zip" -CompressionLevel Optimal -Force
+}
 #endregion archive.zip
-if ($PSScriptRoot) { Pop-Location }
+if ($PSScriptRoot) { Pop-Location }