stacks 0.0.9 → 0.37.3

package/bin/stacks.mjs

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+'use strict'
+
+import '../dist/cli.mjs'

package/components.d.ts

@@ -0,0 +1,22 @@
+// generated by unplugin-vue-components
+// We suggest you to commit this file into source control
+// Read more: https://github.com/vuejs/core/pull/3399
+import '@vue/runtime-core'
+
+export {}
+
+declare module '@vue/runtime-core' {
+  export interface GlobalComponents {
+    404: typeof import('./../pages/layouts/404.vue')['default']
+    Counter: typeof import('./../components/Buttons/Counter.vue')['default']
+    Default: typeof import('./../pages/layouts/default.vue')['default']
+    Demo: typeof import('./../components/Demo.vue')['default']
+    HelloWorld: typeof import('./../components/HelloWorld.vue')['default']
+    Home: typeof import('./../pages/layouts/home.vue')['default']
+    Logo: typeof import('./../components/Logo.vue')['default']
+    README: typeof import('./../components/README.md')['default']
+    RouterLink: typeof import('vue-router')['RouterLink']
+    RouterView: typeof import('vue-router')['RouterView']
+    ToggleDark: typeof import('./../components/Buttons/ToggleDark.vue')['default']
+  }
+}

package/core/actions/README.md

@@ -0,0 +1,59 @@
+# Stacks Actions
+
+This package contains the Stacks Actions.
+
+## ☘️ Features
+
+wip
+
+- ⚡️
+
+wip
+
+## 🤖 Usage
+
+wip
+
+```bash
+pnpm i -D @stacksjs/actions
+```
+
+Now, you can use it in your project:
+
+```js
+import * as invoke from '@stacksjs/actions/generate'
+
+// wip
+```
+
+Learn more in the docs.
+
+## 🧪 Testing
+
+```bash
+pnpm test
+```
+
+## 📈 Changelog
+
+Please see our [releases](https://github.com/stacksjs/stacksjs/releases) page for more information on what has changed recently.
+
+## 💪🏼 Contributing
+
+Please see [CONTRIBUTING](../../.github/CONTRIBUTING.md) for details.
+
+## 🏝 Community
+
+For help, discussion about best practices, or any other conversation that would benefit from being searchable:
+
+[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)
+
+For casual chit-chat with others using this package:
+
+[Join the Open Web Discord Server](https://discord.ow3.org)
+
+## 📄 License
+
+The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.
+
+Made with ❤️

package/core/actions/node_modules/.bin/markdown-it

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/Users/chrisbreuer/Code/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/Users/chrisbreuer/Code/stacks/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../node_modules/.pnpm/markdown-it@13.0.1/node_modules/markdown-it/bin/markdown-it.js" "$@"
+else
+  exec node  "$basedir/../../../../../node_modules/.pnpm/markdown-it@13.0.1/node_modules/markdown-it/bin/markdown-it.js" "$@"
+fi

package/core/actions/node_modules/.bin/mkdist

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/Users/chrisbreuer/Code/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/Users/chrisbreuer/Code/stacks/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../node_modules/.pnpm/mkdist@0.3.13_typescript@4.8.4/node_modules/mkdist/dist/cli.cjs" "$@"
+else
+  exec node  "$basedir/../../../../../node_modules/.pnpm/mkdist@0.3.13_typescript@4.8.4/node_modules/mkdist/dist/cli.cjs" "$@"
+fi

package/core/actions/node_modules/.bin/tsc

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/Users/chrisbreuer/Code/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/Users/chrisbreuer/Code/stacks/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../node_modules/.pnpm/typescript@4.8.4/node_modules/typescript/bin/tsc" "$@"
+else
+  exec node  "$basedir/../../../../../node_modules/.pnpm/typescript@4.8.4/node_modules/typescript/bin/tsc" "$@"
+fi

package/core/actions/node_modules/.bin/tsserver

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/Users/chrisbreuer/Code/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/Users/chrisbreuer/Code/stacks/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../node_modules/.pnpm/typescript@4.8.4/node_modules/typescript/bin/tsserver" "$@"
+else
+  exec node  "$basedir/../../../../../node_modules/.pnpm/typescript@4.8.4/node_modules/typescript/bin/tsserver" "$@"
+fi

package/core/actions/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@stacksjs/actions",
+  "type": "module",
+  "version": "0.37.3",
+  "packageManager": "pnpm@7.13.6",
+  "description": "The Stacks actions.",
+  "author": "Chris Breuer",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/chrisbbreuer",
+  "homepage": "https://github.com/stacksjs/stacks/tree/main/.stacks/core/actions#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stacksjs/stacks.git",
+    "directory": "./.stacks/core/actions"
+  },
+  "bugs": {
+    "url": "https://github.com/stacksjs/stacks/issues"
+  },
+  "keywords": [
+    "actions",
+    "stacks",
+    "framework",
+    "typescript",
+    "javascript",
+    "vite",
+    "nitro",
+    "vue",
+    "components",
+    "library"
+  ],
+  "contributors": [
+    "Chris Breuer <chris@ow3.org>"
+  ],
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=v18.10.0",
+    "pnpm": ">=7.13.6"
+  },
+  "scripts": {
+    "build": "mkdist -d",
+    "dev": "mkdist -d",
+    "prepublishOnly": "pnpm run build",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@stacksjs/fs": "workspace:*",
+    "@stacksjs/helpers": "workspace:*",
+    "@stacksjs/paths": "workspace:*",
+    "@stacksjs/strings": "workspace:*",
+    "@stacksjs/types": "workspace:*",
+    "@types/fs-extra": "^9.0.13",
+    "@vueuse/core": "^9.3.1",
+    "consola": "^2.15.3",
+    "fast-glob": "^3.2.12",
+    "fs-extra": "^10.1.0",
+    "markdown-it": "^13.0.1",
+    "vue-component-meta": "^1.0.8"
+  },
+  "devDependencies": {
+    "mkdist": "^0.3.13"
+  }
+}

package/core/actions/src/copy-types.ts

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+
+/**
+ * This action copies all the generated types.
+ */
+
+import { frameworkPath } from '@stacksjs/paths'
+import { copyFolder } from '@stacksjs/fs'
+
+// relative to scripts directory
+const destinations = [
+  [frameworkPath('dist/types/components'), frameworkPath('vue-components/dist/types')],
+  [frameworkPath('dist/types/components'), frameworkPath('web-components/dist/types')],
+  [frameworkPath('dist/types/functions'), frameworkPath('functions/dist/types')],
+]
+
+destinations.forEach(([src, dest]) => {
+  // const srcPath = resolve(__filename, '..', src)
+  // const destPath = resolve(__filename, '..', dest)
+
+  copyFolder(src, dest)
+})

package/core/actions/src/generate/component-meta.ts

@@ -0,0 +1,94 @@
+import { existsSync, mkdirSync, writeFileSync } from 'node:fs'
+import fg from 'fast-glob'
+import MarkdownIt from 'markdown-it'
+import { type ComponentMeta, type MetaCheckerOptions, createComponentMetaChecker } from 'vue-component-meta'
+import { frameworkPath, join, parse, projectPath } from '@stacksjs/paths'
+
+const md = new MarkdownIt()
+
+/**
+ * ℹ️ Useful links
+ *
+ * vue-component-meta tests: https://github.com/johnsoncodehk/volar/blob/master/vue-language-tools/vue-component-meta/tests/index.spec.ts
+ * Discord thread about improving vue-component-meta: https://discord.com/channels/793943652350427136/1027819645677350912
+ * GitHub issue for improving vue-component-meta based on runtime/dynamic props: https://github.com/johnsoncodehk/volar/issues/1854
+ * Discord chat: https://discord.com/channels/793943652350427136/1027819645677350912
+ * original script: https://raw.githubusercontent.com/jd-solanki/anu/main/scripts/gen-component-meta.ts
+ */
+
+export interface ComponentApiProps {
+  name: ComponentMeta['props'][number]['name']
+  description: ComponentMeta['props'][number]['description']
+
+  // required: ComponentMeta['props'][number]['required']
+  type: ComponentMeta['props'][number]['type']
+  default: ComponentMeta['props'][number]['default']
+}
+
+export interface ComponentApi {
+  props: ComponentApiProps[]
+  events: ComponentMeta['events']
+  slots: ComponentMeta['slots']
+}
+
+export async function generateComponentMeta() {
+  const checkerOptions: MetaCheckerOptions = {
+    forceUseTs: true,
+    schema: { ignore: ['MyIgnoredNestedProps'] },
+    printer: { newLine: 1 },
+  }
+
+  const tsconfigChecker = createComponentMetaChecker(
+    projectPath('tsconfig.json'),
+    checkerOptions,
+  )
+
+  const filterMeta = (meta: ComponentMeta): ComponentApi => {
+  // const clonedMeta: ComponentMeta = JSON.parse(JSON.stringify(meta))
+
+    // Exclude global props
+    const props: ComponentApiProps[] = []
+    meta.props.forEach((prop: any) => {
+      if (prop.global)
+        return
+
+      const { name, description, required, type, default: defaultValue } = prop
+
+      props.push({
+        name: `${name}${required ? '' : '?'}`,
+        description: md.render(description),
+
+        // required,
+
+        type,
+        default: defaultValue || 'unknown',
+      })
+    })
+
+    return {
+      props,
+      events: meta.events,
+      slots: meta.slots,
+    }
+  }
+
+  const components = fg.sync(['components/*.vue', 'components/**/*.vue'], {
+    cwd: projectPath(),
+    absolute: true,
+  })
+
+  components.forEach((componentPath) => {
+    // Thanks: https://futurestud.io/tutorials/node-js-get-a-file-name-with-or-without-extension
+    const componentExportName = parse(componentPath).name
+    const meta = filterMeta(tsconfigChecker.getComponentMeta(componentPath, componentExportName))
+
+    const metaDirPath = frameworkPath('component-meta')
+
+    // if meta dir doesn't exist create
+    if (!existsSync(metaDirPath))
+      mkdirSync(metaDirPath)
+
+    const metaJsonFilePath = join(metaDirPath, `${componentExportName}.json`)
+    writeFileSync(metaJsonFilePath, JSON.stringify(meta, null, 4))
+  })
+}

package/core/actions/src/generate/index.ts

@@ -0,0 +1,4 @@
+export * from './lib-entries'
+export * from './package-json'
+export * from './vue-compat'
+export * from './vscode-custom-data'

package/core/actions/src/generate/lib-entries.ts

@@ -0,0 +1,106 @@
+import consola from 'consola'
+import { kebabCase } from '@stacksjs/strings'
+import { libraryEntryPath } from '@stacksjs/paths'
+import { writeTextFile } from '@stacksjs/fs'
+import { determineResetPreset } from '@stacksjs/helpers'
+import { ExitCode } from '@stacksjs/types'
+import { library } from '../../../../config'
+
+/**
+ * Based on the config values, this method
+ * will generate the library entry points.
+ *
+ * @param type string
+ */
+export async function generateLibEntry(type: 'vue-components' | 'web-components' | 'functions') {
+  if (type === 'vue-components')
+    consola.info('Creating the Vue component library entry point...')
+  else if (type === 'web-components')
+    consola.info('Creating the Web Component library entry point...')
+  else
+    consola.info('Creating the function library entry point...')
+
+  try {
+    await writeTextFile({
+      path: libraryEntryPath(type),
+      data: generateEntryPointData(type),
+    })
+
+    if (type === 'vue-components')
+      consola.success('Created the Vue component library entry point.')
+    else if (type === 'web-components')
+      consola.success('Created the Web Component library entry point.')
+    else
+      consola.success('Created the function library entry point.')
+  }
+  catch (err) {
+    consola.error(err)
+  }
+}
+
+function generateEntryPointData(type: 'vue-components' | 'web-components' | 'functions'): string {
+  let arr = []
+
+  if (type === 'functions') {
+    if (!library.functions.functions) {
+      consola.error('There are no functions defined to be built. Please check your config/library.ts file for potential adjustments.')
+      process.exit(ExitCode.FatalError)
+    }
+
+    for (const fx of library.functions.functions) {
+      if (Array.isArray(fx))
+        arr.push(`export * as ${fx[1]} from '../../../functions/${fx[0]}'`)
+      else
+        arr.push(`export * from '../../../functions/${fx}'`)
+    }
+
+    // join the array into a string with each element being on a new line
+    return arr.join('\r\n')
+  }
+
+  if (type === 'vue-components') {
+    if (!library.vueComponents.tags) {
+      consola.error('There are no components defined to be built. Please check your config/library.ts file for potential adjustments.')
+      process.exit(ExitCode.FatalError)
+    }
+
+    arr = determineResetPreset()
+
+    for (const component of library.vueComponents.tags.map(tag => tag.name)) {
+      if (Array.isArray(component))
+        arr.push(`export { default as ${component[1]} } from '../../../components/${component[0]}.vue'`)
+      else
+        arr.push(`export { default as ${component} } from '../../../components/${component}.vue'`)
+    }
+
+    // join the array into a string with each element being on a new line
+    return arr.join('\r\n')
+  }
+
+  // at this point, we know it is a Web Component we are building
+  arr = determineResetPreset()
+  const imports = [...arr, 'import { defineCustomElement } from \'vue\'']
+  const declarations = []
+  const definitions = []
+
+  if (!library.webComponents.tags) {
+    consola.error('There are no components defined to be built. Please check your config/library.ts file for potential adjustments.')
+    process.exit(ExitCode.FatalError)
+  }
+
+  for (const component of library.webComponents.tags.map(tag => tag.name)) {
+    if (Array.isArray(component)) {
+      imports.push(`import ${component[1]} from '../../../components/${component[0]}.vue'`)
+      declarations.push(`const ${component[1]}CustomElement = defineCustomElement(${component[1]})`)
+      definitions.push(`customElements.define('${kebabCase(component[1])}', ${component[1]}CustomElement)`)
+    }
+    else {
+      imports.push(`import ${component} from '../../../components/${component}.vue'`)
+      declarations.push(`const ${component}CustomElement = defineCustomElement(${component})`)
+      definitions.push(`customElements.define('${kebabCase(component)}', ${component}CustomElement)`)
+    }
+  }
+
+  // join the array into a string with each element being on a new line
+  return [...imports, ...declarations, ...definitions].join('\r\n')
+}

package/core/actions/src/generate/package-json.ts

@@ -0,0 +1,87 @@
+import consola from 'consola'
+import { writeTextFile } from '@stacksjs/fs'
+import { packageJsonPath } from '@stacksjs/paths'
+import { packageManager } from '../../package.json'
+import { library } from '../../../../config'
+
+export async function generatePackageJson(type: 'vue-components' | 'web-components' | 'functions') {
+  let name, description, directory, keywords, config
+
+  if (type === 'vue-components') {
+    name = library.vueComponents.name
+    description = library.vueComponents.description
+    directory = 'components'
+    keywords = library.vueComponents.keywords
+    config = 'vue-components'
+  }
+
+  else if (type === 'web-components') {
+    name = library.webComponents.name
+    description = library.webComponents.description
+    directory = 'components'
+    keywords = library.webComponents.keywords
+    config = 'web-components'
+  }
+
+  else if (type === 'functions') {
+    name = library.functions.name
+    description = library.functions.description
+    directory = 'functions'
+    keywords = library.functions.keywords
+    config = 'functions'
+  }
+
+  try {
+    // the version does not have to be set here,
+    // it will be set automatically by the release script
+    await writeTextFile({
+      path: packageJsonPath(type),
+      data: `{
+  "name": "${name}",
+  "type": "module",
+  "version": "",
+  "packageManager": "${packageManager}",
+  "description": "${description}",
+  "author": "${library.author}",
+  "license": "MIT",
+  "homepage": "https://github.com/${library.repository}/tree/main/${directory}#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/${library.repository}.git",
+    "directory": "${directory}"
+  },
+  "bugs": {
+    "url": "https://github.com/${library.repository}/issues"
+  },
+  "keywords": ${JSON.stringify(keywords)},
+  "contributors": ${JSON.stringify(library.contributors)},
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js"
+    }
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "vite build -c ../build/${config}.ts",
+    "prepublishOnly": "pnpm run build"
+  },
+  "devDependencies": {
+    "stacks": "workspace:*"
+  }
+}
+`,
+    })
+
+    consola.success(`Created the ${type} package.json.`)
+  }
+  catch (err) {
+    consola.error(err)
+  }
+}

package/core/actions/src/generate/vscode-custom-data.ts

@@ -0,0 +1,28 @@
+import consola from 'consola'
+import { customElementsDataPath } from '@stacksjs/paths'
+import { writeTextFile } from '@stacksjs/fs'
+import { library } from '../../../../config'
+
+export async function generateVsCodeCustomData() {
+  try {
+    // the version does not have to be set here,
+    // it will be set automatically by the release script
+    await writeTextFile({
+      path: customElementsDataPath(),
+      data: generateComponentInfoData(),
+    })
+  }
+  catch (err) {
+    consola.error(err)
+  }
+}
+
+function generateComponentInfoData() {
+  const componentsData = JSON.stringify(library.vueComponents.tags)
+
+  return `{
+  "version": 1.1,
+  "tags": ${componentsData}
+}
+`
+}

package/core/actions/src/generate/vue-compat.ts

@@ -0,0 +1,17 @@
+import fg from 'fast-glob'
+import fs from 'fs-extra'
+
+export async function generateVueCompat(paths: string[]) {
+  const files = await fg(paths, {
+    onlyFiles: true,
+  })
+
+  for (const f of files) {
+    const raw = await fs.readFile(f, 'utf-8')
+    const changed = raw
+      .replace(/"@vue\/composition-api"/g, '\'vue-demi\'')
+      .replace(/"vue"/g, '\'vue-demi\'')
+      .replace(/'vue'/g, '\'vue-demi\'')
+    await fs.writeFile(f, changed, 'utf-8')
+  }
+}

package/core/actions/src/generate-component-meta.ts

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+
+/**
+ * This action generates the component meta.
+ */
+
+import consola from 'consola'
+import { hasComponents } from '@stacksjs/fs'
+import { generateComponentMeta } from './generate/component-meta'
+
+async function generate() {
+  if (hasComponents())
+    await generateComponentMeta()
+
+  else
+    consola.info('No components found. Skipping component meta generation.')
+}
+
+generate()

package/core/actions/src/generate-ide-helpers.ts

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+
+/**
+ * This action generates the web-types.json & custom-elements.json
+ * files for the components.
+ */
+
+import consola from 'consola'
+import { hasComponents } from '@stacksjs/fs'
+import { generateVsCodeCustomData } from './generate/vscode-custom-data'
+// import { generateVsCodeCustomData, generateWebTypes } from './generate/vscode-custom-data'
+
+async function generate() {
+  if (hasComponents()) {
+    // await generateWebTypes()
+    await generateVsCodeCustomData()
+  }
+  else {
+    consola.info('No components found. Skipping IDE helper generation.')
+  }
+}
+
+generate()

package/core/actions/src/generate-lib-entries.ts

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+import consola from 'consola'
+import { hasComponents, hasFunctions } from '@stacksjs/fs'
+import { generateLibEntry } from './generate/lib-entries'
+
+async function generate() {
+  if (hasComponents()) {
+    await generateLibEntry('vue-components')
+    await generateLibEntry('web-components')
+  }
+  else {
+    consola.info('No components found. Skipping building component entry points.')
+  }
+
+  if (hasFunctions())
+    await generateLibEntry('functions')
+
+  else
+    consola.info('No functions found. Skipping building function entry point.')
+}
+
+generate()

package/core/actions/src/generate-package-json.ts

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+import { hasComponents, hasFunctions } from '@stacksjs/fs'
+import { generatePackageJson } from './generate/package-json'
+
+async function generate() {
+  if (hasComponents()) {
+    await generatePackageJson('vue-components')
+    await generatePackageJson('web-components')
+  }
+
+  if (hasFunctions())
+    await generatePackageJson('functions')
+}
+
+generate()