chore: wip

chrisbbreuer · chrisbbreuer · commit 7ecb3e01b477 · 2024-01-19T18:10:16.000-08:00
chore: wip

chore: wip

chore: wip

chore: wip

chore: wip

chore: wip

chore: wip

chore: wip
diff --git a/bootstrap b/bootstrap
@@ -25,25 +25,35 @@ fi
 
 # Get the directory of the current script and go up 3 directories
 PROJECT_ROOT="$(cd "$(dirname "$0")" && pwd)"
+CLI_PATH="$PROJECT_ROOT/storage/framework/core/buddy/src/cli.ts"
+SCRIPT_PATH="$PROJECT_ROOT/storage/framework/scripts/pkgx-install"
+LOG_PATH="$PROJECT_ROOT/storage/logs/console.log"
+
+if [[ $* == *--verbose* ]]; then
+  echo "Project root: $PROJECT_ROOT"
+  echo "CLI path: $CLI_PATH"
+  echo "Script path: $SCRIPT_PATH"
+  echo "Log path: $LOG_PATH"
+fi
 
 cd $PROJECT_ROOT
 # Run the pkgx-install script
 if [[ $* == *--verbose* ]]; then
-  "./storage/framework/scripts/pkgx-install"
+  "$SCRIPT_PATH"
   # bun --bun ./storage/framework/core/buddy/src/cli.ts setup --verbose
 else
-  "./storage/framework/scripts/pkgx-install" > /dev/null 2>&1
+  "$SCRIPT_PATH" > /dev/null 2>&1
   # bun --bun ./storage/framework/core/buddy/src/cli.ts setup
 fi
 
 # Create a named pipe
 mkfifo /tmp/mypipe
 
 # Run the command, send output to both the console and the pipe
-bun --bun ./storage/framework/core/buddy/src/cli.ts setup | tee /tmp/mypipe &
+bun --bun $CLI_PATH setup | tee /tmp/mypipe &
 
 # Read from the pipe, add timestamps, and append to the file
-while IFS= read -r line; do echo "$(date '+[%Y-%m-%d %H:%M:%S]') $line"; done < /tmp/mypipe >> storage/logs/console.log
+while IFS= read -r line; do echo "$(date '+[%Y-%m-%d %H:%M:%S]') $line"; done < /tmp/mypipe >> $LOG_PATH
 
 # Remove the named pipe
 rm /tmp/mypipe
diff --git a/bun.lockb b/bun.lockb
diff --git a/config/docs.ts b/config/docs.ts
@@ -282,7 +282,7 @@ const sidebar = {
 export default {
   lang: 'en-US',
   title: 'Stacks',
-  description: 'Rapid application, cloud & library framework.',
+  description: 'Rapid application, cloud & library development framework.',
   lastUpdated: true,
 
   themeConfig: {
diff --git a/docs/_data/team.js b/docs/_data/team.js
@@ -13,17 +13,29 @@ export const core = [
     sponsor: 'https://github.com/sponsors/chrisbbreuer',
   },
   {
-    avatar: 'https://www.github.com/brianzzzasd.png',
-    name: 'Brian',
+    avatar: 'https://avatars.githubusercontent.com/u/977413',
+    name: 'Dorell James',
     title: 'A collaborative being',
     org: 'Stacks',
     orgLink: 'https://stacksjs.org/',
     desc: 'Core team member of Stacks.',
     links: [
-      { icon: 'github', link: 'https://github.com/brianzzzasd' },
-      { icon: 'twitter', link: 'https://twitter.com/brianzzzasd' },
+      { icon: 'github', link: 'https://github.com/dorelljames' },
+      { icon: 'twitter', link: 'https://twitter.com/dorelljames' },
     ],
-    sponsor: 'https://github.com/sponsors/brianzzzasd',
+    sponsor: 'https://github.com/sponsors/dorelljames',
+  },
+  {
+    avatar: 'https://avatars.githubusercontent.com/u/29087513',
+    name: 'Glenn Michael',
+    title: 'A collaborative being',
+    org: 'Stacks',
+    orgLink: 'https://stacksjs.org/',
+    desc: 'Core team member of Stacks.',
+    links: [
+      { icon: 'github', link: 'https://github.com/glennmichael123' },
+    ],
+    sponsor: 'https://github.com/sponsors/dorelljames',
   },
 ]
 
diff --git a/docs/team.md b/docs/team.md
@@ -1,7 +1,7 @@
 ---
 layout: page
 title: Meet the Team
-description: The development of Stacks is guided by an international team.
+description: A team of incredible people.
 ---
 
 <script setup>
@@ -18,8 +18,7 @@ import { core, emeriti } from './_data/team'
   <VPTeamPageTitle>
     <template #title>Meet the Team</template>
     <template #lead>
-      The development of Stacks is guided by an international team, some of whom
-      have chosen to be featured below.
+      A team of incredible talent & ambition.
     </template>
   </VPTeamPageTitle>
   <VPTeamMembers :members="core" />
diff --git a/public/aws.webp b/public/aws.webp
diff --git a/public/logo.png b/public/logo.png
diff --git a/storage/framework/core/buddy/src/commands/setup.ts b/storage/framework/core/buddy/src/commands/setup.ts
@@ -1,6 +1,7 @@
 import process from 'node:process'
 import { path as p } from '@stacksjs/path'
 import { handleError } from '@stacksjs/error-handling'
+import { storage } from '@stacksjs/storage'
 import { log, runCommand } from '@stacksjs/cli'
 import { ExitCode } from '@stacksjs/types'
 import type { CLI, CliOptions } from '@stacksjs/types'
@@ -68,16 +69,21 @@ async function initializeProject(options: CliOptions): Promise<void> {
   log.success('Installed node_modules')
   log.info('Ensuring .env exists...')
 
-  const envResult = await runCommand('cp .env.example .env', {
-    cwd: options.cwd || p.projectPath(),
-  })
+  // if storage.exists('.env') {
+  if (storage.doesNotExist(p.projectPath('.env'))) {
+    const envResult = await runCommand('cp .env.example .env', {
+      cwd: options.cwd || p.projectPath(),
+    })
 
-  if (envResult.isErr()) {
-    handleError(envResult.error)
-    process.exit(ExitCode.FatalError)
+    if (envResult.isErr()) {
+      handleError(envResult.error)
+      process.exit(ExitCode.FatalError)
+    }
+
+    log.success('.env created')
   }
+  else { log.success('.env existed') }
 
-  log.success('.env exists')
   log.info('Generating application key...')
 
   const keyResult = await runCommand('buddy key:generate', {
diff --git a/storage/framework/core/cloud/src/cloud/lambda/cli-setup/index.js b/storage/framework/core/cloud/src/cloud/lambda/cli-setup/index.js
@@ -40,7 +40,7 @@ mkfifo /tmp/mypipe
 bun --bun ./storage/framework/core/buddy/src/cli.ts setup | tee /tmp/mypipe &
 
 # Read from the pipe, add timestamps, and append to the file
-while IFS= read -r line; do echo "$(date '+[%Y-%m-%d %H:%M:%S]') $line"; done < /tmp/mypipe >> storage/logs/console.log
+while IFS= read -r line; do echo "$(date '+[%Y-%m-%d %H:%M:%S]') $line"; done < /tmp/mypipe >> ./storage/logs/console.log
 
 # Remove the named pipe
 rm /tmp/mypipe
diff --git a/storage/framework/core/docs/build.ts b/storage/framework/core/docs/build.ts
@@ -1,6 +1,6 @@
 import { log, runCommand } from '@stacksjs/cli'
 
-const result = await runCommand('bun build ./src/index.ts --outdir dist --format esm --external vitepress --external @stacksjs/config --external @stacksjs/alias --external @stacksjs/path --external @stacksjs/vite --external @stacksjs/server --external @stacksjs/env --external @stacksjs/cli --target bun', {
+const result = await runCommand('bun build ./src/index.ts --outdir dist --format esm --external vitepress --external @stacksjs/config --external @stacksjs/alias --external @stacksjs/path --external @stacksjs/vite --external @stacksjs/server --external @stacksjs/env --external @stacksjs/cli --external @vite-pwa/vitepress --target bun', {
   cwd: import.meta.dir,
 })
 
diff --git a/storage/framework/core/docs/package.json b/storage/framework/core/docs/package.json
@@ -63,6 +63,7 @@
     "vitepress-plugin-twoslash": "^0.9.19"
   },
   "devDependencies": {
-    "@stacksjs/development": "workspace:*"
+    "@stacksjs/development": "workspace:*",
+    "@vite-pwa/vitepress": "^0.3.1"
   }
 }
diff --git a/storage/framework/core/docs/src/index.ts b/storage/framework/core/docs/src/index.ts
@@ -5,7 +5,9 @@ import { path as p } from '@stacksjs/path'
 import { docs } from '@stacksjs/config'
 import { server } from '@stacksjs/server'
 import { kolorist as c } from '@stacksjs/cli'
+import { withPwa } from '@vite-pwa/vitepress'
 import { version } from '../../../../../package.json'
+import { pwaDocs as pwa } from './scripts/pwa'
 
 export const frameworkDefaults = {
   base: '/docs/',
@@ -49,13 +51,17 @@ export const frameworkDefaults = {
       },
     ],
   },
+
+  pwa,
 } satisfies UserConfig
 
 const config: UserConfig = {
   ...frameworkDefaults,
   ...docs,
 }
 
-export default defineConfig(config)
+export default withPwa(defineConfig(config))
 
 export * from './plugins'
+export * from './scripts/pwa'
+export * from './meta'
diff --git a/storage/framework/core/docs/src/meta.ts b/storage/framework/core/docs/src/meta.ts
@@ -0,0 +1,32 @@
+// noinspection ES6PreferShortImport: IntelliJ IDE hint to avoid warning to use `~/contributors`, will fail on build if changed
+
+/* Texts */
+// export const stacksName = 'Stacks'
+// export const stacksShortName = 'Stacks'
+// export const stacksDescription = 'Rapid application, cloud & library development framework'
+
+/* CDN fonts and styles */
+export const googleapis = 'https://fonts.googleapis.com'
+export const gstatic = 'https://fonts.gstatic.com'
+export const font = `${googleapis}/css2?family=Readex+Pro:wght@200;400;600&display=swap`
+
+/* vitepress head */
+export const ogUrl = 'https://stacksjs.org/'
+export const ogImage = `${ogUrl}og.png`
+
+/* GitHub and social links */
+export const github = 'https://github.com/stacksjs/stacks'
+export const releases = 'https://github.com/stacksjs/stacks/releases'
+export const contributing = 'https://github.com/stacksjs/stacks/blob/main/CONTRIBUTING.md'
+export const discord = 'https://chat.stacksjs.org'
+export const twitter = 'https://twitter.com/stacksjs'
+
+/* Avatar/Image/Sponsors servers */
+export const preconnectLinks = [googleapis, gstatic]
+export const preconnectHomeLinks = [googleapis, gstatic]
+
+/* PWA runtime caching urlPattern regular expressions */
+export const pwaFontsRegex = new RegExp(`^${googleapis}/.*`, 'i')
+export const pwaFontStylesRegex = new RegExp(`^${gstatic}/.*`, 'i')
+// eslint-disable-next-line prefer-regex-literals
+export const githubusercontentRegex = new RegExp('^https://((i.ibb.co)|((raw|user-images).githubusercontent.com))/.*', 'i')
diff --git a/storage/framework/core/docs/src/scripts/pwa.ts b/storage/framework/core/docs/src/scripts/pwa.ts
@@ -0,0 +1,116 @@
+import { frameworkPath } from '@stacksjs/path'
+import type { PwaOptions } from '@vite-pwa/vitepress'
+import { docs } from '@stacksjs/config'
+import { githubusercontentRegex, pwaFontStylesRegex, pwaFontsRegex } from '../meta'
+
+export const pwaDocs: PwaOptions = {
+  outDir: frameworkPath('docs/dist'),
+  registerType: 'autoUpdate',
+  // include all static assets under public/
+  manifest: {
+    id: '/',
+    name: docs.title,
+    short_name: docs.title,
+    description: docs.description,
+    theme_color: '#ffffff',
+    start_url: '/',
+    lang: 'en-US',
+    dir: 'ltr',
+    orientation: 'natural',
+    display: 'standalone',
+    display_override: ['window-controls-overlay'],
+    categories: ['development', 'developer tools'],
+    icons: [
+      {
+        src: 'pwa-64x64.png',
+        sizes: '64x64',
+        type: 'image/png',
+      },
+      {
+        src: 'pwa-192x192.png',
+        sizes: '192x192',
+        type: 'image/png',
+      },
+      {
+        src: 'pwa-512x512.png',
+        sizes: '512x512',
+        type: 'image/png',
+        purpose: 'any',
+      },
+      {
+        src: 'maskable-icon.png',
+        sizes: '512x512',
+        type: 'image/png',
+        purpose: 'maskable',
+      },
+    ],
+    screenshots: [{
+      src: 'og.png',
+      sizes: '2258x1185',
+      type: 'image/png',
+      label: `Screenshot of ${docs.title}`,
+    }],
+    handle_links: 'preferred',
+    launch_handler: {
+      client_mode: ['navigate-existing', 'auto'],
+    },
+    edge_side_panel: {
+      preferred_width: 480,
+    },
+  },
+  workbox: {
+    navigateFallbackDenylist: [/^\/new$/],
+    // warning: sponsors/antfu.svg is 2.51 MB, and won't be precached
+    maximumFileSizeToCacheInBytes: 3 * 1024 * 1024, // <== 3MB
+    globPatterns: ['**/*.{css,js,html,png,svg,ico,txt,woff2,json}'],
+    // Rollup 4 change the layout: don't calculate revision (hash)
+    dontCacheBustURLsMatching: /^assets\//,
+    runtimeCaching: [
+      {
+        urlPattern: pwaFontsRegex,
+        handler: 'CacheFirst',
+        options: {
+          cacheName: 'google-fonts-cache',
+          expiration: {
+            maxEntries: 10,
+            maxAgeSeconds: 60 * 60 * 24 * 365, // <== 365 days
+          },
+          cacheableResponse: {
+            statuses: [0, 200],
+          },
+        },
+      },
+      {
+        urlPattern: pwaFontStylesRegex,
+        handler: 'CacheFirst',
+        options: {
+          cacheName: 'gstatic-fonts-cache',
+          expiration: {
+            maxEntries: 10,
+            maxAgeSeconds: 60 * 60 * 24 * 365, // <== 365 days
+          },
+          cacheableResponse: {
+            statuses: [0, 200],
+          },
+        },
+      },
+      {
+        urlPattern: githubusercontentRegex,
+        handler: 'CacheFirst',
+        options: {
+          cacheName: 'githubusercontent-images-cache',
+          expiration: {
+            maxEntries: 10,
+            maxAgeSeconds: 60 * 60 * 24 * 365, // <== 365 days
+          },
+          cacheableResponse: {
+            statuses: [0, 200],
+          },
+        },
+      },
+    ],
+  },
+  experimental: {
+    includeAllowlist: true,
+  },
+}
diff --git a/storage/framework/core/storage/src/files.ts b/storage/framework/core/storage/src/files.ts
@@ -95,6 +95,14 @@ export function isFile(path: string): boolean {
   return fs.existsSync(path)
 }
 
+export function doesExist(path: string): boolean {
+  return !isFile(path) || !isFolder(path)
+}
+
+export function doesNotExist(path: string): boolean {
+  return !isFile(path) && !isFolder(path)
+}
+
 /**
  * Determine whether a folder has any files in it.
  */
diff --git a/storage/framework/docs/.vitepress/config.ts b/storage/framework/docs/.vitepress/config.ts
@@ -1,8 +1,10 @@
 import { defineConfig } from 'vitepress'
 import { alias } from '@stacksjs/alias'
 import { path as p } from '@stacksjs/path'
+import { pwaDocs as pwa } from '@stacksjs/docs'
 import { server } from '@stacksjs/server'
 import { transformerTwoslash } from 'vitepress-plugin-twoslash'
+import { withPwa } from '@vite-pwa/vitepress'
 import userConfig from '../../../../config/docs'
 import { analyticsHead, faviconHead } from './head'
 
@@ -11,10 +13,10 @@ import { analyticsHead, faviconHead } from './head'
 // import { version } from '../../../../stacks/package.json'
 
 // https://vitepress.dev/reference/site-config
-export default defineConfig({
+export default withPwa(defineConfig({
   srcDir: p.projectPath('docs'),
-  outDir: p.projectStoragePath('framework/docs/dist'),
-  cacheDir: p.projectStoragePath('framework/cache/docs'),
+  outDir: p.frameworkPath('docs/dist'),
+  cacheDir: p.frameworkPath('cache/docs'),
   assetsDir: p.assetsPath(),
   publicDir: p.publicPath(),
 
@@ -53,11 +55,13 @@ export default defineConfig({
     ...analyticsHead,
   ],
 
+  pwa,
+
   markdown: {
     codeTransformers: [
       transformerTwoslash(),
     ],
   },
 
   ...userConfig,
-})
+}))
diff --git a/storage/framework/docs/package.json b/storage/framework/docs/package.json
diff --git a/storage/framework/ide/dictionary.txt b/storage/framework/ide/dictionary.txt
diff --git a/storage/framework/scripts/setup b/storage/framework/scripts/setup
