@stacksjs/config 0.38.3

package/dist/index.d.ts

@@ -0,0 +1,124 @@
+import { CliOptions, AppOptions, DeployOptions, DocsConfig, GitOptions, HashingOptions, LibraryOptions, UiOptions } from '@stacksjs/types';
+
+/**
+ * Determines the level of debugging.
+ * @param options
+ */
+declare function determineDebugMode(options?: CliOptions): boolean;
+
+/**
+ * ### Application Options
+ *
+ * This configuration defines all of your application options. Because Stacks is full-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.
+ */
+declare const app: AppOptions;
+
+/**
+ * ### Deployment Options
+ *
+ * This configuration defines all of your deploy options. Because Stacks is full-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.
+ */
+declare const deploy: DeployOptions;
+
+/**
+ * ### Documentation Options
+ *
+ * This configuration defines all of your documentation options. Because Stacks is full-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.
+ */
+declare const _default: DocsConfig;
+
+declare namespace docs {
+  export {
+    _default as default,
+  };
+}
+
+/**
+ * ### Git Options
+ *
+ * This configuration defines all of your git options. Because Stacks is full-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.
+ */
+declare const git: GitOptions;
+
+declare const hashing: HashingOptions;
+
+/**
+ * ### Library Options
+ *
+ * This configuration defines all of your library options. Because Stacks is full-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.
+ */
+declare const library: LibraryOptions;
+
+/**
+ * ### Services
+ *
+ * This configuration defines all of your services. Because Stacks is full-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.
+ */
+declare const services: {
+    algolia: {
+        appId: string;
+        apiKey: string;
+        indexName: string;
+    };
+    meilisearch: {
+        appId: string;
+        apiKey: string;
+        indexName: string;
+    };
+    stripe: {
+        appId: string;
+        apiKey: string;
+    };
+    planetscale: {
+        appId: string;
+        apiKey: string;
+    };
+    supabase: {
+        appId: string;
+        apiKey: string;
+    };
+    aws: {
+        appId: string;
+        apiKey: string;
+    };
+};
+
+/**
+ * ### UI Engine Options
+ *
+ * This configuration defines all of your UI Engine options. Because Stacks is full-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.
+ */
+declare const ui: UiOptions;
+
+/**
+ * ### Cache Options
+ *
+ * This configuration defines all of your cache options. Because Stacks is full-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.
+ */
+declare const cache: {
+    default: any;
+    redis: {
+        driver: string;
+        connection: string;
+        host: any;
+        port: any;
+    };
+};
+
+export { app, cache, deploy, determineDebugMode, docs, git, hashing, library, services, ui };

package/dist/index.mjs

@@ -0,0 +1,298 @@
+import { env } from '@stacksjs/utils';
+import { frameworkPath } from '@stacksjs/path';
+
+function determineDebugMode(options) {
+  if (options?.debug === true)
+    return true;
+  if (app.debug === true)
+    return true;
+  return false;
+}
+
+const app = {
+  name: env("APP_NAME", "Stacks"),
+  env: env("APP_ENV", "local"),
+  key: env("APP_KEY", ""),
+  debug: env("APP_DEBUG", false),
+  url: env("APP_URL", "https://localhost"),
+  port: env("APP_PORT", 3333),
+  timezone: "UTC",
+  locale: "en",
+  fallbackLocale: "en",
+  cipher: "aes-256-cbc",
+  editor: "vscode"
+};
+
+const deploy = {
+  host: "netlify"
+};
+
+const services = {
+  algolia: {
+    appId: "",
+    apiKey: "",
+    indexName: ""
+  },
+  meilisearch: {
+    appId: "",
+    apiKey: "",
+    indexName: ""
+  },
+  stripe: {
+    appId: "",
+    apiKey: ""
+  },
+  planetscale: {
+    appId: "",
+    apiKey: ""
+  },
+  supabase: {
+    appId: "",
+    apiKey: ""
+  },
+  aws: {
+    appId: "",
+    apiKey: ""
+  }
+};
+
+const docs = {
+  outDir: frameworkPath("docs/dist"),
+  lang: "en-US",
+  title: "Stacks",
+  description: "Composability-First. UI/FX Framework.",
+  lastUpdated: true,
+  themeConfig: {
+    nav: nav(),
+    sidebar: {
+      "/guide/": sidebarGuide()
+    },
+    editLink: {
+      pattern: "https://github.com/stacksjs/stacks/edit/main/apps/docs/docs/:path",
+      text: "Edit this page on GitHub"
+    },
+    socialLinks: [
+      { icon: "twitter", link: "https://twitter.com/stacksjs" },
+      { icon: "github", link: "https://github.com/stacksjs/stacks" },
+      { icon: "discord", link: "https://twitter.com/stacksjs" }
+    ],
+    footer: {
+      message: "Released under the MIT License.",
+      copyright: "Copyright \xA9 2022-present Open Web Foundation"
+    },
+    algolia: services.algolia,
+    carbonAds: {
+      code: "",
+      placement: ""
+    }
+  }
+};
+function nav() {
+  return [
+    { text: "Config", link: "/config", activeMatch: "/config" },
+    {
+      text: "Changelog",
+      link: "https://github.com/stacksjs/stacks/blob/main/CHANGELOG.md"
+    },
+    { text: "Blog", link: "https://updates.ow3.org" }
+  ];
+}
+function sidebarGuide() {
+  return [
+    {
+      text: "Introduction",
+      collapsible: true,
+      items: [
+        { text: "What is Stacks?", link: "/guide/what-is-stacks" },
+        { text: "Getting Started", link: "/guide/getting-started" },
+        { text: "Configuration", link: "/guide/config" }
+      ]
+    },
+    {
+      text: "Digging Deeper",
+      collapsible: true,
+      items: [
+        { text: "How To?", link: "/guide/stacks" },
+        { text: "Workflows / CI", link: "/guide/ci" },
+        { text: "VS Code", link: "/guide/vs-code" },
+        { text: "Apps", link: "/guide/apps" },
+        { text: "Examples", link: "/guide/examples" },
+        { text: "Packages", link: "/guide/packages" },
+        { text: "Testing", link: "/guide/testing" },
+        { text: "Single File Components", link: "/guide/sfcs" }
+      ]
+    },
+    {
+      text: "Starters",
+      collapsible: true,
+      items: [
+        { text: "Vue Starter", link: "/starter/vue" },
+        { text: "Web Component Starter", link: "/starter/web-components" },
+        { text: "Composable Starter", link: "/starter/web-components" },
+        { text: "TypeScript Starter", link: "/starter/web-components" }
+      ]
+    }
+  ];
+}
+
+const docs$1 = {
+  __proto__: null,
+  default: docs
+};
+
+const git = {
+  hooks: {
+    "pre-commit": "lint-staged"
+  },
+  scopes: [
+    "",
+    "ci",
+    "deps",
+    "dx",
+    "release",
+    "docs",
+    "test",
+    "core",
+    "actions",
+    "arrays",
+    "auth",
+    "build",
+    "cache",
+    "cli",
+    "cloud",
+    "collections",
+    "config",
+    "database",
+    "datetime",
+    "docs",
+    "errors",
+    "git",
+    "lint",
+    "logging",
+    "modules",
+    "notifications",
+    "objects",
+    "path",
+    "realtime",
+    "router",
+    "runtime",
+    "security",
+    "server",
+    "storage",
+    "strings",
+    "tests",
+    "types",
+    "ui",
+    "utils"
+  ],
+  messages: {
+    type: "Select the type of change that you're committing:",
+    scope: "Select the SCOPE of this change (optional):",
+    customScope: "Select the SCOPE of this change:",
+    subject: "Write a SHORT, IMPERATIVE tense description of the change:\n",
+    body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
+    breaking: 'List any BREAKING CHANGES (optional). Use "|" to break new line:\n',
+    footerPrefixsSelect: "Select the ISSUES type of the change list by this change (optional):",
+    customFooterPrefixs: "Input ISSUES prefix:",
+    footer: "List any ISSUES by this change. E.g.: #31, #34:\n",
+    confirmCommit: "Are you sure you want to proceed with the commit above?"
+  },
+  types: [
+    { value: "feat", name: "feat:     \u2728  A new feature", emoji: ":sparkles:" },
+    { value: "fix", name: "fix:      \u{1F41B}  A bug fix", emoji: ":bug:" },
+    { value: "docs", name: "docs:     \u{1F4DD}  Documentation only changes", emoji: ":memo:" },
+    { value: "style", name: "style:    \u{1F484}  Changes that do not affect the meaning of the code", emoji: ":lipstick:" },
+    { value: "refactor", name: "refactor: \u267B\uFE0F   A code change that neither fixes a bug nor adds a feature", emoji: ":recycle:" },
+    { value: "perf", name: "perf:     \u26A1\uFE0F  A code change that improves performance", emoji: ":zap:" },
+    { value: "test", name: "test:     \u2705  Adding missing tests or adjusting existing tests", emoji: ":white_check_mark:" },
+    { value: "build", name: "build:    \u{1F4E6}\uFE0F  Changes that affect the build system or external dependencies", emoji: ":package:" },
+    { value: "ci", name: "ci:       \u{1F3A1}  Changes to our CI configuration files and scripts", emoji: ":ferris_wheel:" },
+    { value: "chore", name: "chore:    \u{1F528}  Other changes that don't modify src or test files", emoji: ":hammer:" },
+    { value: "revert", name: "revert:   \u23EA\uFE0F  Reverts a previous commit", emoji: ":rewind:" }
+  ]
+};
+
+const hashing = {
+  driver: "bcrypt",
+  bcrypt: {
+    rounds: 10
+  },
+  argon: {
+    memory: 65536,
+    threads: 1,
+    time: 1
+  }
+};
+
+const library = {
+  name: "hello-world",
+  parentName: "@stacksjs",
+  repository: "stacksjs/stacks",
+  license: "MIT",
+  author: "Chris Breuer",
+  contributors: ["Chris Breuer <chris@ow3.org>"],
+  defaultLanguage: "en",
+  vueComponents: {
+    name: "hello-world-vue",
+    description: "Your Vue component library description",
+    keywords: ["component", "library", "vue", "vite", "typescript", "javascript"],
+    tags: [{
+      name: ["HelloWorld", "AppHelloWorld"],
+      description: "The Hello World custom element, built via this framework.",
+      attributes: [{
+        name: "greeting",
+        description: "The greeting."
+      }]
+    }]
+  },
+  webComponents: {
+    name: "hello-world-elements",
+    description: "Your framework agnostic web component library description.",
+    keywords: ["custom-elements", "web-components", "library", "framework-agnostic", "typescript", "javascript"],
+    tags: [{
+      name: ["HelloWorld", "AppHelloWorld"],
+      description: "The Hello World custom element, built via this framework.",
+      attributes: [{
+        name: "greeting",
+        description: "The greeting."
+      }]
+    }]
+  },
+  functions: {
+    name: "hello-world-fx",
+    description: "Your function library description.",
+    keywords: ["functions", "composables", "library", "typescript", "javascript"],
+    shouldBuildIife: false,
+    shouldGenerateSourcemap: false,
+    functions: [
+      "counter",
+      "dark"
+    ]
+  }
+};
+
+const ui = {
+  shortcuts: [
+    ["btn", "inline-flex items-center px-4 py-2 ml-2 border border-transparent shadow-sm text-base font-medium rounded-md text-white bg-indigo-600 hover:bg-indigo-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-indigo-500 cursor-pointer"]
+  ],
+  safelist: "prose prose-sm m-auto text-left",
+  trigger: ":stx:",
+  classPrefix: "stx-",
+  reset: "tailwind",
+  icons: {
+    "heroicon-outline": () => import('./chunks/icons.mjs').then((i) => i.default),
+    "heroicon-solid": () => import('./chunks/icons2.mjs').then((i) => i.default)
+  }
+};
+
+const cache = {
+  default: env("CACHE_DRIVER", "redis"),
+  redis: {
+    driver: "redis",
+    connection: "cache",
+    host: env("REDIS_HOST", "127.0.0.1"),
+    port: env("REDIS_PORT", "6379")
+  }
+};
+
+export { app, cache, deploy, determineDebugMode, docs$1 as docs, git, hashing, library, services, ui };

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@stacksjs/config",
+  "type": "module",
+  "version": "0.38.3",
+  "packageManager": "pnpm@7.15.0",
+  "description": "The Stacks configuration.",
+  "author": "Chris Breuer",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/chrisbbreuer",
+  "homepage": "https://github.com/stacksjs/stacks/tree/main/.stacks/core/config#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stacksjs/stacks.git",
+    "directory": "./.stacks/core/config"
+  },
+  "bugs": {
+    "url": "https://github.com/stacksjs/stacks/issues"
+  },
+  "keywords": [
+    "configuration",
+    "stacks"
+  ],
+  "main": "dist/index.mjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "contributors": [
+    "Chris Breuer <chris@ow3.org>"
+  ],
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=v18.12.1",
+    "pnpm": ">=7.15.0"
+  },
+  "peerDependencies": {
+    "@stacksjs/utils": "0.38.3"
+  },
+  "devDependencies": {
+    "mkdist": "^0.4.0",
+    "typescript": "^4.8.4",
+    "unbuild": "^0.9.4"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "dev": "unbuild --stub",
+    "typecheck": "tsc --noEmit"
+  }
+}