stacks 0.1.0 → 0.37.4

package/core/fs/src/index.ts

@@ -0,0 +1,170 @@
+import { fileURLToPath } from 'node:url'
+import { copyFileSync, existsSync, mkdirSync, readFile, readdirSync, rmSync, statSync, writeFile } from 'node:fs'
+import detectIndent from 'detect-indent'
+import { detectNewline } from 'detect-newline'
+import type { JsonFile, TextFile } from '@stacksjs/types'
+import { componentsPath, dirname, functionsPath, join, projectPath } from '@stacksjs/paths'
+import { contains } from '@stacksjs/arrays'
+
+/**
+ * Reads a JSON file and returns the parsed data.
+ */
+export async function readJsonFile(name: string, cwd: string): Promise<JsonFile> {
+  const file = await readTextFile(name, cwd)
+  const data = JSON.parse(file.data) as unknown
+  const indent = detectIndent(file.data).indent
+  const newline = detectNewline(file.data)
+
+  return { ...file, data, indent, newline }
+}
+
+/**
+ * Writes the given data to the specified JSON file.
+ */
+export async function writeJsonFile(file: JsonFile): Promise<void> {
+  let json = JSON.stringify(file.data, undefined, file.indent)
+
+  if (file.newline)
+    json += file.newline
+
+  return writeTextFile({ ...file, data: json })
+}
+
+/**
+ * Reads a text file and returns its contents.
+ */
+export function readTextFile(name: string, cwd?: string): Promise<TextFile> {
+  return new Promise((resolve, reject) => {
+    let filePath: string
+
+    if (cwd)
+      filePath = join(cwd, name)
+    else
+      filePath = name
+
+    readFile(filePath, 'utf8', (err, text) => {
+      if (err) {
+        reject(err)
+      }
+      else {
+        resolve({
+          path: filePath,
+          data: text,
+        })
+      }
+    })
+  })
+}
+
+/**
+ * Writes the given text to the specified file.
+ */
+export function writeTextFile(file: TextFile): Promise<void> {
+  return new Promise((resolve, reject) => {
+    writeFile(file.path, file.data, (err: any) => {
+      if (err)
+        reject(err)
+
+      else
+        resolve()
+    })
+  })
+}
+
+/**
+ * Determine whether a path is a folder.
+ */
+export function isFolder(path: string): boolean {
+  try {
+    return statSync(path).isDirectory()
+  }
+  catch {
+    return false
+  }
+}
+
+/**
+ * Determine whether a path is a file.
+ */
+export function isFile(path: string): boolean {
+  return existsSync(projectPath(path))
+}
+
+/**
+ * Determine whether a folder has any files in it.
+ */
+export function hasFiles(folder: string): boolean {
+  return readdirSync(folder).length > 0
+}
+
+export function hasComponents(): boolean {
+  return hasFiles(componentsPath())
+}
+
+export function hasFunctions(): boolean {
+  return hasFiles(functionsPath())
+}
+
+export function copyFolder(src: string, dest: string, exclude: string[] = []): void {
+  if (!existsSync(dest))
+    mkdirSync(dest, { recursive: true })
+
+  if (existsSync(src)) {
+    readdirSync(src).forEach((file) => {
+      if (!contains(join(src, file), exclude)) {
+        const srcPath = join(src, file)
+        const destPath = join(dest, file)
+
+        if (statSync(srcPath).isDirectory())
+          copyFolder(srcPath, destPath, exclude)
+
+        else
+          copyFileSync(srcPath, destPath)
+      }
+    })
+  }
+}
+
+export async function deleteFolder(path: string) {
+  if (statSync(path).isDirectory())
+    await rmSync(path, { recursive: true, force: true })
+}
+
+export function deleteFiles(dir: string, exclude: string[] = []) {
+  if (existsSync(dir)) {
+    readdirSync(dir).forEach((file) => {
+      const path = join(dir, file)
+      if (statSync(path).isDirectory()) {
+        if (readdirSync(path).length === 0)
+          rmSync(path, { recursive: true, force: true })
+
+        else
+          deleteFiles(path, exclude)
+      }
+
+      else if (!contains(path, exclude)) { rmSync(path) }
+    })
+  }
+}
+
+export function deleteEmptyFolders(dir: string) {
+  if (existsSync(dir)) {
+    readdirSync(dir).forEach((file) => {
+      const path = join(dir, file)
+      if (statSync(path).isDirectory()) {
+        if (readdirSync(path).length === 0)
+          rmSync(path, { recursive: true, force: true })
+
+        else deleteEmptyFolders(path)
+      }
+    })
+  }
+}
+
+export function doesFolderExist(path: string) {
+  return existsSync(path)
+}
+
+export const _dirname = typeof __dirname !== 'undefined'
+  ? __dirname
+  : dirname(fileURLToPath(import.meta.url))

package/core/helpers/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="/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../node_modules/.pnpm/mkdist@0.3.13/node_modules/mkdist/dist/cli.cjs" "$@"
+else
+  exec node  "$basedir/../../../../../node_modules/.pnpm/mkdist@0.3.13/node_modules/mkdist/dist/cli.cjs" "$@"
+fi

package/core/helpers/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@stacksjs/helpers",
+  "type": "module",
+  "version": "0.37.4",
+  "packageManager": "pnpm@7.13.6",
+  "description": "The Stacks helper functions.",
+  "author": "Chris Breuer",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/chrisbbreuer",
+  "homepage": "https://github.com/stacksjs/stacks/tree/main/.stacks/core/helpers#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stacksjs/stacks.git",
+    "directory": "./.stacks/core/helpers"
+  },
+  "bugs": {
+    "url": "https://github.com/stacksjs/stacks/issues"
+  },
+  "keywords": [
+    "objects",
+    "strings",
+    "arrays",
+    "alias",
+    "helpers",
+    "utilities",
+    "functions",
+    "stacks"
+  ],
+  "main": "dist/index.mjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "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": {
+    "@jsdevtools/ez-spawn": "^3.0.4",
+    "@stacksjs/fs": "workspace:*",
+    "@stacksjs/paths": "workspace:*",
+    "@stacksjs/types": "workspace:*",
+    "consola": "^2.15.3"
+  },
+  "devDependencies": {
+    "mkdist": "^0.3.13"
+  }
+}

package/core/helpers/src/index.ts

@@ -0,0 +1,129 @@
+import consola from 'consola'
+import { ExitCode, type Manifest, type NpmScript } from '@stacksjs/types'
+import { frameworkPath, projectPath } from '@stacksjs/paths'
+import { isFile, readJsonFile, readTextFile, writeTextFile } from '@stacksjs/fs'
+import ezSpawn from '@jsdevtools/ez-spawn'
+import { ui } from '../../../config'
+
+export async function isProjectCreated() {
+  if (isFile('.env'))
+    return await isAppKeySet()
+
+  if (isFile('.env.example'))
+    await ezSpawn.async('cp .env.example .env', { stdio: 'inherit', cwd: projectPath() })
+
+  return await isAppKeySet()
+}
+
+export async function isAppKeySet() {
+  const env = await readTextFile('.env', projectPath())
+  const lines = env.data.split('\n')
+  const appKey = lines.find(line => line.startsWith('APP_KEY='))
+
+  if (appKey && appKey.length > 16)
+    return true
+
+  return false
+}
+
+/**
+ * Determines the utilized reset preset.
+ *
+ * @url https://www.npmjs.com/package/@unocss/reset
+ * @param preset
+ */
+export function determineResetPreset(preset?: string) {
+  if (ui.reset)
+    preset = ui.reset
+
+  if (preset === 'tailwind')
+    return ['import \'@unocss/reset/tailwind.css\'']
+
+  if (preset === 'normalize')
+    return ['import \'@unocss/reset/normalize.css\'']
+
+  if (preset === 'sanitize')
+    return ['import \'@unocss/reset/sanitize/sanitize.css\'', 'import \'@unocss/reset/sanitize/assets.css']
+
+  if (preset === 'eric-meyer')
+    return ['import \'@unocss/reset/eric-meyer.css\'']
+
+  if (preset === 'antfu')
+    return ['import \'@unocss/reset/antfu.css\'']
+
+  return []
+}
+
+export function env(key?: string, fallback?: any) {
+  // console.log('isClient', isClient)
+  // if (key && import.meta?.env)
+  //   return import.meta.env[key]
+
+  return fallback
+}
+
+export function config(key?: string, fallback?: string) {
+  // eslint-disable-next-line no-console
+  console.log('key', key, 'fallback', fallback)
+  // return key ? configArr[key as string] : fallback
+}
+
+/**
+ * Determines whether the specified value is a package manifest.
+ */
+export function isManifest(obj: any): obj is Manifest {
+  return obj
+    && typeof obj === 'object'
+    && isOptionalString(obj.name)
+    && isOptionalString(obj.version)
+    && isOptionalString(obj.description)
+}
+
+/**
+ * Determines whether the specified value is a string, null, or undefined.
+ */
+function isOptionalString(value: any): value is string | undefined {
+  const type = typeof value
+  return value === null
+    || type === 'undefined'
+    || type === 'string'
+}
+
+export async function setEnvValue(key: string, value: string) {
+  const file = await readTextFile(projectPath('.env'))
+
+  await writeTextFile({
+    path: projectPath('.env'),
+    data: file.data.replace(/APP_KEY=/g, `APP_KEY=${value}`), // todo: do not hardcode the APP_KEY here and instead use the key parameter
+  })
+}
+
+/**
+ * Runs the specified NPM script in the package.json file.
+ */
+export async function runNpmScript(script: NpmScript, debug: 'ignore' | 'inherit' = 'inherit') {
+  const path = frameworkPath()
+
+  const { data: manifest } = await readJsonFile('package.json', path)
+
+  if (isManifest(manifest) && hasScript(manifest, script)) {
+    await ezSpawn.async('pnpm', ['run', script], { stdio: debug, cwd: path })
+  }
+
+  else {
+    consola.error('Error running your Artisan script.')
+    process.exit(ExitCode.FatalError)
+  }
+}
+
+/**
+ * Determines whether the specified NPM script exists in the given manifest.
+ */
+export function hasScript(manifest: Manifest, script: NpmScript): boolean {
+  const scripts = manifest.scripts as Record<NpmScript, string> | undefined
+
+  if (scripts && typeof scripts === 'object')
+    return Boolean(scripts[script])
+
+  return false
+}

package/core/modules/README.md

@@ -0,0 +1,61 @@
+# Stacks Modules
+
+A custom user module system. Place a `.ts` file with the following template & it will be installed automatically.
+
+## ☘️ Features
+
+wip
+
+- ⚡️
+
+wip
+
+## 🤖 Usage
+
+wip
+
+```bash
+pnpm i -D @stacksjs/modules
+```
+
+Now, you can use it in your project:
+
+```ts
+import { type UserModule } from '@stacksjs/types'
+
+export const install: UserModule = ({ app, router, isClient }) => {
+  // do something
+}
+```
+
+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/modules/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="/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../node_modules/.pnpm/mkdist@0.3.13/node_modules/mkdist/dist/cli.cjs" "$@"
+else
+  exec node  "$basedir/../../../../../node_modules/.pnpm/mkdist@0.3.13/node_modules/mkdist/dist/cli.cjs" "$@"
+fi

package/core/modules/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@stacksjs/modules",
+  "type": "module",
+  "version": "0.37.4",
+  "packageManager": "pnpm@7.13.6",
+  "description": "The Stacks framework modules.",
+  "author": "Chris Breuer",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/chrisbbreuer",
+  "homepage": "https://github.com/stacksjs/stacks/tree/main/.stacks/core/modules#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stacksjs/stacks.git",
+    "directory": "./.stacks/core/modules"
+  },
+  "bugs": {
+    "url": "https://github.com/stacksjs/stacks/issues"
+  },
+  "keywords": [
+    "modules",
+    "stacks",
+    "framework",
+    "typescript",
+    "javascript"
+  ],
+  "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/types": "workspace:*",
+    "@types/nprogress": "^0.2.0",
+    "nprogress": "^0.2.0",
+    "vue-i18n": "^9.2.2"
+  },
+  "devDependencies": {
+    "mkdist": "^0.3.13"
+  }
+}

package/core/modules/src/i18n.ts

@@ -0,0 +1,23 @@
+import { createI18n } from 'vue-i18n'
+import { type UserModule } from '@stacksjs/types'
+
+// Import i18n resources
+// https://vitejs.dev/guide/features.html#glob-import
+const messages = Object.fromEntries(
+  Object.entries(
+    import.meta.glob<{ default: any }>(langPath('*.y(a)?ml'), { eager: true }))
+    .map(([key, value]) => {
+      const yaml = key.endsWith('.yaml')
+      return [key.slice(14, yaml ? -5 : -4), value.default]
+    }),
+)
+
+export const install: UserModule = ({ app }) => {
+  const i18n = createI18n({
+    legacy: false,
+    locale: 'en',
+    messages,
+  })
+
+  app.use(i18n)
+}

package/core/modules/src/nprogress.ts

@@ -0,0 +1,12 @@
+import NProgress from 'nprogress'
+import { type UserModule } from '@stacksjs/types'
+
+export const install: UserModule = ({ isClient, router }) => {
+  if (isClient) {
+    router.beforeEach((to, from) => {
+      if (to.path !== from.path)
+        NProgress.start()
+    })
+    router.afterEach(() => { NProgress.done() })
+  }
+}

package/core/modules/src/pwa.ts

@@ -0,0 +1,12 @@
+import { type UserModule } from '@stacksjs/types'
+
+// https://github.com/antfu/vite-plugin-pwa#automatic-reload-when-new-content-available
+export const install: UserModule = ({ isClient, router }) => {
+  if (!isClient)
+    return
+
+  router.isReady().then(async () => {
+    const { registerSW } = await import('virtual:pwa-register')
+    registerSW({ immediate: true })
+  })
+}

package/core/objects/README.md

@@ -0,0 +1,59 @@
+# Stacks Objects
+
+This package contains the Stacks Objects source.
+
+## ☘️ Features
+
+wip
+
+- ⚡️
+
+wip
+
+## 🤖 Usage
+
+wip
+
+```bash
+pnpm i -D @stacksjs/objects
+```
+
+Now, you can use it in your project:
+
+```js
+import * as objects from '@stacksjs/objects'
+
+// 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/objects/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="/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/stacks/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/objects/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="/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/stacks/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/objects/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="/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/stacks/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