stacks 0.1.0 → 0.37.4

package/src/cli/build.ts

@@ -0,0 +1,49 @@
+import type { CAC } from 'cac'
+import { startBuildProcess } from './actions/build'
+
+async function build(stacks: CAC) {
+  stacks
+    .command('build', 'Automagically build any of your libraries/packages for production use. Select any of the following packages')
+    .option('-c, --components', 'Build your component library')
+    .option('-w, --web-components', 'Build your framework agnostic web component library') // these are automatically built with your -c option as well
+    .option('-e, --elements', 'An alias to the -w flag')
+    .option('-f, --functions', 'Build your function library')
+    .option('-d, --docs', 'Build your documentation site')
+    .option('--debug', 'Add additional debug logs', { default: false })
+    // .option('-p, --pages', 'Build your pages')
+    .action(async (options: any) => {
+      await startBuildProcess(options)
+    })
+
+  stacks
+    .command('build:components', 'Automagically build your component libraries for production use & npm/CDN distribution.')
+    .action(async () => {
+      await startBuildProcess('components')
+    })
+
+  stacks
+    .command('build:functions', 'Automagically build your function library for production use & npm/CDN distribution.')
+    .action(async () => {
+      await startBuildProcess('functions')
+    })
+
+  stacks
+    .command('build:web-components', 'Automagically build web component library for production use & npm/CDN distribution.')
+    .action(async () => {
+      await startBuildProcess('web-components')
+    })
+
+  stacks
+    .command('build:docs', 'Automagically build your documentation site.')
+    .action(async () => {
+      await startBuildProcess('docs')
+    })
+
+  stacks
+    .command('build:stacks', 'Build the core Stacks framework.')
+    .action(async () => {
+      await startBuildProcess('stacks')
+    })
+}
+
+export { build }

package/src/cli/create.ts

@@ -0,0 +1,71 @@
+import type { CAC } from 'cac'
+import consola from 'consola'
+import * as ezSpawn from '@jsdevtools/ez-spawn'
+import { resolve } from 'pathe'
+import { bold, cyan, dim, link } from 'kolorist'
+import { useOnline } from '@vueuse/core'
+import { isFolder } from '@stacksjs/fs'
+import { ExitCode } from '@stacksjs/types'
+import { version } from '../../package.json'
+import { generate as generateAppKey } from './actions/key'
+
+async function create(stack: CAC) {
+  stack
+    .option('-n, --name <name>', 'Name of the stack')
+    .option('-u, --ui', 'Are you building a UI?', { default: true }) // if no, disregard remainder of questions wrt UI
+    .option('-c, --components', 'Are you building UI components?', { default: true }) // if no, -v and -w would be false
+    .option('-w, --web-components', 'Automagically built optimized custom elements/web components?', { default: true })
+    .option('-v, --vue', 'Automagically built a Vue component library?', { default: true })
+    .option('-p, --pages', 'How about pages?', { default: true }) // pages need an HTTP server
+    .option('-f, --functions', 'Are you developing functions/composables?', { default: true }) // if no, API would be false
+    .option('-a, --api', 'Are you building an API?', { default: true }) // APIs need an HTTP server & assumes functions is true
+    .option('-d, --database', 'Do you need a database?', { default: true })
+    .option('--debug', 'Add additional debug logs', { default: false })
+    // .option('--auth', 'Scaffold an authentication?', { default: true })
+
+  stack
+    .command('')
+    .action(async (args: any) => {
+      const name = stack.args[0] || args.name || '.'
+      const path = resolve(process.cwd(), name)
+
+      console.log()
+      console.log(cyan(bold('Stacks CLI')) + dim(` v${version}`))
+      console.log()
+
+      if (await isFolder(path)) {
+        consola.error(`Path ${path} already exists`)
+        process.exit(ExitCode.FatalError)
+      }
+
+      const online = useOnline()
+      if (!online) {
+        consola.info('It appears you are disconnected from the internet. The Stacks setup requires a brief internet connection for setup.')
+        process.exit(ExitCode.FatalError)
+      }
+
+      consola.info('Setting up your stack.')
+      await ezSpawn.async(`giget stacks ${name}`, { stdio: args.debug ? 'inherit' : 'ignore' }) // todo: stdio should inherit when APP_DEBUG or debug flag is true
+      consola.success(`Successfully scaffolded your project at ${cyan(path)}`)
+
+      consola.info('Ensuring your environment is ready...')
+      // todo: this should check for whether the proper Node version is installed because fnm is not a requirement
+      await ezSpawn.async('fnm use', { stdio: args.debug ? 'inherit' : 'ignore', cwd: path }) // todo: stdio should inherit when APP_DEBUG or debug flag is true
+      consola.success('Environment is ready.')
+
+      consola.info('Installing & setting up Stacks.')
+      await ezSpawn.async('pnpm install', { stdio: args.debug ? 'inherit' : 'ignore', cwd: path }) // todo: stdio should inherit when APP_DEBUG or debug flag is true
+      await ezSpawn.async('cp .env.example .env', { stdio: args.debug ? 'inherit' : 'ignore', cwd: path }) // todo: stdio should inherit when APP_DEBUG or debug flag is true
+      await generateAppKey()
+      await ezSpawn.async('git init', { stdio: args.debug ? 'inherit' : 'ignore', cwd: path }) // todo: stdio should inherit when APP_DEBUG or debug flag is true
+      consola.success('Installed & set-up 🚀')
+
+      console.log()
+      consola.info(bold('Welcome to the Stacks Framework! ⚛️'))
+      console.log(`cd ${link(path, `vscode://file/${path}:1`)} && code .`)
+      console.log()
+      consola.log('To learn more, visit https://stacksjs.dev')
+    })
+}
+
+export { create }

package/src/cli/dev.ts

@@ -0,0 +1,28 @@
+import type { CAC } from 'cac'
+import { startDevelopmentServer } from './actions/dev'
+
+async function dev(stacks: CAC) {
+  stacks
+    .command('dev', 'Start the development server for any of the following packages')
+    .option('-c, --components', 'Start the Components development server')
+    .option('-f, --functions', 'Start the Functions development server')
+    .option('-d, --docs', 'Start the Documentation development server')
+    // .option('-p, --pages', 'Start the Pages development server')
+    .action(async (options: any) => {
+      await startDevelopmentServer(options)
+    })
+
+  stacks
+    .command('dev:components', 'Start the development server for your component library')
+    .action(async () => {
+      await startDevelopmentServer('components')
+    })
+
+  stacks
+    .command('dev:docs', 'Start the development server for your documentation')
+    .action(async () => {
+      await startDevelopmentServer('docs')
+    })
+}
+
+export { dev }

package/src/cli/example.ts

@@ -0,0 +1,28 @@
+import type { CAC } from 'cac'
+import { runExample } from './actions/examples'
+
+async function example(stacks: CAC) {
+  stacks
+    .command('example', 'Test your libraries against your built bundle.')
+    .option('-c, --components', 'Test your Vue component library')
+    .option('-v, --vue', 'Test your Vue component library')
+    .option('-w, --web-components', 'Test your web component library')
+    .action(async (options) => {
+      await runExample(options)
+    })
+
+  stacks
+    .command('example:vue', 'Test your Vue component library.')
+    .alias('example:components')
+    .action(async () => {
+      await runExample('vue')
+    })
+
+  stacks
+    .command('example:web-components', 'Test your Web Component library.')
+    .action(async () => {
+      await runExample('web-components')
+    })
+}
+
+export { example }

package/src/cli/generate.ts

@@ -0,0 +1,64 @@
+import type { CAC } from 'cac'
+import { generateComponentMeta, generateIdeHelpers, generateLibEntries, generateVsCodeCustomData, generateVueCompat, generateWebTypes, startGenerationProcess } from './actions/generate'
+import { generateTypes } from './actions/types'
+
+async function generate(stacks: CAC) {
+  stacks
+    .command('generate', 'Automagically build any of your libraries/packages for production use. Select any of the following packages')
+    .option('-t, --types', 'Generate your TypeScript types')
+    .option('-e, --entries', 'Generate your function & component library entry points')
+    .option('-w, --web-types', 'Generate web-types.json for IDEs')
+    .option('-c, --custom-data', 'Generate VS Code custom data (custom-elements.json) for IDEs')
+    .option('-i, --ide-helpers', 'Generate IDE helpers')
+    .option('-v, --vue-compatibility', 'Generate Vue 2 & 3 compatibility')
+    .option('-c, --component-meta', 'Generate component meta information')
+    .option('--debug', 'Add additional debug logs', { default: false })
+    .action(async (options: any) => {
+      await startGenerationProcess(options)
+    })
+
+  stacks
+    .command('generate:types', 'Generate the types of & for your library/libraries')
+    .action(async () => {
+      await generateTypes()
+    })
+
+  stacks
+    .command('generate:entries', 'Generate the entry points for your libraries')
+    .action(async () => {
+      // run the generate:entries command
+      await generateLibEntries()
+    })
+
+  stacks
+    .command('generate:vue-compatibility', 'Generate Vue 2 & 3 compatibility')
+    .action(async () => {
+      await generateVueCompat()
+    })
+
+  stacks
+    .command('generate:web-types', 'Generate web-types.json for IDEs')
+    .action(async () => {
+      await generateWebTypes()
+    })
+
+  stacks
+    .command('generate:vscode-custom-data', 'Generate VS Code custom data (custom-elements.json) for IDEs')
+    .action(async () => {
+      await generateVsCodeCustomData()
+    })
+
+  stacks
+    .command('generate:ide-helpers', 'Generate IDE helpers')
+    .action(async () => {
+      await generateIdeHelpers()
+    })
+
+  stacks
+    .command('generate:component-meta', 'Generate component meta information')
+    .action(async () => {
+      await generateComponentMeta()
+    })
+}
+
+export { generate }

package/src/cli/index.ts

@@ -0,0 +1,13 @@
+import { build } from './build'
+import { dev } from './dev'
+import { example } from './example'
+import { generate } from './generate'
+import { utility } from './utility'
+import { make } from './make'
+import { test } from './test'
+import { create } from './create'
+import { update } from './update'
+import { types } from './types'
+import { key } from './key'
+
+export { dev, build, utility, make, example, test, create, update, generate, key, types }

package/src/cli/key.ts

@@ -0,0 +1,12 @@
+import type { CAC } from 'cac'
+import { generate as generateAppKey } from './actions/key'
+
+async function key(stacks: CAC) {
+  stacks
+    .command('key:generate', 'Generate & set the application key.')
+    .action(async () => {
+      await generateAppKey()
+    })
+}
+
+export { key }

package/src/cli/make.ts

@@ -0,0 +1,47 @@
+import type { CAC } from 'cac'
+import { component as makeComponent, fx as makeFunction, language as makeLanguage, page as makePage, stack as makeStack } from './actions/make'
+
+async function make(stacks: CAC) {
+  stacks
+    .command('make', 'Test your libraries against your built bundle.')
+    .option('-c, --component', 'Scaffolds a component.')
+    .option('-p, --page', 'Scaffolds a page.')
+    .option('-f, --function', 'Scaffolds a function.')
+    .option('-l, --language', 'Scaffolds a language.')
+    .option('-s, --stack', 'Scaffolds a new stack.')
+    .action(async (options) => {
+      await runMake(stacks.args[0], options)
+    })
+
+  stacks
+    .command('make:component', 'Scaffolds a component.')
+    .action(async () => {
+      await makeComponent(stacks.args[0])
+    })
+
+  stacks
+    .command('make:page', 'Scaffolds a page.')
+    .action(async () => {
+      await makePage(stacks.args[0])
+    })
+
+  stacks
+    .command('make:function', 'Scaffolds a function.')
+    .action(async () => {
+      await makeFunction(stacks.args[0])
+    })
+
+  stacks
+    .command('make:lang', 'Scaffolds a language file.')
+    .action(async () => {
+      await makeLanguage(stacks.args[0])
+    })
+
+  stacks
+    .command('make:stack', 'Scaffolds a new stack.')
+    .action(async () => {
+      await makeStack(stacks.args[0])
+    })
+}
+
+export { make }

package/src/cli/test.ts

@@ -0,0 +1,24 @@
+import type { CAC } from 'cac'
+import { generateTestCoverageReport, runTestSuite, typecheck } from './actions/test'
+
+async function test(stacks: CAC) {
+  stacks
+    .command('test', 'Runs your test suite.')
+    .action(async () => {
+      await runTestSuite()
+    })
+
+  stacks
+    .command('test:types', 'Typechecks your codebase.')
+    .action(async () => {
+      await typecheck()
+    })
+
+  stacks
+    .command('test:coverage', 'Generates a test coverage report.')
+    .action(async () => {
+      await generateTestCoverageReport()
+    })
+}
+
+export { test }

package/src/cli/types.ts

@@ -0,0 +1,18 @@
+import type { CAC } from 'cac'
+import { generateTypes } from './actions/types'
+
+async function types(stacks: CAC) {
+  stacks
+    .command('types:generate', 'Generate the types of & for your library/libraries')
+    .action(async () => {
+      await generateTypes()
+    })
+
+  stacks
+    .command('types:fix', 'Generate the types of & for your library/libraries')
+    .action(async () => {
+      // await fixTypes()
+    })
+}
+
+export { types }

package/src/cli/update.ts

@@ -0,0 +1,17 @@
+import type { CAC } from 'cac'
+import { stacks as updateStacks } from './actions/update'
+
+async function update(stacks: CAC) {
+  stacks
+    .command('update', 'Updates dependencies & framework.')
+    .option('-c, --framework', 'Update the Stacks framework', { default: true })
+    .option('-d, --dependencies', 'Update your dependencies', { default: true })
+    .option('-p, --package-manager', 'Update your package manager, i.e. pnpm', { default: true })
+    .option('-f, --force', 'Overwrite possible local updates with remote framework updates', { default: false })
+    .option('--debug', 'Add additional debug logs', { default: false })
+    .action(async (options: any) => {
+      await updateStacks(options)
+    })
+}
+
+export { update }

package/src/cli/utility.ts

@@ -0,0 +1,39 @@
+import type { CAC } from 'cac'
+import { reinstallNpmDependencies } from './actions/fresh'
+import { lint, lintFix } from './actions/lint'
+import { release } from './actions/release'
+import { commit } from './actions/commit'
+
+async function utility(stacks: CAC) {
+  stacks
+    .command('fresh', 'Reinstalls your npm dependencies.')
+    .action(async () => {
+      await reinstallNpmDependencies()
+    })
+
+  stacks
+    .command('lint', 'Automagically lints your codebase.')
+    .action(async () => {
+      await lint()
+    })
+
+  stacks
+    .command('lint:fix', 'Automagically fixes lint errors.')
+    .action(async () => {
+      await lintFix()
+    })
+
+  stacks
+    .command('release', 'Releases a new version of your libraries/packages.')
+    .action(async () => {
+      await release()
+    })
+
+  stacks
+    .command('commit', 'Commit your stashed changes.')
+    .action(async () => {
+      await commit()
+    })
+}
+
+export { utility }

package/src/cli.ts

@@ -0,0 +1,48 @@
+#!/usr/bin/env node
+import cac from 'cac'
+import { isProjectCreated } from '@stacksjs/helpers'
+import { ExitCode } from '@stacksjs/types'
+import { version } from '../package.json'
+import { build, create, dev, example, generate, key, make, test, update, utility } from './cli/'
+
+const cli = cac('stacks')
+
+// setup global error handlers
+process.on('uncaughtException', errorHandler)
+process.on('unhandledRejection', errorHandler)
+
+async function main() {
+  // before running any commands, check if the project is already initialized
+  await key(cli)
+
+  if (!await isProjectCreated()) {
+    await create(cli)
+  }
+  else {
+    await update(cli)
+    await generate(cli)
+    await dev(cli)
+    await build(cli)
+    await utility(cli)
+    await make(cli)
+    await example(cli)
+    await test(cli)
+  }
+
+  cli.help()
+  cli.version(version)
+
+  cli.parse()
+}
+
+main()
+
+function errorHandler(error: Error): void {
+  let message = error.message || String(error)
+
+  if (process.env.DEBUG || process.env.NODE_ENV === 'development')
+    message = error.stack || message
+
+  console.error(message)
+  process.exit(ExitCode.FatalError)
+}

package/src/docs.ts

@@ -0,0 +1,4 @@
+import { defineConfig } from 'vitepress'
+import docs from 'config/docs'
+
+export default defineConfig(docs)

package/src/index.ts

@@ -0,0 +1,22 @@
+export * from '@stacksjs/ui'
+export * from '@stacksjs/router'
+export * from '@stacksjs/fs'
+export * from '@stacksjs/arrays'
+export * from '@stacksjs/strings'
+export * from '@stacksjs/collections'
+export * from '@stacksjs/paths'
+export * from '@stacksjs/objects'
+export * from '@stacksjs/build'
+export * from '@stacksjs/actions/generate'
+export * from '@stacksjs/types'
+
+// utilities
+export * from '../alias'
+export * from '../config'
+export * from '@stacksjs/helpers'
+export * from '@stacksjs/strings'
+export * from '@stacksjs/objects'
+export * from '@stacksjs/paths'
+export * from '@vueuse/core'
+export * from '@vueuse/head'
+export * from '@vueuse/shared'

package/tsconfig.json

@@ -0,0 +1,96 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "skipLibCheck": true,
+    "strict": true,
+    "jsx": "preserve",
+    "sourceMap": true,
+    "resolveJsonModule": true,
+    "importHelpers": true,
+    "allowSyntheticDefaultImports": true,
+    "allowJs": true,
+    "forceConsistentCasingInFileNames": true,
+    "esModuleInterop": true,
+    "noUnusedLocals": true,
+    "isolatedModules": true,
+    "strictNullChecks": true,
+    "baseUrl": ".",
+    "outDir": "./dist/types",
+    "lib": [
+      "ESNext",
+      "DOM"
+    ],
+    "types": [
+      "vitest",
+      "vite/client",
+      "vue/ref-macros",
+      "vite-plugin-pages/client",
+      "vite-plugin-vue-component-preview/client",
+      "vite-plugin-vue-layouts/client",
+      "vite-plugin-pwa/client"
+    ],
+    "paths": {
+      "~/*": ["../*"],
+      "@stacksjs/actions/*": ["./core/actions/src/*"],
+      "@stacksjs/actions/generate": ["./core/actions/src/generate/index.ts"],
+      "@stacksjs/alias": ["./alias.ts"],
+      "@stacksjs/alias/*": ["./core/alias/src/*"],
+      "@stacksjs/arrays/*": ["./core/arrays/src/*"],
+      "@stacksjs/arrays": ["./core/arrays/src/index.ts"],
+      "@stacksjs/build": ["./core/build/src/index.ts"],
+      "@stacksjs/build/*": ["./core/build/src/*"],
+      "@stacksjs/cli": ["./src/cli.ts"],
+      "@stacksjs/cli/*": ["./src/cli/*"],
+      "@stacksjs/collections": ["./core/collections/src/index.ts"],
+      "@stacksjs/collections/*": ["./core/collections/src/*"],
+      "@stacksjs/config": ["./config.ts"],
+      "@stacksjs/config/*": ["../config/*"],
+      "@stacksjs/fs": ["./core/fs/src/index.ts"],
+      "@stacksjs/fs/*": ["./core/fs/src/*"],
+      "@stacksjs/helpers": ["./core/helpers/src/index.ts"],
+      "@stacksjs/helpers/*": ["./core/helpers/src/*"],
+      "@stacksjs/modules/*": ["./core/modules/src/*"],
+      "@stacksjs/objects": ["./core/objects/src/index.ts"],
+      "@stacksjs/objects/*": ["./core/objects/src/*"],
+      "@stacksjs/paths": ["./core/paths/src/index.ts"],
+      "@stacksjs/paths/*": ["./core/paths/src/*"],
+      "@stacksjs/router": ["./core/router/src/index.ts"],
+      "@stacksjs/router/*": ["./core/router/src/*"],
+      "@stacksjs/security": ["./core/security/src/index.ts"],
+      "@stacksjs/security/*": ["./core/security/src/*"],
+      "@stacksjs/strings": ["./core/strings/src/index.ts"],
+      "@stacksjs/strings/*": ["./core/strings/src/*"],
+      "@stacksjs/types": ["./core/types/src/index.ts"],
+      "@stacksjs/types/*": ["./core/types/src/*"],
+      "@stacksjs/ui": ["./core/ui/src/index.ts"],
+      "@stacksjs/ui/*": ["./core/ui/src/*"],
+      "@stacksjs/utils": ["./core/utils/src/index.ts"],
+      "@stacksjs/utils/*": ["./core/utils/src/*"],
+      "stacks": ["./src/index.ts"],
+      "stacks/*": ["./src/*"],
+      "framework/*": ["./*"],
+      "functions/*": ["../functions/*"],
+      "config/*": ["../config/*"],
+      "components/*": ["../components/*"],
+      "pages/*": ["../pages/*"]
+    }
+  },
+  "include": [
+    "./**.d.ts",
+    "./**/*",
+    "../components/**/*",
+    "../functions/**/*",
+    "../pages/**/*"
+  ],
+  "exclude": [
+    "./nitro.config.ts",
+    "./vitest.config.ts",
+    "./examples/**",
+    "../commitlint.config.cjs",
+    "../**/README.md",
+    "../**/dist/**",
+    "../**/node_modules/**"
+  ]
+}

package/vitest.config.ts

@@ -0,0 +1,22 @@
+import { defineConfig } from 'vitest/config'
+import alias from './core/alias'
+
+export default defineConfig({
+  root: '..',
+
+  optimizeDeps: {
+    entries: [],
+  },
+
+  resolve: {
+    alias,
+  },
+
+  test: {
+    globals: true,
+    coverage: {
+      provider: 'istanbul',
+      exclude: ['.stacks'],
+    },
+  },
+})

package/vue-components/index.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" href=".github/art/logo.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Stacks Playground</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="./main.ts"></script>
+  </body>
+</html>

package/vue-components/main.ts

@@ -0,0 +1,18 @@
+import { createApp } from 'vue'
+// import Previewer from 'virtual:vue-component-preview'
+import Demo from '../../components/Demo.vue'
+
+// prepare the messages object from the yaml language files
+// const messages = Object.fromEntries(
+//   Object.entries(
+//     import.meta.glob<{ default: any }>('../../../lang/*.y(a)?ml', { eager: true }))
+//     .map(([key, value]) => {
+//       const yaml = key.endsWith('.yaml')
+//       return [key.slice(14, yaml ? -5 : -4), value.default]
+//     }),
+// )
+
+const app = createApp(Demo)
+
+// app.use(Previewer)
+app.mount('#app')