stacks 0.0.9 → 0.37.3

package/scripts/ensure-env.sh

@@ -0,0 +1,248 @@
+#!/bin/bash
+# many thanks to: https://raw.githubusercontent.com/Schniz/fnm/master/.ci/install.sh
+
+set -e
+
+# check if node is installed
+if which node > /dev/null
+  then
+    # check if Node version is over 16.17 or else install it & enable corepack,
+    # if it is not >= 16.17, we will need to update by auto-detecting whether
+    # a node manager used
+    wip
+  else
+    if which fnm > /dev/null
+      then
+        # use fnm to install a specified Node version
+        echo 'testing here'
+        echo ${pwd}
+        fnm use
+    elif which nvm > /dev/null
+      # use nvm to install correct node version
+      cp .node-version .nvmrc
+      nvm use
+    fi
+  fi
+else
+  # install node (abstract above into a function)
+
+# check if fnm is installed, if it is, assume it's used
+  then
+      nvm use
+
+
+
+# check if nvm is installed
+
+
+INSTALL_DIR="$HOME/.fnm"
+RELEASE="latest"
+OS="$(uname -s)"
+
+
+
+# Parse Flags
+parse_args() {
+  while [[ $# -gt 0 ]]; do
+    key="$1"
+
+    case $key in
+    -d | --install-dir)
+      INSTALL_DIR="$2"
+      shift # past argument
+      shift # past value
+      ;;
+    -s | --skip-shell)
+      SKIP_SHELL="true"
+      shift # past argument
+      ;;
+    --force-install | --force-no-brew)
+      echo "\`--force-install\`: I hope you know what you're doing." >&2
+      FORCE_INSTALL="true"
+      shift
+      ;;
+    -r | --release)
+      RELEASE="$2"
+      shift # past release argument
+      shift # past release value
+      ;;
+    *)
+      echo "Unrecognized argument $key"
+      exit 1
+      ;;
+    esac
+  done
+}
+
+set_filename() {
+  if [ "$OS" = "Linux" ]; then
+    # Based on https://stackoverflow.com/a/45125525
+    case "$(uname -m)" in
+      arm | armv7*)
+        FILENAME="fnm-arm32"
+        ;;
+      aarch* | armv8*)
+        FILENAME="fnm-arm64"
+        ;;
+      *)
+        FILENAME="fnm-linux"
+    esac
+  elif [ "$OS" = "Darwin" ] && [ "$FORCE_INSTALL" = "true" ]; then
+    FILENAME="fnm-macos"
+    USE_HOMEBREW="false"
+    echo "Downloading the latest fnm binary from GitHub..."
+    echo "  Pro tip: it's easier to use Homebrew for managing fnm in macOS."
+    echo "           Remove the \`--force-no-brew\` so it will be easy to upgrade."
+  elif [ "$OS" = "Darwin" ]; then
+    USE_HOMEBREW="true"
+    echo "Downloading fnm using Homebrew..."
+  else
+    echo "OS $OS is not supported."
+    echo "If you think that's a bug - please file an issue to https://github.com/Schniz/fnm/issues"
+    exit 1
+  fi
+}
+
+download_fnm() {
+  if [ "$USE_HOMEBREW" = "true" ]; then
+    brew install fnm
+  else
+    if [ "$RELEASE" = "latest" ]; then
+      URL="https://github.com/Schniz/fnm/releases/latest/download/$FILENAME.zip"
+    else
+      URL="https://github.com/Schniz/fnm/releases/download/$RELEASE/$FILENAME.zip"
+    fi
+
+    DOWNLOAD_DIR=$(mktemp -d)
+
+    echo "Downloading $URL..."
+
+    mkdir -p "$INSTALL_DIR" &>/dev/null
+
+    if ! curl --progress-bar --fail -L "$URL" -o "$DOWNLOAD_DIR/$FILENAME.zip"; then
+      echo "Download failed.  Check that the release/filename are correct."
+      exit 1
+    fi
+
+    unzip -q "$DOWNLOAD_DIR/$FILENAME.zip" -d "$DOWNLOAD_DIR"
+
+    if [ -f "$DOWNLOAD_DIR/fnm" ]; then
+      mv "$DOWNLOAD_DIR/fnm" "$INSTALL_DIR/fnm"
+    else
+      mv "$DOWNLOAD_DIR/$FILENAME/fnm" "$INSTALL_DIR/fnm"
+    fi
+
+    chmod u+x "$INSTALL_DIR/fnm"
+  fi
+}
+
+check_dependencies() {
+  echo "Checking dependencies for the installation script..."
+
+  echo -n "Checking availability of curl... "
+  if hash curl 2>/dev/null; then
+    echo "OK!"
+  else
+    echo "Missing!"
+    SHOULD_EXIT="true"
+  fi
+
+  echo -n "Checking availability of unzip... "
+  if hash unzip 2>/dev/null; then
+    echo "OK!"
+  else
+    echo "Missing!"
+    SHOULD_EXIT="true"
+  fi
+
+  if [ "$USE_HOMEBREW" = "true" ]; then
+    echo -n "Checking availability of Homebrew (brew)... "
+    if hash brew 2>/dev/null; then
+      echo "OK!"
+    else
+      echo "Missing!"
+      SHOULD_EXIT="true"
+    fi
+  fi
+
+  if [ "$SHOULD_EXIT" = "true" ]; then
+    echo "Not installing fnm due to missing dependencies."
+    exit 1
+  fi
+}
+
+ensure_containing_dir_exists() {
+  local CONTAINING_DIR
+  CONTAINING_DIR="$(dirname "$1")"
+  if [ ! -d "$CONTAINING_DIR" ]; then
+    echo " >> Creating directory $CONTAINING_DIR"
+    mkdir -p "$CONTAINING_DIR"
+  fi
+}
+
+setup_shell() {
+  CURRENT_SHELL="$(basename "$SHELL")"
+
+  if [ "$CURRENT_SHELL" = "zsh" ]; then
+    CONF_FILE=${ZDOTDIR:-$HOME}/.zshrc
+    ensure_containing_dir_exists "$CONF_FILE"
+    echo "Installing for Zsh. Appending the following to $CONF_FILE:"
+    echo ""
+    echo '  # fnm'
+    echo '  export PATH='"$INSTALL_DIR"':$PATH'
+    echo '  eval "`fnm env`"'
+
+    echo '' >>$CONF_FILE
+    echo '# fnm' >>$CONF_FILE
+    echo 'export PATH='$INSTALL_DIR':$PATH' >>$CONF_FILE
+    echo 'eval "`fnm env`"' >>$CONF_FILE
+
+  elif [ "$CURRENT_SHELL" = "fish" ]; then
+    CONF_FILE=$HOME/.config/fish/conf.d/fnm.fish
+    ensure_containing_dir_exists "$CONF_FILE"
+    echo "Installing for Fish. Appending the following to $CONF_FILE:"
+    echo ""
+    echo '  # fnm'
+    echo '  set PATH '"$INSTALL_DIR"' $PATH'
+    echo '  fnm env | source'
+
+    echo '# fnm' >>$CONF_FILE
+    echo 'set PATH '"$INSTALL_DIR"' $PATH' >>$CONF_FILE
+    echo 'fnm env | source' >>$CONF_FILE
+
+  elif [ "$CURRENT_SHELL" = "bash" ]; then
+    if [ "$OS" = "Darwin" ]; then
+      CONF_FILE=$HOME/.profile
+    else
+      CONF_FILE=$HOME/.bashrc
+    fi
+    ensure_containing_dir_exists "$CONF_FILE"
+    echo "Installing for Bash. Appending the following to $CONF_FILE:"
+    echo ""
+    echo '  # fnm'
+    echo '  export PATH='"$INSTALL_DIR"':$PATH'
+    echo '  eval "`fnm env`"'
+
+    echo '' >>$CONF_FILE
+    echo '# fnm' >>$CONF_FILE
+    echo 'export PATH='"$INSTALL_DIR"':$PATH' >>$CONF_FILE
+    echo 'eval "`fnm env`"' >>$CONF_FILE
+
+  else
+    echo "Could not infer shell type. Please set up manually."
+    exit 1
+  fi
+
+  echo ""
+  echo "In order to apply the changes, open a new terminal or run the following command:"
+  echo ""
+  echo "  source $CONF_FILE"
+}
+
+parse_args "$@"
+set_filename
+check_dependencies
+download_fnm
+if [ "$SKIP_SHELL" != "true" ]; then
+  setup_shell
+fi

package/shims.d.ts

@@ -0,0 +1,29 @@
+interface ImportMetaEnv {
+  readonly APP_NAME: string
+  readonly APP_ENV: string
+  readonly APP_KEY: string
+  readonly APP_URL: string
+  readonly APP_DEBUG: boolean
+}
+
+interface ImportMeta {
+  readonly env: ImportMetaEnv
+}
+
+declare interface Window {
+  // extend the window
+}
+
+// via `vite-plugin-vue-markdown`, markdown
+// files can be treated as Vue components
+declare module '*.md' {
+  import { type DefineComponent } from 'vue'
+  const component: DefineComponent<{}, {}, any>
+  export default component
+}
+
+declare module '*.vue' {
+  import { type DefineComponent } from 'vue'
+  const component: DefineComponent<{}, {}, any>
+  export default component
+}

package/simple-git-hooks.cjs

@@ -0,0 +1,4 @@
+const jiti = require('jiti')(__filename)
+const config = jiti('../config/git.ts')
+
+module.exports = config.hooks

package/src/cli/actions/build.ts

@@ -0,0 +1,160 @@
+import Prompts from 'prompts'
+import consola from 'consola'
+import { hasComponents, hasFunctions } from '@stacksjs/fs'
+import { runNpmScript } from '@stacksjs/helpers'
+import { ExitCode, NpmScript } from '@stacksjs/types'
+import { generateTypes } from './types'
+
+const { prompts } = Prompts
+
+export async function buildComponentLibraries() {
+  try {
+    await runNpmScript(NpmScript.GenerateEntries)
+    await buildVueComponentLibrary()
+    await buildWebComponentLibrary()
+  }
+  catch (error) {
+    consola.error('There was an error building your component libraries.')
+    consola.error(error)
+  }
+}
+
+export async function buildVueComponentLibrary() {
+  consola.info('Building your component library...')
+
+  if (hasComponents()) {
+    try {
+      await runNpmScript(NpmScript.BuildComponents)
+      consola.success('Your component library was built successfully.')
+    }
+    catch (error) {
+      consola.error('There was an error building your component library.')
+      consola.error(error)
+    }
+  }
+  else {
+    consola.info('No components found.')
+  }
+}
+
+export async function buildWebComponentLibrary() {
+  consola.info('Building your component library for production use & npm/CDN distribution...')
+
+  if (hasComponents()) {
+    try {
+      await runNpmScript(NpmScript.BuildWebComponents)
+      consola.success('Your Web Component library was built successfully.')
+    }
+    catch (error) {
+      consola.error('There was an error building your Web Component library.')
+      consola.error(error)
+    }
+  }
+  else {
+    consola.info('No components found.')
+  }
+}
+
+export async function buildDocs() {
+  consola.info('Building the Artisan CLI...')
+
+  try {
+    await runNpmScript(NpmScript.BuildDocs)
+    consola.success('Artisan CLI was built successfully.')
+  }
+  catch (error) {
+    consola.error('There was an error building the Artisan CLI.')
+    consola.error(error)
+  }
+}
+
+export async function buildStacks() {
+  consola.info('Building the Stacks Framework...')
+
+  try {
+    await runNpmScript(NpmScript.BuildStacks)
+    consola.success('Stacks was built successfully.')
+  }
+  catch (error) {
+    consola.error('There was an error building the Stacks framework.')
+    consola.error(error)
+  }
+}
+
+export async function buildFunctionsLibrary() {
+  consola.info('Building your functions library for production use & npm/CDN distribution...')
+
+  if (hasFunctions()) {
+    try {
+      await runNpmScript(NpmScript.BuildFunctions)
+      consola.success('Your functions library was built successfully.')
+    }
+    catch (error) {
+      consola.error('There was an error building your functions library.')
+      consola.error(error)
+    }
+  }
+  else {
+    consola.info('No functions found.')
+  }
+}
+
+export async function startBuildProcess(options: any) {
+  if (options.components || options === 'components') {
+    await buildComponentLibraries()
+  }
+
+  else if (options.webComponents || options.elements || options === 'web-components' || options === 'elements') {
+    await buildWebComponentLibrary()
+  }
+
+  else if (options.functions || options === 'functions') {
+    await buildFunctionsLibrary()
+  }
+
+  else if (options.docs || options === 'docs') {
+    await buildDocs()
+  }
+
+  else if (options.stacks || options === 'stacks') {
+    await buildStacks()
+  }
+
+  else if (options.npm || options === 'npm') {
+    await buildComponentLibraries()
+    await buildFunctionsLibrary()
+
+    consola.success('All your libraries and its types were built successfully to be distributed on npm.')
+  }
+
+  else {
+    const answer = await prompts.select({
+      type: 'select',
+      name: 'build',
+      message: 'Which stack are you trying to build for production use?',
+      choices: [ // todo: should be a multi-select
+        { title: 'Components', value: 'components' },
+        { title: 'Functions', value: 'functions' },
+        // { title: 'Pages', value: 'pages' },
+        { title: 'Docs', value: 'docs' },
+      ],
+      initial: 0,
+    })
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    if (answer === 'components')
+      await buildComponentLibraries()
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    if (answer === 'functions')
+      await buildFunctionsLibrary()
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    else if (answer === 'docs')
+      await buildDocs()
+
+    else process.exit(ExitCode.InvalidArgument)
+  }
+
+  await generateTypes()
+}

package/src/cli/actions/commit.ts

@@ -0,0 +1,9 @@
+import consola from 'consola'
+import { runNpmScript } from '@stacksjs/helpers'
+import { NpmScript } from '@stacksjs/types'
+
+export async function commit() {
+  consola.info('Committing...')
+  await runNpmScript(NpmScript.Commit)
+  consola.success('Committed.')
+}

package/src/cli/actions/dev.ts

@@ -0,0 +1,47 @@
+import Prompts from 'prompts'
+import consola from 'consola'
+import { runNpmScript } from '@stacksjs/helpers'
+import { ExitCode, NpmScript } from '@stacksjs/types'
+
+const { prompts } = Prompts
+
+export async function startDevelopmentServer(options: any) {
+  if (options.components || options === 'components') {
+    consola.info('Starting development server for your components...')
+    await runNpmScript(NpmScript.DevComponents)
+  }
+
+  else if (options.docs || options === 'docs') {
+    consola.info('Starting development server for your documentation...')
+    await runNpmScript(NpmScript.DevDocs)
+  }
+
+  else {
+    const answer = await prompts.select({
+      type: 'select',
+      name: 'development',
+      message: 'Which development server are you trying to start?',
+      choices: [
+        { title: 'Components', value: 'components' },
+        // { title: 'Functions', value: 'functions' },
+        // { title: 'Pages', value: 'pages' },
+        { title: 'Docs', value: 'docs' },
+      ],
+      initial: 0,
+    })
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    if (answer === 'components') {
+      consola.info('Starting development server for your components...')
+      await runNpmScript(NpmScript.DevComponents)
+    }
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    else if (answer === 'docs') {
+      consola.info('Starting docs server for your components...')
+      await runNpmScript(NpmScript.DevDocs)
+    }
+
+    else { process.exit(ExitCode.InvalidArgument) }
+  }
+}

package/src/cli/actions/examples.ts

@@ -0,0 +1,74 @@
+import Prompts from 'prompts'
+import consola from 'consola'
+import { hasComponents } from '@stacksjs/fs'
+import { runNpmScript } from '@stacksjs/helpers'
+import { ExitCode, NpmScript } from '@stacksjs/types'
+
+const { prompts } = Prompts
+
+export async function testComponentExample() {
+  if (hasComponents()) {
+    try {
+      await runNpmScript(NpmScript.ExampleVue)
+      consola.success('Your component library was built successfully.')
+    }
+    catch (error) {
+      consola.error('There was an error building your component library.')
+      consola.error(error)
+    }
+  }
+  else {
+    consola.info('No components found.')
+  }
+}
+
+export async function testWebComponentExample() {
+  consola.info('Building your Web Component library...')
+
+  if (hasComponents()) {
+    try {
+      await runNpmScript(NpmScript.BuildWebComponents)
+      consola.success('Your Web Component library was built successfully.')
+    }
+    catch (error) {
+      consola.error('There was an error building your Web Component library.')
+      consola.error(error)
+    }
+  }
+  else {
+    consola.info('No components found.')
+  }
+}
+
+export async function runExample(options: any) {
+  if (options.components || options === 'components' || options === 'vue') {
+    await testComponentExample()
+  }
+
+  else if (options.webComponents || options.elements || options === 'web-components' || options === 'elements') {
+    await testWebComponentExample()
+  }
+
+  else {
+    const answer = await prompts.select({
+      type: 'select',
+      name: 'example',
+      message: 'Which example are you trying to view?',
+      choices: [
+        { title: 'Components', value: 'components' },
+        { title: 'Web Components', value: 'web-components' },
+      ],
+      initial: 0,
+    })
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    if (answer === 'components')
+      await testComponentExample()
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    if (answer === 'web-components')
+      await testWebComponentExample()
+
+    else process.exit(ExitCode.InvalidArgument)
+  }
+}

package/src/cli/actions/fresh.ts

@@ -0,0 +1,9 @@
+import consola from 'consola'
+import { runNpmScript } from '@stacksjs/helpers'
+import { NpmScript } from '@stacksjs/types'
+
+export async function reinstallNpmDependencies() {
+  consola.info('Reinstalling your npm dependencies...')
+  await runNpmScript(NpmScript.Fresh)
+  consola.success('Successfully reinstalled your npm dependencies.')
+}