feat: 4bitcss.com core build files ( Fixes #123 )

Author: StartAutomating

4bitcss.com/build.ps1

@@ -0,0 +1,189 @@
+<#
+.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"
+foreach ($underbarDirectory in Get-ChildItem -Path $site.PSScriptRoot -Filter _* -Directory) {
+    $Site[$underbarDirectory.Name -replace '^_'] = $Site[$underbarDirectory.Name] = [Ordered]@{}    
+    foreach ($underbarFile in Get-ChildItem -Path $underbarDirectory -Recurse) {
+        $relativePath = $underbarFile.FullName.Substring($underbarDirectory.FullName.Length + 1)
+        $pointer = $site
+        $hierarchy = @($relativePath -split '[\\/]')
+        for ($index = 0; $index -lt ($hierarchy.Length - 1); $index++) {
+            $subdirectory = $hierarchy[$index] -replace '_'
+            if (-not $pointer[$subdirectory]) {
+                $pointer[$subdirectory] = [Ordered]@{}
+            }
+            $pointer = $pointer[$subdirectory]
+        }
+
+        $propertyName = $hierarchy[-1] -replace '_' 
+        $getFile = @{LiteralPath=$siteFile.FullName}
+        $fileData  =
+            switch -regex ($underbarFile.Extension) {
+                '\.ps1$' { $ExecutionContext.SessionState.InvokeCommand.GetCommand($underbarFile.FullName, 'ExternalScript') }
+                '\.(css|html|txt)$' { Get-Content @getFile }
+                '\.json$' { Get-Content @getFile | ConvertFrom-Json }
+                '\.jsonl$' { Get-Content @getFile | ConvertFrom-Json }
+                '\.psd1$' { Get-Content @getFile -Raw | ConvertFrom-StringData }
+                '\.(?>ps1xml|xml|svg)$' { (Get-Content @getFile -Raw) -as [xml] }
+                '\.(?>yaml|toml)$' { Get-Content @getFile -Raw }
+                '\.csv$' { Import-Csv @getFile }
+                '\.tsv$' { Import-Csv @getFile -Delimiter "`t" }
+            }        
+        if (-not $fileData) { continue }        
+        $pointer[$relativePath -replace '\.ps1$'] = $fileData        
+    }
+}
+
+#region Common Functions and Filters
+# Any functions or filter file at the site root should be loaded.
+$functionFileNames = 'functions', 'function', 'filters', 'filter'
+$functionPattern   = "(?>$($functionFileNames -join '|'))\.ps1$"
+$functionFiles     = Get-ChildItem -Path $Site.PSScriptRoot |
+    Where-Object Name -Match $functionPattern
+
+foreach ($file in $functionFiles) {
+    # If we have a file with the name function or functions, 
+    # we'll dot source it now so we can use the functions in the config
+    . $file.FullName
+}
+#endregion Common Functions and Filters
+
+# Set an alias to buildPage.ps1
+Set-Alias BuildPage ./buildPage.ps1
+
+# If we have a github event,
+# save it to a variable and to the `$site`
+$site.GitHubEvent = $gitHubEvent =
+    if ($env:GITHUB_EVENT_PATH) {
+        # all we need to do to serve it is copy it.
+        Copy-Item $env:GITHUB_EVENT_PATH .\gitHubEvent.json
+
+        # and we can assign it to a variable, so you we can use it in any files we build.
+        Get-Content -Path .\gitHubEvent.json -Raw | ConvertFrom-Json
+    }
+
+# If we have a CNAME, read it, trim it, and update the site object.
+if (Test-Path 'CNAME') {
+    $Site.CNAME = $CNAME = (Get-Content -Path 'CNAME' -Raw).Trim()
+    $Site.RootUrl = "https://$CNAME/"
+} elseif (
+    # otherwise, if we are in a directory that could be a domain
+    ($site.PSScriptRoot | Split-Path -Leaf) -like '*.*'
+) {
+    # assume it _is_ the domain.
+    $site.CNAME = $CNAME = ($site.PSScriptRoot | Split-Path -Leaf)
+    $site.RootUrl = "https://$CNAME/"
+}
+
+#region config
+# If we have a config.json file, it can be used to set the site configuration.
+if (Test-Path 'config.json') {
+    $siteConfig = Get-Content -Path 'config.json' -Raw | ConvertFrom-Json
+    foreach ($property in $siteConfig.psobject.properties) {
+        $Site[$property.Name] = $property.Value
+    }
+}
+
+# If we have a config.psd1 file, we'll use it to set the site configuration.
+if (Test-Path 'config.psd1') {
+    $siteConfig = Import-LocalizedData -FileName 'config.psd1' -BaseDirectory $PSScriptRoot
+    foreach ($property in $siteConfig.GetEnumerator()) {
+        $Site[$property.Key] = $property.Value
+    }
+}
+
+# If we have a config yaml, things 
+if (Test-Path 'config.yaml') {
+    $siteConfig = Get-Item 'config.yaml' | from_yaml
+    foreach ($property in $siteConfig.GetEnumerator()) {
+        $Site[$property.Name] = $property.Value
+    }
+}
+
+# If we have a config.ps1 file,
+if (Test-Path 'config.ps1') {
+    # Get the script command
+    $configScript = Get-Command -Name './config.ps1'
+    # and install any requirements it has.
+    $configScript | RequireModule
+    # run it, and let it configure anything it chooses to.
+    . $configScript
+}
+#endregion config
+
+# Start the clock
+$site['LastBuildTime'] = $lastBuildTime = [DateTime]::Now
+#region Build Files
+
+# Start the clock on the build process
+$buildStart = [DateTime]::Now
+Write-Host "Started Building Pages @ $buildStart"
+# pipe every file we find to buildFile
+$Site.Files | . buildPage
+# and stop the clock
+$buildEnd = [DateTime]::Now
+Write-Host "Finished Building Pages @ $buildEnd ($($buildEnd - $buildStart))"
+
+#endregion Build Files
+
+# If we have changed directories, we need to push back into the script root directory.
+if ($PSScriptRoot -and "$PSScriptRoot" -ne "$pwd") {
+    Push-Location $psScriptRoot
+}
+
+if ($site.includes.'LastBuild.json' -is [Management.Automation.ExternalScriptInfo]) {    
+    . $site.includes.'LastBuild.json' > ./lastBuild.json
+}
+
+if ($site.includes.'Sitemap.xml' -is [Management.Automation.ExternalScriptInfo]) {
+    . $site.includes.'Sitemap.xml' > sitemap.xml
+}
+
+if ($site.includes.'Robots.txt' -is [Management.Automation.ExternalScriptInfo]) {
+    . $site.includes.'Robots.txt' > robots.txt
+}
+
+if ($site.includes.'Index.rss' -is [Management.Automation.ExternalScriptInfo]) {
+    New-Item -ItemType File -Path ./RSS/index.rss -Force -Value (
+        . $site.includes.'Index.rss'
+    )
+}
+
+if ($site.includes.'Index.json' -is [Management.Automation.ExternalScriptInfo]) {
+    . $site.includes.'Index.json' > index.json
+}
+
+#region archive.zip
+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 }