stacks 0.40.0 → 0.44.9

package/core/types/src/app.ts

@@ -0,0 +1,140 @@
+/**
+ * **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.
+ */
+export interface AppOptions {
+  /**
+   * **Application Name**
+   *
+   * This value is the name of your application. This value is used when the
+   * framework needs to place the application's name in a log or any
+   * other location as required by the application or its packages.
+   *
+   * @default string "Stacks"
+   */
+  name: string
+
+  /**
+   * **Application Environment**
+   *
+   * This value determines the "environment" your application is currently
+   * running in. This may determine how you prefer to configure various
+   * services the application utilizes. Set this in your ".env" file
+   *
+   * @default "local"
+   */
+  env?: 'local' | 'development' | 'production'
+
+  /**
+   * **Application URL**
+   *
+   * This URL is used by the console to properly generate URLs when using
+   * the Artisan command line tool. You should set this to the root of
+   * your application so that it is used when running Artisan tasks.
+   *
+   * @default string "https://localhost"
+   * @example
+   * https://hello-world.test
+   */
+  url?: string
+
+  /**
+   * **Application Debug Mode**
+   *
+   * When your application is in debug mode, detailed error messages with
+   * stack traces will be shown on every error that occurs within your
+   * application. If disabled, a simple generic error page is shown.
+   *
+   * @default true
+   */
+  debug: boolean
+
+  /**
+   * **Application Port**
+   *
+   * This port is used when Stacks creates a server you. You should set
+   * a port that's not already in use by your machine. Stacks defaults
+   * to a memorable port that likely is free on your end: 3333.
+   *
+   * @default number 3333
+   */
+  port: number
+
+  /**
+   * **Encryption Key**
+   *
+   * This key is used by the Stacks encrypter service and should be set to
+   * a random, 32 character string, otherwise these encrypted strings will
+   * not be safe. Please do this before deploying an application!
+   */
+  key?: string
+
+  /**
+   * **Application Timezone**
+   *
+   * Here you may specify the default timezone for your application, which
+   * will be used by Stacks and date-time functions. We have gone ahead
+   * and set this to a sensible default for you out of the box.
+   *
+   * @default string "UTC"
+   */
+  timezone?: string
+
+  /**
+   * **Application Locale Configuration**
+   *
+   * The application locale determines the default locale that will be used
+   * by the translation service provider. You are free to set this value
+   * to any of the locales which will be supported by the application.
+   *
+   * @default string "en"
+   * @example
+   * de // ./lang/de.yml needs to be present for this
+   */
+  locale?: string
+
+  /**
+   * **Application Fallback Locale**
+   *
+   * The fallback locale determines the locale to use when the current one
+   * is not available. You may change the value to correspond to any of
+   * the language folders that are provided through your application.
+   *
+   * @default string "en"
+   */
+  fallbackLocale: 'en'
+
+  /**
+   * **Integrated Development Environment**
+   *
+   * Currently, only VS Code is fully supported. While you may use Stacks with
+   * any editor, some of its tooling is VS Code specific. Hence, for the
+   * best experience, VS Code is currently the recommended editor.
+   *
+   * @default string "vscode"
+   */
+  editor: string
+
+  /**
+   * **Cipher**
+   *
+   * Description WIP.
+   *
+   * @default string "aes-256-cbc"
+   */
+  cipher: string
+
+  // inspect: <InspectOptions>{},
+
+  /**
+   * **Font**
+   *
+   * Description WIP.
+   *
+   * @default object
+   */
+  font: object
+}

package/core/types/src/auto-imports.ts

@@ -0,0 +1,3 @@
+import type { Options } from 'unplugin-auto-import/types'
+
+export type AutoImportsOptions = Options

package/core/types/src/build.ts

@@ -0,0 +1,2 @@
+export type { UserConfig as ViteConfig } from 'vite'
+export { type ViteSSGContext } from 'vite-ssg'

package/core/types/src/cli.ts

@@ -0,0 +1,198 @@
+/**
+ * The parsed command-line arguments
+ */
+
+import type { Ora } from 'ora'
+
+export interface StacksOptions {
+  componentsSrcPath?: string
+  dtsPath?: string
+  extensions?: string[]
+}
+
+export interface OutroOptions {
+  startTime?: number
+  useSeconds?: boolean
+  isError?: boolean
+}
+
+export interface IntroOptions {
+  /**
+   * @default true
+   */
+  showPerformance?: boolean
+}
+
+type SpinnerOptions = Ora
+
+/**
+ * The options to pass to the CLI.
+ */
+export interface CliOptions {
+  /**
+   * **CLI Debug Level**
+   *
+   * When your application is in debug mode, a different level of information,
+   * like stack traces, will be shown on every error that occurs within the
+   * application. When disabled, it defaults to the "normal experience."
+   *
+   * @default false
+   */
+  debug?: boolean
+
+  /**
+   * **Current Work Directory**
+   *
+   * Based on the `cwd` value, that's where the command...
+   *
+   * @default projectPath()
+   */
+  cwd?: string
+
+  /**
+   * **Loading Animation**
+   *
+   * Should the command show a loading animation?
+   * Please note, when debug mode is enabled,
+   * the animation will not show.
+   *
+   * @default true
+   */
+  shouldBeAnimated?: boolean | SpinnerOptions
+}
+
+export type { Ora as SpinnerOptions } from 'ora'
+
+export type ActionsOption = 'types'
+export type ActionsOptions = {
+  [key in ActionsOption]?: boolean;
+} & CliOptions
+
+export type BuildOption = 'components' | 'vueComponents' | 'webComponents' | 'elements' | 'functions' | 'docs' | 'pages' | 'stacks' | 'all'
+export type BuildOptions = {
+  [key in BuildOption]: boolean;
+} & CliOptions
+
+export type AddOption = 'table' | 'calendar' | 'all'
+export type AddOptions = {
+  [key in AddOption]?: boolean;
+} & CliOptions
+
+export type CreateStringOption = 'name'
+export type CreateBooleanOption = 'ui' | 'components' | 'web-components' | 'vue' | 'pages' | 'functions' | 'api' | 'database'
+export type CreateOptions = {
+  [key in CreateBooleanOption]: boolean
+} & {
+  [key in CreateStringOption]: string
+} & CliOptions
+
+export type DevOption = 'components' | 'docs' | 'pages' | 'functions' | 'desktop' | 'all'
+export type DevOptions = {
+  [key in DevOption]: boolean;
+} & CliOptions
+
+export type GeneratorOption = 'types' | 'entries' | 'webTypes' | 'customData' | 'ideHelpers' | 'vueCompatibility' | 'componentMeta'
+export type GeneratorOptions = {
+  [key in GeneratorOption]?: boolean;
+} & CliOptions
+
+export type LintOption = 'fix'
+export type LintOptions = {
+  [key in LintOption]: boolean;
+} & CliOptions
+
+export type MakeStringOption = 'name'
+export type MakeBooleanOption = 'component' | 'page' | 'function' | 'language' | 'database' | 'migration' | 'factory' | 'notification' | 'stack'
+export type MakeOptions = {
+  [key in MakeBooleanOption]: boolean
+} & {
+  [key in MakeStringOption]: string
+} & CliOptions
+
+export type UpdateString = 'version'
+export type UpdateBoolean = 'framework' | 'dependencies' | 'packageManager' | 'node' | 'all' | 'force'
+export type UpdateOptions = {
+  [key in UpdateString]: string;
+} & {
+  [key in UpdateBoolean]: boolean;
+} & CliOptions
+
+export type ExamplesString = 'version'
+export type ExamplesBoolean = 'components' | 'vue' | 'webComponents' | 'elements' | 'all' | 'force'
+export type ExamplesOption = ExamplesString & ExamplesBoolean | void
+export type ExamplesOptions = {
+  [key in ExamplesString]: string;
+} & {
+  [key in ExamplesBoolean]: boolean;
+} & CliOptions
+
+export interface TestOptions extends CliOptions {}
+export interface CleanOptions extends CliOptions {}
+export interface CommitOptions extends CliOptions {}
+export interface KeyOptions extends CliOptions {}
+export interface FreshOptions extends CliOptions {}
+export interface ReleaseOptions extends CliOptions {}
+export interface PreinstallOptions extends CliOptions {}
+export interface PrepublishOptions extends CliOptions {}
+export interface TypesOptions extends CliOptions {}
+
+export type LibEntryType = 'vue-components' | 'web-components' | 'functions' | 'all'
+
+/**
+ * The available npm scripts within the Stacks toolkit.
+ */
+export const enum NpmScript {
+  Build = 'build',
+  BuildComponents = 'build:components',
+  BuildWebComponents = 'build:web-components',
+  BuildFunctions = 'build:functions',
+  BuildDocs = 'build:docs',
+  BuildStacks = 'build:stacks',
+  Clean = 'rimraf ./pnpm-lock.yaml ./node_modules/ ./.stacks/**/node_modules',
+  Dev = 'dev',
+  DevComponents = 'dev:components',
+  DevDocs = 'dev:docs',
+  DevDesktop = 'dev:desktop',
+  DevPages = 'dev:pages',
+  DevFunctions = 'dev:functions',
+  Fresh = 'fresh',
+  Update = 'update',
+  UpdateDependencies = 'pnpm update',
+  UpdateFramework = 'update:framework',
+  UpdatePackageManager = 'update:package-manager',
+  UpdateNode = 'pnpm env use',
+  Lint = 'eslint .',
+  LintFix = 'lint:fix',
+  MakeStack = 'make:stack',
+  Test = 'vitest --config .stacks/vitest.config.ts',
+  TestUi = 'vitest --config .stacks/vitest.config.ts --ui',
+  TestCoverage = 'vitest --config .stacks/vitest.config.ts --coverage',
+  TestTypes = 'vue-tsc --noEmit',
+  Generate = 'generate',
+  GenerateTypes = 'generate:types',
+  GenerateEntries = 'generate:entries',
+  GenerateVueCompat = 'generate:vue-compatibility',
+  GenerateWebTypes = 'generate:web-types',
+  GenerateVsCodeCustomData = 'generate:vscode-custom-data',
+  GenerateIdeHelpers = 'generate:ide-helpers',
+  GenerateComponentMeta = 'generate:component-meta',
+  Release = 'release',
+  Commit = 'commit',
+  Example = 'example',
+  ExampleVue = 'example:vue',
+  ExampleWebComponents = 'example:web-components',
+  KeyGenerate = 'key:generate',
+  TypesFix = 'types:fix',
+  TypesGenerate = 'types:generate',
+  Preinstall = 'preinstall',
+  Prepublish = 'prepublish',
+  Wip = 'wip',
+}
+
+export const enum Action {
+  Release = 'release',
+  Prepublish = 'prepublish',
+}
+
+export type { CAC as CLI } from 'cac'
+export type { ExecaReturnValue as CommandResult } from 'execa'

package/core/types/src/components.ts

@@ -0,0 +1,66 @@
+import type { Options } from 'unplugin-vue-components'
+
+export interface TagOption {
+  /**
+   * **Tag Name**
+   *
+   * This is the name of the component to be included in your library build.
+   * When defining a tag, ensure that the name corresponds to a file within
+   * root component directory.
+   *
+   * @example
+   * {
+   *   tags: [{
+   *     name: 'HelloWorld' // results in `<HelloWorld />`
+   *   }]
+   * }
+   *
+   * @example
+   * {
+   *   tags: [{
+   *     name: ['HelloWorld', 'AppHelloWorld'] // results in `<AppHelloWorld />`
+   *   }]
+   * }
+   * @see https://stacksjs.dev/docs/components
+   */
+  name: string | string[]
+
+  /**
+   * **Tag Description**
+   *
+   * This is the description of your component. This value is
+   * used when to provide additional information to IDEs.
+   *
+   * @example
+   * {
+   *   name: 'HelloWorld' // results in `<HelloWorld />`
+   * }
+   * @see https://stacksjs.dev/docs/components
+   */
+  description?: string
+
+  /**
+   * **Tag Attributes**
+   *
+   * These are your component's attributes. While it's an optional field, you should aim
+   * to define all of your component attributes here, to provide as much context
+   * to your IDEs as possible, when actually using the library as an end-user.
+   *
+   * @example
+   * {
+   *   attributes: {
+   *     name: 'greeting',
+   *     description: 'The way to greet the user.',
+   *   }
+   * }
+   * @see https://stacksjs.dev/docs/components
+   */
+  attributes?: {
+    name: string
+    description: string
+  }[]
+}
+
+export type TagsOptions = TagOption[]
+
+export type ComponentOptions = Options

package/core/types/src/database.ts

@@ -0,0 +1,3 @@
+import type { PrismaClient } from '@prisma/client'
+
+export type DatabaseClient = PrismaClient

package/core/types/src/debug.ts

@@ -0,0 +1,6 @@
+export interface DebugOptions {
+  driver: string
+  enabled: boolean
+  host: string
+  port: number
+}

package/core/types/src/deploy.ts

@@ -0,0 +1,11 @@
+export interface DeployOptions {
+  /**
+   * **Deployment Host**
+   *
+   * The host to deploy to.
+   *
+   * @default string 'netlify'
+   * @see https://stacksjs.dev/docs/components
+   */
+  host: 'netlify' | 'vercel'
+}

package/core/types/src/docs.ts

@@ -0,0 +1,3 @@
+import type { UserConfig } from 'vitepress'
+
+export type DocsConfig = UserConfig

package/core/types/src/errors.ts

@@ -0,0 +1,6 @@
+export {
+  Err,
+  Ok,
+  Result,
+  ResultAsync,
+} from 'neverthrow'

package/core/types/src/exit-code.ts

@@ -0,0 +1,10 @@
+/**
+ * CLI exit codes.
+ *
+ * @see https://nodejs.org/api/process.html#process_exit_codes
+ */
+export enum ExitCode {
+  Success = 0,
+  FatalError = 1,
+  InvalidArgument = 9,
+}

package/core/types/src/fs.ts

@@ -0,0 +1,17 @@
+/**
+ * Describes a plain-text file.
+ */
+export interface TextFile {
+  path: string
+  data: string
+}
+
+/**
+ * Describes a JSON file.
+ */
+export interface JsonFile {
+  path: string
+  data: unknown
+  indent: string
+  newline: string | undefined
+}

package/core/types/src/git.ts

@@ -0,0 +1,131 @@
+/**
+ * **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.
+ */
+export interface GitOptions {
+  /**
+   * **Git Hooks**
+   *
+   * The git hooks to use.
+   *
+   * @see https://git-scm.com/docs/githooks
+   * @example
+   * ```ts
+   * git: {
+   *   hooks: {
+   *    'pre-commit': 'lint-staged',
+   *   }
+   * }
+   * ```
+   */
+  hooks: GitHooks
+
+  /**
+   * **Git Commit Scopes**
+   *
+   * The git commit scopes to use.
+   *
+   * @see https://stacksjs.dev/docs/git/scopes
+   * @example
+   * git: [
+   *   scopes: [
+   *     '', 'ci', 'deps', 'dx', 'release', 'readme', 'test', 'actions', 'build', 'cli',
+   *     'config', 'examples', 'functions', 'modules', 'pages', 'router', 'scripts',
+   *     'ui', 'utils', 'arrays', 'collections', 'fs', 'objects', 'strings',
+   *   ]
+   * ]
+   */
+  scopes: string[]
+
+  /**
+   * **Git Commit Types**
+   *
+   * The git commit types to use.
+   *
+   * @default array
+   * @see https://stacksjs.dev/docs/git/types
+   * @see https://www.conventionalcommits.org/en/v1.0.0/
+   * @example
+   * ```ts
+   * git: [
+   *   types: [
+   *     'build', 'chore', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'style', 'test',
+   *    ]
+   * ]
+   * ```
+   */
+  types: {
+    value: string
+    name: string
+    emoji: string
+  }[]
+
+  /**
+   * **Messages—Options**
+   *
+   * The git messages/prompts to use.
+   *
+   * @default object
+   * @example
+   * ```ts
+   * messages: {
+   *   type: 'Select the type of change that you\'re committing:',
+   *   scope: 'Denote 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):\n',
+   *   footer: 'List any ISSUES CLOSED by this change (optional). E.g.: #31, #34:\n',
+   *   confirmCommit: 'Are you sure you want to proceed with the commit above?',
+   * }
+   * ```
+   * @see https://stacksjs.dev/docs/git/messages
+   */
+  messages: {
+    type: string
+    scope: string
+    customScope: string
+    subject: string
+    body: string
+    breaking: string
+    footerPrefixesSelect: string
+    customFooterPrefixes: string
+    footer: string
+    confirmCommit: string
+  }
+}
+
+interface Hooks {
+  'applypatch-msg'?: string
+  'pre-applypatch'?: string
+  'post-applypatch'?: string
+  'pre-commit'?: string
+  'pre-merge-commit'?: string
+  'prepare-commit-msg'?: string
+  'commit-msg'?: string
+  'post-commit'?: string
+  'pre-rebase'?: string
+  'post-checkout'?: string
+  'post-merge'?: string
+  'pre-push'?: string
+  'pre-receive'?: string
+  'update'?: string
+  'proc-receive'?: string
+  'post-receive'?: string
+  'post-update'?: string
+  'reference-transaction'?: string
+  'push-to-checkout'?: string
+  'pre-auto-gc'?: string
+  'post-rewrite'?: string
+  'sendemail-validate'?: string
+  'fsmonitor-watchman'?: string
+  'p4-changelist'?: string
+  'p4-prepare-changelist'?: string
+  'p4-post-changelist'?: string
+  'p4-pre-submit'?: string
+  'post-index-change'?: string
+}
+
+export interface GitHooks extends Hooks {}