@stacksjs/utils 0.65.0 → 0.68.0

package/src/clean.ts

@@ -1,15 +0,0 @@
-import { path as p } from '@stacksjs/path'
-
-export async function cleanProject() {
-  const $ = Bun.$
-  await $`rm -rf ${p.projectPath('bun.lockb')}`
-  await $`rm -rf ${p.projectPath('yarn.lock')}` // just in case
-  await $`rm -rf ${p.projectPath('node_modules/')}`
-  await $`rm -rf ${p.frameworkPath('dist')}`
-  await $`rm -rf ${p.frameworkPath('node_modules')}`
-  await $`rm -rf ${p.frameworkPath('**/dist')}`
-  await $`rm -rf ${p.frameworkPath('**/node_modules')}`
-  await $`rm -rf ${p.frameworkCloudPath('cdk.out/')}`
-  await $`rm -rf ${p.frameworkCloudPath('cdk.context.json')}`
-  await $`rm -rf ${p.cloudPath('dist.zip')}`
-}

package/src/config.ts

@@ -1,25 +0,0 @@
-export {
-  defineApp,
-  defineCache,
-  defineCdn,
-  defineChat,
-  defineCli,
-  defineCronJob,
-  defineDatabase,
-  defineDependencies,
-  defineDns,
-  defineEmail,
-  defineEmailConfig,
-  defineGit,
-  defineHashing,
-  defineJob,
-  defineLibrary,
-  defineNotification,
-  definePayment,
-  defineQueue,
-  defineSearchEngine,
-  defineServices,
-  defineSms,
-  defineStorage,
-  defineUi,
-} from '@stacksjs/config'

package/src/equal.ts

@@ -1,27 +0,0 @@
-import { getTypeName } from '@stacksjs/types'
-
-export function isDeepEqual(value1: any, value2: any): boolean {
-  const type1 = getTypeName(value1)
-  const type2 = getTypeName(value2)
-  if (type1 !== type2)
-    return false
-
-  if (type1 === 'array') {
-    if (value1.length !== value2.length)
-      return false
-
-    return value1.every((item: any, i: number) => {
-      return isDeepEqual(item, value2[i])
-    })
-  }
-  if (type1 === 'object') {
-    const keyArr = Object.keys(value1)
-    if (keyArr.length !== Object.keys(value2).length)
-      return false
-
-    return keyArr.every((key: string) => {
-      return isDeepEqual(value1[key], value2[key])
-    })
-  }
-  return Object.is(value1, value2)
-}

package/src/export-size.ts

@@ -1 +0,0 @@
-export { getExportsSize } from 'export-size'

package/src/find.ts

@@ -1,102 +0,0 @@
-/* eslint no-console: 0 */
-import type { Dirent } from 'node:fs'
-import fs from 'node:fs/promises'
-import os from 'node:os'
-import path from 'node:path'
-import { italic } from '@stacksjs/cli'
-import { log } from '@stacksjs/logging'
-
-const targetFileName = 'buddy' // The exact name of the target file
-
-const excludePatterns = [
-  'node_modules',
-  'dist',
-  'vendor',
-  'storage/framework',
-  `${os.homedir()}/Documents`,
-  `${os.homedir()}/Pictures`,
-  `${os.homedir()}/Library`,
-  `${os.homedir()}/.Trash`,
-  /.*out.*/, // exclude any folder with 'out' in the name
-  /.*\/\..*/, // exclude any folder that starts with a dot
-]
-
-interface FindStacksProjectsOptions {
-  quiet?: boolean
-}
-
-export async function findStacksProjects(dir?: string, options?: FindStacksProjectsOptions): Promise<string[]> {
-  dir = dir || os.homedir()
-
-  if (!options?.quiet) {
-    log.info(`Searching for Stacks projects in: ${italic(dir)}`)
-    log.info(`This may take a few moments...`)
-    console.log('')
-    console.log(italic('  Please note, while Stacks is searching for projects on your machine,'))
-    console.log(italic('  you may be asked for permissions to scan certain directories.'))
-    console.log('')
-    log.debug(`Excluding directories: ${excludePatterns.join(', ')}`)
-  }
-
-  const foundProjects = await searchDirectory(dir)
-
-  if (!foundProjects)
-    throw new Error('No Stacks projects found')
-
-  return foundProjects
-}
-
-// this searches a dir for Stacks projects which we define
-// as a dir that contains a 'buddy' file and a 'storage'
-// dir with a 'framework/core/buddy' structure
-async function searchDirectory(directory: string): Promise<string[]> {
-  const foundProjects: string[] = []
-  const isExcluded = excludePatterns.some(pattern =>
-    typeof pattern === 'string' ? directory.includes(pattern) : pattern.test(directory),
-  )
-
-  if (isExcluded)
-    return foundProjects
-
-  let items: Dirent[]
-  try {
-    items = await fs.readdir(directory, { withFileTypes: true })
-  }
-  catch (error) {
-    console.error(`Error reading directory ${directory}:`, error)
-    return foundProjects
-  }
-
-  let buddyFileFound = false
-  let storageDirFound = false
-
-  for (const item of items) {
-    if (item.isFile() && item.name === targetFileName) {
-      buddyFileFound = true
-    }
-
-    if (item.isDirectory()) {
-      const fullPath = path.join(directory, item.name)
-      if (item.name === 'storage') {
-        const storagePath = path.join(fullPath, 'framework/core/buddy')
-        try {
-          await fs.access(storagePath)
-          storageDirFound = true
-        }
-        catch (error) {
-          console.error(`Error accessing directory ${storagePath}:`, error)
-        }
-      }
-
-      // Accumulate results from recursive calls
-      const subDirProjects = await searchDirectory(fullPath)
-      foundProjects.push(...subDirProjects)
-    }
-  }
-
-  if (buddyFileFound && storageDirFound) {
-    foundProjects.push(directory)
-  }
-
-  return foundProjects
-}

package/src/git.ts

@@ -1,13 +0,0 @@
-import { execSync } from 'node:child_process'
-import { handleError } from '@stacksjs/error-handling'
-
-export function isGitClean(): boolean {
-  try {
-    execSync('git diff-index --quiet HEAD --')
-    return true
-  }
-  catch (error) {
-    handleError(error)
-    return false
-  }
-}

package/src/glob.ts

@@ -1 +0,0 @@
-export { glob } from '@stacksjs/storage'

package/src/hash.ts

@@ -1,36 +0,0 @@
-import { config } from '@stacksjs/config'
-import { log } from '@stacksjs/logging'
-import { path as p } from '@stacksjs/path'
-import { hashPaths } from '@stacksjs/storage'
-
-export function originRequestFunctionHash() {
-  try {
-    return hashPaths(p.cloudPath('src/edge'))
-  }
-  catch (error: any) {
-    log.error('Are we in a Docker container? Failed to hash paths. Error below:')
-    log.error(error)
-    return undefined
-  }
-}
-
-const docsSrc = [p.projectPath('docs'), p.frameworkPath('docs/dist')]
-
-export function websiteSourceHash() {
-  const websiteSrc = [
-    p.projectPath('resources/views'),
-    p.projectPath('resources/assets'),
-    p.projectPath('resources/lang'),
-    p.projectPath('resources/functions'),
-    p.projectPath('resources/components'),
-    p.projectPath('resources/modules'),
-    p.projectPath('resources/stores'),
-    p.frameworkPath('views/web'),
-  ]
-
-  return config.app.docMode === true ? hashPaths(docsSrc) : hashPaths(websiteSrc)
-}
-
-export function docsSourceHash() {
-  return hashPaths(docsSrc)
-}

package/src/helpers.ts

@@ -1,186 +0,0 @@
-import type { NpmScript } from '@stacksjs/enums'
-import type { Result } from '@stacksjs/error-handling'
-import type { CliOptions, Manifest, Subprocess } from '@stacksjs/types'
-import type { AddressInfo } from 'node:net'
-import { runAction } from '@stacksjs/actions'
-import { log, runCommand } from '@stacksjs/cli'
-import { app, ui } from '@stacksjs/config'
-import { Action } from '@stacksjs/enums'
-import { err, handleError, ok } from '@stacksjs/error-handling'
-import { frameworkPath, projectPath } from '@stacksjs/path'
-import * as storage from '@stacksjs/storage'
-import { parse } from 'yaml'
-
-// import { semver } from './versions'
-
-export async function packageManager() {
-  const { packageManager } = await storage.readPackageJson(frameworkPath('package.json'))
-  return packageManager
-}
-
-export async function initProject(): Promise<Result<Subprocess, Error>> {
-  if (app.env !== 'production')
-    log.info('Project not yet initialized, generating application key...')
-  else handleError('Please run `buddy key:generate` to generate an application key')
-
-  const result = await runAction(Action.KeyGenerate, { cwd: projectPath() })
-
-  if (result.isErr())
-    return err(handleError(result.error))
-
-  log.info('Application key generated.')
-
-  return ok(result.value)
-}
-
-export async function ensureProjectIsInitialized() {
-  if (storage.isFile(projectPath('.env')))
-    return await isAppKeySet()
-
-  // copy the .env.example file to .env
-  if (storage.isFile(projectPath('.env.example')))
-    await runCommand('cp .env.example .env', { cwd: projectPath() })
-  else console.error('no .env.example file found')
-
-  return await isAppKeySet()
-}
-
-export async function installIfVersionMismatch() {
-  // const requiredBunVersion = '0.8.1'
-  // const installedBunVersion = process.version
-  // if (!semver.satisfies(installedBunVersion, requiredBunVersion)) {
-  //   log.warn(`Installed Bun version ${italic(installedBunVersion)} does not satisfy required version ${italic(requiredBunVersion)}. Adding it to your environment. One moment...`)
-  //   await runCommand(`tea +bun.sh${requiredBunVersion} >/dev/null 2>&1`)
-  // }
-}
-
-export async function frameworkVersion(): Promise<string> {
-  return (await storage.readPackageJson(frameworkPath('package.json'))).version
-}
-
-export async function isAppKeySet() {
-  const env = await storage.readTextFile('.env', projectPath())
-  const lines = env.data.split('\n')
-  const appKey = lines.find(line => line.startsWith('APP_KEY='))
-
-  return !!(appKey && appKey.length > 16)
-}
-
-/**
- * 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 []
-}
-
-/**
- * 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.
- */
-export 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 storage.readTextFile(projectPath('.env'))
-
-  await storage.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, options?: CliOptions): Promise<Result<Subprocess, Error>> {
-  const { data: manifest } = await storage.readJsonFile('package.json', frameworkPath())
-
-  // simple, yet effective check to see if the script exists
-  if (isManifest(manifest) && hasScript(manifest, script))
-    return await runCommand(`bun run ${script}`, options)
-
-  return err(handleError(`The ${script} script does not exist in the package.json file.`))
-}
-
-/**
- * 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
-}
-
-export function parseYaml(content: any) {
-  return parse(content)
-}
-
-/**
- * Determines the level of debugging.
- *
- * The debug level is determined by the following:
- * 1. The --verbose flag
- * 2. The debug property in the app configuration
- *
- * Currently, we don't support a custom debug level,
- * though, we would like to in the future.
- *
- * @param options
- */
-export function determineDebugLevel(options?: CliOptions) {
-  if (options?.verbose === true)
-    return true
-
-  return app.debug === true
-}
-
-export function isIpv6(address: AddressInfo): boolean {
-  return (
-    address.family === 'IPv6'
-    // in node >=18.0 <18.4 this was an integer value. This was changed in a minor version.
-    // See: https://github.com/laravel/vite-plugin/issues/103
-
-    // @ts-expect-error-next-line
-    || address.family === 6
-  )
-}
-
-export { dump as dumpYaml, load as loadYaml } from 'js-yaml'

package/src/index.ts

@@ -1,12 +0,0 @@
-export * from './clean'
-
-export * from './config'
-export * from './equal'
-export * from './export-size'
-export * from './find'
-export * from './git'
-export * from './hash'
-export * from './helpers'
-export * from './macroable'
-export * from './versions'
-export * from '@stacksjs/browser'

package/src/macroable.ts

@@ -1 +0,0 @@
-export { Macroable } from 'macroable'

package/src/utils.ts

@@ -1,15 +0,0 @@
-import { resolve } from '@stacksjs/path'
-import { fs } from '@stacksjs/storage'
-import { kebabCase } from '@stacksjs/strings'
-
-const ignore = ['readme-md']
-
-export const components = fs
-  .readdirSync(resolve(__dirname, './resources/components'))
-  .map(item => kebabCase(item.replace(/\.(stx|vue)/g, '')))
-  .filter(item => !ignore.includes(item))
-
-export const functions = fs
-  .readdirSync(resolve(__dirname, './resources/functions'))
-  .map(item => kebabCase(item.replace(/.ts/g, '')))
-  .filter(item => !ignore.includes(item))

package/src/versions.ts

@@ -1,6 +0,0 @@
-import { version } from '../package.json'
-
-// import { semver } from 'bun'
-
-export { version }
-// export { version, semver }