Try make asciinema load faster

ShaunLawrie · Mar 15, 2024 · 94dbeb6 · 94dbeb6
1 parent 329eff8
commit 94dbeb6
Show file tree

Hide file tree

Showing 47 changed files with 11 additions and 8 deletions.
diff --git a/.github/workflows/build-test-publish.yml b/.github/workflows/build-test-publish.yml
@@ -114,7 +114,7 @@ jobs:
 
           # Publish prerelease docs
           Install-Module HelpOut -Scope CurrentUser -RequiredVersion 0.5 -Force
-          & .\PwshSpectreConsole.Docs\src\powershell\UpdateDocs.ps1 -NonInteractive
+          & .\PwshSpectreConsole.Docs\src\powershell\UpdateDocs.ps1 -NonInteractive -Branch "prerelease"
           git config --global user.name 'Shaun Lawrie (via GitHub Actions)'
           git config --global user.email '[email protected]'
           git add PwshSpectreConsole.Docs/src/content || true

diff --git a/...ctreConsole.Docs/public/examples/.gitkeep → ...Console.Docs/src/assets/examples/.gitkeep b/...ctreConsole.Docs/public/examples/.gitkeep → ...Console.Docs/src/assets/examples/.gitkeep
diff --git a/...ublic/examples/addspectrejobExample1.cast → ...ssets/examples/addspectrejobExample1.cast b/...ublic/examples/addspectrejobExample1.cast → ...ssets/examples/addspectrejobExample1.cast
diff --git a/...amples/formatspectrebarchartExample1.cast → ...amples/formatspectrebarchartExample1.cast b/...amples/formatspectrebarchartExample1.cast → ...amples/formatspectrebarchartExample1.cast
diff --git a/.../formatspectrebreakdownchartExample1.cast → .../formatspectrebreakdownchartExample1.cast b/.../formatspectrebreakdownchartExample1.cast → .../formatspectrebreakdownchartExample1.cast
diff --git a/...c/examples/formatspectrejsonExample1.cast → ...s/examples/formatspectrejsonExample1.cast b/...c/examples/formatspectrejsonExample1.cast → ...s/examples/formatspectrejsonExample1.cast
diff --git a/.../examples/formatspectrepanelExample1.cast → .../examples/formatspectrepanelExample1.cast b/.../examples/formatspectrepanelExample1.cast → .../examples/formatspectrepanelExample1.cast
diff --git a/.../examples/formatspectrepanelExample2.cast → .../examples/formatspectrepanelExample2.cast b/.../examples/formatspectrepanelExample2.cast → .../examples/formatspectrepanelExample2.cast
diff --git a/.../examples/formatspectretableExample1.cast → .../examples/formatspectretableExample1.cast b/.../examples/formatspectretableExample1.cast → .../examples/formatspectretableExample1.cast
diff --git a/.../examples/formatspectretableExample2.cast → .../examples/formatspectretableExample2.cast b/.../examples/formatspectretableExample2.cast → .../examples/formatspectretableExample2.cast
diff --git a/.../examples/formatspectretableExample3.cast → .../examples/formatspectretableExample3.cast b/.../examples/formatspectretableExample3.cast → .../examples/formatspectretableExample3.cast
diff --git a/...c/examples/formatspectretreeExample1.cast → ...s/examples/formatspectretreeExample1.cast b/...c/examples/formatspectretreeExample1.cast → ...s/examples/formatspectretreeExample1.cast
diff --git a/...xamples/getspectredemocolorsExample1.cast → ...xamples/getspectredemocolorsExample1.cast b/...xamples/getspectredemocolorsExample1.cast → ...xamples/getspectredemocolorsExample1.cast
diff --git a/...examples/getspectredemoemojiExample1.cast → ...examples/getspectredemoemojiExample1.cast b/...examples/getspectredemoemojiExample1.cast → ...examples/getspectredemoemojiExample1.cast
diff --git a/...amples/getspectreescapedtextExample1.cast → ...amples/getspectreescapedtextExample1.cast b/...amples/getspectreescapedtextExample1.cast → ...amples/getspectreescapedtextExample1.cast
diff --git a/...lic/examples/getspectreimageExample1.cast → ...ets/examples/getspectreimageExample1.cast b/...lic/examples/getspectreimageExample1.cast → ...ets/examples/getspectreimageExample1.cast
diff --git a/.../getspectreimageexperimentalExample1.cast → .../getspectreimageexperimentalExample1.cast b/.../getspectreimageexperimentalExample1.cast → .../getspectreimageexperimentalExample1.cast
diff --git a/.../getspectreimageexperimentalExample2.cast → .../getspectreimageexperimentalExample2.cast b/.../getspectreimageexperimentalExample2.cast → .../getspectreimageexperimentalExample2.cast
diff --git a/...kespectrecommandwithprogressExample1.cast → ...kespectrecommandwithprogressExample1.cast b/...kespectrecommandwithprogressExample1.cast → ...kespectrecommandwithprogressExample1.cast
diff --git a/...kespectrecommandwithprogressExample2.cast → ...kespectrecommandwithprogressExample2.cast b/...kespectrecommandwithprogressExample2.cast → ...kespectrecommandwithprogressExample2.cast
diff --git a/...kespectrecommandwithprogressExample3.cast → ...kespectrecommandwithprogressExample3.cast b/...kespectrecommandwithprogressExample3.cast → ...kespectrecommandwithprogressExample3.cast
diff --git a/...kespectrecommandwithprogressExample4.cast → ...kespectrecommandwithprogressExample4.cast b/...kespectrecommandwithprogressExample4.cast → ...kespectrecommandwithprogressExample4.cast
diff --git a/...vokespectrecommandwithstatusExample1.cast → ...vokespectrecommandwithstatusExample1.cast b/...vokespectrecommandwithstatusExample1.cast → ...vokespectrecommandwithstatusExample1.cast
diff --git a/...okespectrescriptblockquietlyExample1.cast → ...okespectrescriptblockquietlyExample1.cast b/...okespectrescriptblockquietlyExample1.cast → ...okespectrescriptblockquietlyExample1.cast
diff --git a/...examples/newspectrechartitemExample1.cast → ...examples/newspectrechartitemExample1.cast b/...examples/newspectrechartitemExample1.cast → ...examples/newspectrechartitemExample1.cast
diff --git a/.../examples/readspectreconfirmExample1.cast → .../examples/readspectreconfirmExample1.cast b/.../examples/readspectreconfirmExample1.cast → .../examples/readspectreconfirmExample1.cast
diff --git a/...es/readspectremultiselectionExample1.cast → ...es/readspectremultiselectionExample1.cast b/...es/readspectremultiselectionExample1.cast → ...es/readspectremultiselectionExample1.cast
diff --git a/...spectremultiselectiongroupedExample1.cast → ...spectremultiselectiongroupedExample1.cast b/...spectremultiselectiongroupedExample1.cast → ...spectremultiselectiongroupedExample1.cast
diff --git a/...ic/examples/readspectrepauseExample1.cast → ...ts/examples/readspectrepauseExample1.cast b/...ic/examples/readspectrepauseExample1.cast → ...ts/examples/readspectrepauseExample1.cast
diff --git a/...ic/examples/readspectrepauseExample2.cast → ...ts/examples/readspectrepauseExample2.cast b/...ic/examples/readspectrepauseExample2.cast → ...ts/examples/readspectrepauseExample2.cast
diff --git a/...xamples/readspectreselectionExample1.cast → ...xamples/readspectreselectionExample1.cast b/...xamples/readspectreselectionExample1.cast → ...xamples/readspectreselectionExample1.cast
diff --git a/...lic/examples/readspectretextExample1.cast → ...ets/examples/readspectretextExample1.cast b/...lic/examples/readspectretextExample1.cast → ...ets/examples/readspectretextExample1.cast
diff --git a/...lic/examples/readspectretextExample2.cast → ...ets/examples/readspectretextExample2.cast b/...lic/examples/readspectretextExample2.cast → ...ets/examples/readspectretextExample2.cast
diff --git a/...lic/examples/readspectretextExample3.cast → ...ets/examples/readspectretextExample3.cast b/...lic/examples/readspectretextExample3.cast → ...ets/examples/readspectretextExample3.cast
diff --git a/...ic/examples/setspectrecolorsExample1.cast → ...ts/examples/setspectrecolorsExample1.cast b/...ic/examples/setspectrecolorsExample1.cast → ...ts/examples/setspectrecolorsExample1.cast
diff --git a/...amples/startspectrerecordingExample1.cast → ...amples/startspectrerecordingExample1.cast b/...amples/startspectrerecordingExample1.cast → ...amples/startspectrerecordingExample1.cast
diff --git a/...xamples/stopspectrerecordingExample1.cast → ...xamples/stopspectrerecordingExample1.cast b/...xamples/stopspectrerecordingExample1.cast → ...xamples/stopspectrerecordingExample1.cast
diff --git a/...lic/examples/waitspectrejobsExample1.cast → ...ets/examples/waitspectrejobsExample1.cast b/...lic/examples/waitspectrejobsExample1.cast → ...ets/examples/waitspectrejobsExample1.cast
diff --git a/...xamples/writespectrecalendarExample1.cast → ...xamples/writespectrecalendarExample1.cast b/...xamples/writespectrecalendarExample1.cast → ...xamples/writespectrecalendarExample1.cast
diff --git a/...xamples/writespectrecalendarExample2.cast → ...xamples/writespectrecalendarExample2.cast b/...xamples/writespectrecalendarExample2.cast → ...xamples/writespectrecalendarExample2.cast
diff --git a/...mples/writespectrefiglettextExample1.cast → ...mples/writespectrefiglettextExample1.cast b/...mples/writespectrefiglettextExample1.cast → ...mples/writespectrefiglettextExample1.cast
diff --git a/...mples/writespectrefiglettextExample2.cast → ...mples/writespectrefiglettextExample2.cast b/...mples/writespectrefiglettextExample2.cast → ...mples/writespectrefiglettextExample2.cast
diff --git a/...ic/examples/writespectrehostExample1.cast → ...ts/examples/writespectrehostExample1.cast b/...ic/examples/writespectrehostExample1.cast → ...ts/examples/writespectrehostExample1.cast
diff --git a/...ic/examples/writespectreruleExample1.cast → ...ts/examples/writespectreruleExample1.cast b/...ic/examples/writespectreruleExample1.cast → ...ts/examples/writespectreruleExample1.cast
diff --git a/PwshSpectreConsole.Docs/src/content/docs/guides/get-started.mdx b/PwshSpectreConsole.Docs/src/content/docs/guides/get-started.mdx
@@ -3,6 +3,8 @@ title: Get Started
 ---
 
 import Asciinema from '../../../components/Asciinema.astro'
+import readspectreselectionExample1 from '../../../assets/examples/readspectreselectionExample1.cast?url'
+import readspectremultiselectionExample1 from '../../../assets/examples/readspectremultiselectionExample1.cast?url'
 
 ### Demo
 
@@ -34,7 +36,7 @@ Write-SpectreHost "Your chosen color is '$color'"
 > Example of a user being prompted with a select list:
 
 <Asciinema
-    src="/examples/readspectreselectionExample1.cast"
+    src={readspectreselectionExample1}
     settings={{
         loop: false,
         poster: 'npt:0:0',
@@ -59,7 +61,7 @@ Write-SpectreHost "Your favourite fruits are $($chosenItems -join ', ')"
 > Example of a user being prompted with a multi-select list:
 
 <Asciinema
-    src="/examples/readspectremultiselectionExample1.cast"
+    src={readspectremultiselectionExample1}
     settings={{
         loop: false,
         poster: 'npt:0:0',

diff --git a/PwshSpectreConsole.Docs/src/powershell/Helpers.psm1 b/PwshSpectreConsole.Docs/src/powershell/Helpers.psm1
@@ -215,9 +215,10 @@ function Get-GitCommitDatesForHashFile {
 
 $script:AsciiCastTemplate = @'
 <Asciinema
-    src="CAST_URL"
+    src={CAST_NAME}
     settings={{
         loop: false,
+        preload: true,
         poster: 'npt:0:0.5',
         terminalLineHeight: 1.1,
         theme: "spectre"
@@ -230,5 +231,5 @@ function Get-AsciiCastTemplate {
         [string] $Name
     )
 
-    return $script:AsciiCastTemplate -replace "CAST_URL", $Name
+    return $script:AsciiCastTemplate -replace "CAST_NAME", $Name
 }
diff --git a/PwshSpectreConsole.Docs/src/powershell/UpdateDocs.ps1 b/PwshSpectreConsole.Docs/src/powershell/UpdateDocs.ps1
@@ -29,7 +29,7 @@ if($IsLinux) {
     $env:TEMP = "/tmp"
 }
 $outputPath = "$PSScriptRoot/../content/docs/reference/"
-$asciiCastOutputPath = "$PSScriptRoot/../../public/examples/"
+$asciiCastOutputPath = "$PSScriptRoot/../assets/examples/"
 $stagingPath = "$env:TEMP/refs-staging"
 if(Test-Path $stagingPath) {
     Remove-Item $stagingPath -Force -Recurse
@@ -162,10 +162,10 @@ foreach ($doc in $docs) {
 
                 $castName = ($doc.Name -replace '.md$', '' -replace '-', '').ToLower() + "Example$example"
                 Set-Content -Path "$asciiCastOutputPath\$castName.cast" -Value $recording
-                $castUrl = "/examples/$castName.cast"
+                $imports += "import $castName from '../../../../assets/examples/$castName.cast?url'`n"
 
                 # Replace the code block with the ascii cast
-                $castTemplate = Get-AsciiCastTemplate -Name $castUrl
+                $castTemplate = Get-AsciiCastTemplate -Name $castName
                 $content = $content -replace "(?ms)> EXAMPLE $example.+?(``````.+?``````)", "> EXAMPLE $example`n`n`$1`n$castTemplate"
             }
             $content = $content -replace "### Description", "$imports`n### Description"