@stacksjs/defaults 0.75.255 → 0.75.257

package/scaffold/config/cloud.ts

@@ -0,0 +1,103 @@
+import type { CloudConfig } from '@stacksjs/types'
+import type { CloudConfig as TsCloudConfig } from '@stacksjs/ts-cloud'
+import { env } from '@stacksjs/env'
+
+const APP_SLUG = '__APP_SLUG__'
+const APP_DOMAIN = env.APP_DOMAIN || undefined
+
+/**
+ * Safe application cloud defaults.
+ *
+ * Set APP_DOMAIN and provider credentials before the first deploy. Use
+ * `cloud.attachTo` only when this app is intentionally joining a server owned
+ * by another ts-cloud project.
+ */
+export const tsCloud: TsCloudConfig = {
+  project: {
+    name: APP_SLUG,
+    slug: APP_SLUG,
+    region: 'us-east-1',
+  },
+
+  stateDir: 'storage/cloud',
+
+  // Deploy to Hetzner Cloud, or set `provider: 'ssh'` to deploy to a Linux box
+  // you already own over SSH (a Raspberry Pi, a NUC, an old laptop):
+  //
+  //   cloud: { provider: 'ssh' },
+  //   ssh: { profile: 'raspberry-pi', hosts: [{ host: 'pi-stacks.local', user: 'pi' }] },
+  //
+  // See `buddy server:flash`, `server:first-boot`, `server:doctor` and
+  // `server:setup` for getting a fresh board to that point.
+  cloud: {
+    provider: 'hetzner',
+  },
+
+  mode: 'server',
+
+  environments: {
+    production: {
+      type: 'production',
+      deployBranch: 'main',
+      region: 'us-east-1',
+      variables: {
+        APP_ENV: 'production',
+        NODE_ENV: 'production',
+        LOG_LEVEL: 'info',
+      },
+    },
+  },
+
+  infrastructure: {
+    compute: {
+      instances: 1,
+      size: 'small',
+      disk: {
+        size: 20,
+        type: 'ssd',
+        encrypted: true,
+      },
+      webServer: 'rpx',
+      proxy: {
+        engine: 'rpx',
+        onDemandTls: true,
+      },
+    },
+  },
+
+  sites: {
+    main: {
+      root: '.',
+      path: '/',
+      domain: APP_DOMAIN,
+      start: 'bun node_modules/@stacksjs/buddy/dist/serve-entry.js',
+      port: 3000,
+      preStart: [
+        'bun install --frozen-lockfile',
+        'bun node_modules/@stacksjs/buddy/dist/cli.js migrate',
+      ],
+      env: {
+        APP_ENV: 'production',
+        NODE_ENV: 'production',
+        PORT_API: '3008',
+        API_URL: 'http://127.0.0.1:3008',
+      },
+    },
+
+    api: {
+      root: '.',
+      start: 'bun node_modules/@stacksjs/actions/dist/serve/api.js',
+      port: 3008,
+      preStart: ['bun install --frozen-lockfile'],
+      env: {
+        HOST: '127.0.0.1',
+        APP_ENV: 'production',
+        NODE_ENV: 'production',
+      },
+    },
+  },
+}
+
+const config: CloudConfig = {}
+
+export default config

package/scaffold/config/dns.ts

@@ -0,0 +1,16 @@
+import type { DnsConfig } from '@stacksjs/types'
+
+/**
+ * Additional DNS records owned by this application.
+ *
+ * Server records are derived from config/cloud.ts during deployment. Add
+ * provider and zone details there before asking Buddy to reconcile DNS.
+ */
+export default {
+  a: [],
+  aaaa: [],
+  cname: [],
+  mx: [],
+  txt: [],
+  nameservers: [],
+} satisfies DnsConfig

package/scaffold/config/docs.ts

@@ -0,0 +1,57 @@
+import type { BunPressOptions } from '@stacksjs/bunpress'
+import { env } from '@stacksjs/env'
+
+/**
+ * **Documentation Configuration**
+ *
+ * Your app's documentation site, built with BunPress from `docs/`. There is no
+ * `docs/` until you create one: add `docs/index.md` and `buddy dev` serves it
+ * at /docs, and `buddy deploy` builds it.
+ */
+
+// APP_URL is often a bare host, which is not a URL on its own.
+const appUrl = String(env.APP_URL || '').replace(/\/+$/, '')
+const siteUrl = appUrl && !/^https?:\/\//.test(appUrl) ? `https://${appUrl}` : appUrl
+
+const config: BunPressOptions = {
+  verbose: false,
+  docsDir: './docs',
+  outDir: './dist/docs',
+
+  nav: [],
+
+  markdown: {
+    title: `${env.APP_NAME || '__APP_NAME__'} Documentation`,
+    meta: {
+      description: '',
+      author: env.APP_NAME || '__APP_NAME__',
+    },
+    syntaxHighlightTheme: 'github-dark',
+    toc: {
+      enabled: true,
+      minDepth: 2,
+      maxDepth: 3,
+    },
+    sidebar: {
+      '/': [
+        {
+          text: 'Getting Started',
+          items: [
+            { text: 'Introduction', link: '/' },
+          ],
+        },
+      ],
+    },
+  },
+
+  sitemap: {
+    enabled: Boolean(siteUrl),
+    baseUrl: siteUrl ? `${siteUrl}/docs` : '',
+  },
+
+  robots: {
+    enabled: true,
+  },
+}
+
+export default config

package/scaffold/config/email.ts

@@ -0,0 +1,27 @@
+import type { EmailConfig } from '@stacksjs/types'
+import { env } from '@stacksjs/env'
+
+export default {
+  from: {
+    name: env.MAIL_FROM_NAME || '__APP_NAME__',
+    address: env.MAIL_FROM_ADDRESS || 'hello@example.com',
+  },
+
+  domain: env.MAIL_DOMAIN || env.APP_DOMAIN || 'example.com',
+  mailboxes: [],
+  forwards: {},
+  url: env.APP_URL || '__APP_SLUG__.localhost',
+  charset: 'UTF-8',
+
+  server: {
+    // Explicit opt-in: a generated application must never reconcile the
+    // framework repository's shared mail server or mailboxes.
+    enabled: false,
+    scan: true,
+    subdomain: 'mail',
+    // Gmail Postmaster Tools shows how Gmail receives your mail. Add your
+    // domain at https://postmaster.google.com, paste the TXT value it shows,
+    // and every deploy keeps it published.
+    // postmaster: { google: 'google-site-verification=...' },
+  },
+} satisfies EmailConfig

package/scaffold/config/library.ts

@@ -0,0 +1,64 @@
+import type { LibraryConfig } from '@stacksjs/types'
+
+/**
+ * **Library Configuration**
+ *
+ * This configuration defines all of your library options. Because Stacks is fully-typed, you
+ * may hover any of the options below and the definitions will be provided. In case you
+ * have any questions, feel free to reach out via Discord or GitHub Discussions.
+ */
+export default {
+  name: '__APP_SLUG__',
+  // The npm scope your packages publish under, e.g. 'your-org'. Set it before
+  // `buddy libs:publish`; the @ prefix is added automatically.
+  owner: null,
+  // `owner/name` on GitHub; fills in each package's repository, homepage and bugs links.
+  repository: '',
+  license: 'MIT',
+  author: '',
+  contributors: [],
+  defaultLanguage: 'en',
+  releaseable: true,
+
+  /**
+   * One `resources/` tree, any number of npm packages.
+   *
+   * Each entry claims a slice of `resources/functions` or `resources/components`
+   * by glob and becomes its own package: its own name, manifest, dist and
+   * version. Slices may overlap, so a component can ship in a bundle package
+   * and in a focused one. `buddy libs` prints what each package resolved to,
+   * `buddy build:libs` builds them all, `buddy libs:publish` publishes them.
+   */
+  packages: [
+    {
+      name: '__APP_SLUG__-fx',
+      kind: 'functions',
+      description: 'Your function library description.',
+      keywords: ['functions', 'composables', 'library', 'typescript', 'javascript'],
+      include: ['*.ts'],
+      // These composables call stx's ambient globals (`state`, `useDark`),
+      // which no module exports. Saying so here is what lets them ship: the
+      // build otherwise refuses them, because a consumer importing the
+      // published package would hit `ReferenceError: state is not defined`.
+      runtime: 'stx',
+    },
+
+    {
+      name: '__APP_SLUG__-components',
+      kind: 'components',
+      description: 'Your STX component library, as tree-shakeable modules.',
+      keywords: ['components', 'custom-elements', 'stx', 'library', 'typescript'],
+      prefix: '__APP_TAG_PREFIX__',
+      include: ['*.stx'],
+    },
+
+    {
+      name: '__APP_SLUG__-elements',
+      kind: 'web-components',
+      description: 'Your framework agnostic web component library description.',
+      keywords: ['custom-elements', 'web-components', 'library', 'framework-agnostic', 'typescript', 'javascript'],
+      prefix: '__APP_TAG_PREFIX__',
+      include: ['*.stx'],
+    },
+  ],
+} satisfies LibraryConfig

package/scaffold/config/lint.ts

@@ -0,0 +1,42 @@
+import type { LintConfig } from '@stacksjs/types'
+
+/**
+ * Lint configuration.
+ *
+ * Code style lives in `config/code-style.ts` (pickier's own options). This file
+ * holds the checks Stacks runs on top of it - today, the stx conformance
+ * checks behind `buddy lint --stx`.
+ *
+ * The baselines are a ratchet. A number is a DEBT, not a target: going above
+ * one fails, and dropping below one is reported too, so a cleared violation has
+ * to be recorded rather than quietly banked. Every non-zero entry names what
+ * clears it.
+ */
+const config: LintConfig = {
+  stx: {
+    baselines: {
+      'comment-landmine': 0,
+      'dist-component-error': 0,
+      'dist-layout-published': 0,
+      'dist-path-leak': 0,
+      'script-tag-balance': 0,
+      'strict-lint': 0,
+      'unmanaged-timer': 0,
+      'style-block': 0,
+      'dom-guard': 0,
+      'inline-style-attr': 0,
+      'plain-internal-anchor': 0,
+
+      // config/ui.ts sets neither `strict` nor `pagesDir`. Pinning pagesDir
+      // changes how stx resolves topology, so it wants its own dev+build pass
+      // rather than being swept in with a lint change.
+      'stx-config-keys': 2,
+
+      // resources/emails/order-confirmation.stx is a whole email document, so
+      // it owns its DOCTYPE.
+      'doctype-no-nolayout': 1,
+    },
+  },
+}
+
+export default config

package/scaffold/config/mobile.ts

@@ -0,0 +1,27 @@
+import type { MobileConfig } from '@stacksjs/types'
+import { env } from '@stacksjs/env'
+
+export default {
+  ios: {
+    appName: env.APP_NAME ?? '__APP_NAME__',
+    // A placeholder the App Store rejects on purpose: replace it with your own
+    // reverse-DNS id before the first build you mean to ship.
+    bundleId: '__APP_BUNDLE_ID__',
+    version: '1.0.0',
+    buildNumber: '1',
+    deploymentTarget: '16.0',
+    url: env.APP_URL,
+    darkMode: true,
+    backgroundColor: '#0a0a0a',
+    orientations: ['portrait'],
+    capabilities: {
+      haptics: true,
+      share: true,
+      secureStorage: true,
+      clipboard: true,
+      localDatabase: true,
+      screenCapture: true,
+      pdfViewer: true,
+    },
+  },
+} satisfies MobileConfig

package/scaffold/config/team.ts

@@ -0,0 +1,6 @@
+import type { Team } from '@stacksjs/types'
+
+export default {
+  name: '__APP_NAME__',
+  members: {},
+} satisfies Team

package/scaffold/resources/views/index.stx

@@ -0,0 +1,65 @@
+<script server>
+/**
+ * The starter page `buddy new` gives every app, at `/`.
+ *
+ * Everything that names the site comes from the app's own config: the title
+ * from APP_NAME and the canonical URL from APP_URL (via config/app.ts), so a
+ * deploy of an untouched app describes itself rather than anyone else.
+ * Replace this file with your own homepage.
+ */
+import { config } from '@stacksjs/config'
+
+const appName = config.app.name || 'My App'
+
+// APP_URL is often a bare host (`my-app.localhost`), which is not a valid
+// canonical href on its own.
+const rawUrl = String(config.app.url || '').replace(/\/+$/, '')
+const siteUrl = rawUrl && !/^https?:\/\//.test(rawUrl) ? `https://${rawUrl}` : rawUrl
+const canonicalUrl = siteUrl ? `${siteUrl}/` : ''
+
+const pageDescription = `${appName} is up and running.`
+
+const nextSteps = [
+  { icon: 'i-hugeicons-file-edit', title: 'Edit this page', path: 'resources/views/index.stx' },
+  { icon: 'i-hugeicons-database-01', title: 'Define a model', path: 'app/Models' },
+  { icon: 'i-hugeicons-route-01', title: 'Add an API route', path: 'routes/api.ts' },
+  { icon: 'i-hugeicons-settings-02', title: 'Configure the app', path: 'config/app.ts' },
+]
+</script>
+
+@nolayout
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>{{ appName }}</title>
+    <meta name="description" content="{{ pageDescription }}">
+    @if(canonicalUrl)
+      <link rel="canonical" href="{{ canonicalUrl }}">
+    @endif
+  </head>
+  <body class="min-h-screen antialiased text-neutral-900 dark:text-neutral-100 bg-neutral-50 dark:bg-neutral-950">
+    <main class="flex flex-col justify-center mx-auto px-6 py-16 max-w-2xl min-h-screen">
+      <p class="font-medium text-neutral-500 text-sm dark:text-neutral-400">Your app is running</p>
+      <h1 class="mt-2 font-semibold text-4xl tracking-tight">{{ appName }}</h1>
+      <p class="mt-4 text-neutral-600 dark:text-neutral-300">
+        Start with <code class="px-1.5 py-0.5 text-sm bg-neutral-200 dark:bg-neutral-800 rounded">./buddy dev</code>, then make it yours.
+      </p>
+
+      <ul class="mt-10 border-neutral-200 border-y divide-neutral-200 divide-y dark:border-neutral-800 dark:divide-neutral-800">
+        @foreach(nextSteps as step)
+          <li class="flex gap-4 items-center py-4">
+            <span class="{{ step.icon }} size-5 text-neutral-500 dark:text-neutral-400" aria-hidden="true"></span>
+            <span class="font-medium">{{ step.title }}</span>
+            <code class="ml-auto text-neutral-500 text-sm dark:text-neutral-400">{{ step.path }}</code>
+          </li>
+        @endforeach
+      </ul>
+
+      <p class="mt-10 text-neutral-500 text-sm dark:text-neutral-400">
+        <a class="underline underline-offset-4 hover:text-neutral-900 dark:hover:text-neutral-100" href="https://stacksjs.com/docs">Read the Stacks docs</a>
+      </p>
+    </main>
+  </body>
+</html>