@stacksjs/path 0.59.11 → 0.61.0

package/dist/index.js

@@ -1,6 +1,5 @@
 // @bun
 // src/paths.ts
-import process from "process";
 import os from "os";
 import {
 basename,
@@ -16,6 +15,7 @@ resolve,
 sep,
 toNamespacedPath
 } from "path";
+import process from "process";
 import {runCommandSync} from "@stacksjs/cli";
 import {log} from "@stacksjs/logging";
 function actionsPath(path) {
@@ -27,6 +27,15 @@ function relativeActionsPath(path) {
 function userActionsPath(path) {
   return appPath(`Actions/${path || ""}`);
 }
+function userComponentsPath(path) {
+  return libsPath(`components/${path || ""}`);
+}
+function userViewsPath(path) {
+  return resourcesPath(`views/${path || ""}`);
+}
+function userFunctionsPath(path) {
+  return resourcesPath(`views/${path || ""}`);
+}
 function userJobsPath(path) {
   return appPath(`Jobs/${path || ""}`);
 }
@@ -42,6 +51,12 @@ function userModelsPath(path) {
 function userNotificationsPath(path) {
   return appPath(`Notifications/${path || ""}`);
 }
+function userDatabasePath(path) {
+  return projectPath(`database/${path || ""}`);
+}
+function userMigrationsPath(path) {
+  return userDatabasePath(`migrations/${path || ""}`);
+}
 function userEventsPath() {
   return appPath(`Events.ts`);
 }
@@ -84,6 +99,9 @@ function buildEnginePath(path) {
 function libsPath(path) {
   return frameworkPath(`libs/${path || ""}`);
 }
+function userLibsPath(path) {
+  return projectPath(`libs/${path || ""}`);
+}
 function libsEntriesPath(path) {
   return libsPath(`entries/${path || ""}`);
 }
@@ -109,7 +127,7 @@ function commandsPath(path) {
   return appPath(`Commands/${path || ""}`);
 }
 function componentsPath(path) {
-  return resourcesPath(`components/${path || ""}`);
+  return userLibsPath(`components/${path || ""}`);
 }
 function configPath(path) {
   return corePath(`config/${path || ""}`);
@@ -169,13 +187,13 @@ function healthPath(path) {
   return corePath(`health/${path || ""}`);
 }
 function functionsPath(path) {
-  return resourcesPath(`functions/${path || ""}`);
+  return userLibsPath(`functions/${path || ""}`);
 }
 function gitPath(path) {
   return corePath(`git/${path || ""}`);
 }
 function langPath(path) {
-  return projectPath(`lang/${path || ""}`);
+  return resourcesPath(`lang/${path || ""}`);
 }
 function layoutsPath(path, options) {
   const absolutePath = resourcesPath(`layouts/${path || ""}`);
@@ -192,9 +210,6 @@ function lintPath(path) {
 function listenersPath(path) {
   return appPath(`Listeners/${path || ""}`);
 }
-function eslintPath(path) {
-  return lintPath(`eslint/${path || ""}`);
-}
 function jobsPath(path) {
   return appPath(`Jobs/${path || ""}`);
 }
@@ -359,8 +374,11 @@ function utilsPath(path) {
 function validationPath(path) {
   return corePath(`validation/${path || ""}`);
 }
-function vitePath(path) {
-  return corePath(`vite/${path || ""}`);
+function viteConfigPath(path) {
+  return corePath(`vite-config/${path || ""}`);
+}
+function vitePluginPath(path) {
+  return corePath(`vite-plugin/${path || ""}`);
 }
 function xRayPath(path) {
   return frameworkPath(`stacks/x-ray/${path || ""}`);
@@ -371,6 +389,9 @@ function homeDir(path) {
 var path = {
   actionsPath,
   userActionsPath,
+  userComponentsPath,
+  userViewsPath,
+  userFunctionsPath,
   aiPath,
   assetsPath,
   relativeActionsPath,
@@ -416,10 +437,12 @@ var path = {
   langPath,
   layoutsPath,
   libsPath,
+  userLibsPath,
   libraryEntryPath,
   lintPath,
   listenersPath,
   loggingPath,
+  logsPath,
   jobsPath,
   modulesPath,
   ormPath,
@@ -461,6 +484,8 @@ var path = {
   tinkerPath,
   typesPath,
   uiPath,
+  userDatabasePath,
+  userMigrationsPath,
   userEventsPath,
   userJobsPath,
   userListenersPath,
@@ -469,7 +494,8 @@ var path = {
   userNotificationsPath,
   utilsPath,
   validationPath,
-  vitePath,
+  viteConfigPath,
+  vitePluginPath,
   xRayPath,
   homeDir,
   basename,
@@ -490,16 +516,23 @@ var path = {
 var src_default = path;
 export {
   xRayPath,
-  vitePath,
+  vitePluginPath,
+  viteConfigPath,
   viewsPath,
   validationPath,
   utilsPath,
+  userViewsPath,
   userNotificationsPath,
   userModelsPath,
+  userMigrationsPath,
   userMiddlewarePath,
   userListenersPath,
+  userLibsPath,
   userJobsPath,
+  userFunctionsPath,
   userEventsPath,
+  userDatabasePath,
+  userComponentsPath,
   userActionsPath,
   uiPath,
   typesPath,
@@ -572,7 +605,6 @@ export {
   extname,
   examplesPath,
   eventsPath,
-  eslintPath,
   errorHandlingPath,
   enumsPath,
   emailPath,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/path",
   "type": "module",
-  "version": "0.59.11",
+  "version": "0.61.0",
   "description": "The Stacks path.",
   "author": "Chris Breuer",
   "license": "MIT",

package/src/paths.ts

@@ -1,4 +1,3 @@
-import process from 'node:process'
 import os from 'node:os'
 import {
   basename,
@@ -14,6 +13,7 @@ import {
   sep,
   toNamespacedPath,
 } from 'node:path'
+import process from 'node:process'
 import { runCommandSync } from '@stacksjs/cli'
 import { log } from '@stacksjs/logging'
 
@@ -42,6 +42,18 @@ export function userActionsPath(path?: string) {
   return appPath(`Actions/${path || ''}`)
 }
 
+export function userComponentsPath(path?: string) {
+  return libsPath(`components/${path || ''}`)
+}
+
+export function userViewsPath(path?: string) {
+  return resourcesPath(`views/${path || ''}`)
+}
+
+export function userFunctionsPath(path?: string) {
+  return resourcesPath(`views/${path || ''}`)
+}
+
 /**
  * Returns the path to the user-defined `Jobs` directory.
  *
@@ -122,6 +134,14 @@ export function userNotificationsPath(path?: string) {
   return appPath(`Notifications/${path || ''}`)
 }
 
+export function userDatabasePath(path?: string) {
+  return projectPath(`database/${path || ''}`)
+}
+
+export function userMigrationsPath(path?: string) {
+  return userDatabasePath(`migrations/${path || ''}`)
+}
+
 /**
  * Returns the path to the user-defined `Events.ts` file.
  *
@@ -205,8 +225,7 @@ export function aliasPath() {
 export function buddyPath(path?: string, options?: { relative?: boolean }) {
   const absolutePath = corePath(`buddy/${path || ''}`)
 
-  if (options?.relative)
-    return relative(process.cwd(), absolutePath)
+  if (options?.relative) return relative(process.cwd(), absolutePath)
 
   return absolutePath
 }
@@ -327,6 +346,16 @@ export function libsPath(path?: string): string {
   return frameworkPath(`libs/${path || ''}`)
 }
 
+/**
+ * Returns the path to the user `libs` directory within the root project directory.
+ *
+ * @param path - The relative path to the file or directory within the `libs` directory.
+ * @returns The absolute path to the specified file or directory within the `libs` directory.
+ */
+export function userLibsPath(path?: string): string {
+  return projectPath(`libs/${path || ''}`)
+}
+
 /**
  * Returns the path to the `entries` directory within the `libs` directory.
  *
@@ -414,7 +443,7 @@ export function commandsPath(path?: string): string {
  * @returns The absolute path to the specified file or directory within the `components` directory.
  */
 export function componentsPath(path?: string): string {
-  return resourcesPath(`components/${path || ''}`)
+  return userLibsPath(`components/${path || ''}`)
 }
 
 /**
@@ -562,9 +591,7 @@ export function coreEnvPath(path?: string): string {
  * @param type - The type of examples to filter by ('vue-components' or 'web-components').
  * @returns The absolute path to the specified type of examples within the `examples` directory.
  */
-export function examplesPath(
-  type: 'vue-components' | 'web-components',
-): string {
+export function examplesPath(type: 'vue-components' | 'web-components'): string {
   return frameworkPath(`examples/${type || ''}`)
 }
 
@@ -587,14 +614,10 @@ export function fakerPath(path?: string): string {
  * @param options.cwd - Specifies a custom working directory.
  * @returns The absolute or relative path to the specified file or directory within the framework directory.
  */
-export function frameworkPath(
-  path?: string,
-  options?: { relative?: boolean, cwd?: string },
-): string {
+export function frameworkPath(path?: string, options?: { relative?: boolean; cwd?: string }): string {
   const absolutePath = projectStoragePath(`framework/${path || ''}`)
 
-  if (options?.relative)
-    return relative(options.cwd || process.cwd(), absolutePath)
+  if (options?.relative) return relative(options.cwd || process.cwd(), absolutePath)
 
   return absolutePath
 }
@@ -616,7 +639,7 @@ export function healthPath(path?: string): string {
  * @returns The absolute path to the specified file or directory within the `functions` directory.
  */
 export function functionsPath(path?: string): string {
-  return resourcesPath(`functions/${path || ''}`)
+  return userLibsPath(`functions/${path || ''}`)
 }
 
 /**
@@ -636,7 +659,7 @@ export function gitPath(path?: string): string {
  * @returns The absolute path to the specified file or directory within the lang directory.
  */
 export function langPath(path?: string): string {
-  return projectPath(`lang/${path || ''}`)
+  return resourcesPath(`lang/${path || ''}`)
 }
 
 /**
@@ -647,14 +670,10 @@ export function langPath(path?: string): string {
  * @param options.relative - If true, returns the path relative to the current working directory.
  * @returns The absolute or relative path to the specified file or directory within the `layouts` directory.
  */
-export function layoutsPath(
-  path?: string,
-  options?: { relative?: boolean },
-): string {
+export function layoutsPath(path?: string, options?: { relative?: boolean }): string {
   const absolutePath = resourcesPath(`layouts/${path || ''}`)
 
-  if (options?.relative)
-    return relative(process.cwd(), absolutePath)
+  if (options?.relative) return relative(process.cwd(), absolutePath)
 
   return absolutePath
 }
@@ -690,16 +709,6 @@ export function listenersPath(path?: string): string {
   return appPath(`Listeners/${path || ''}`)
 }
 
-/**
- * Returns the path to the `eslint` directory within the lint directory.
- *
- * @param path - The relative path to the file or directory within the eslint directory.
- * @returns The absolute path to the specified file or directory within the eslint directory.
- */
-export function eslintPath(path?: string): string {
-  return lintPath(`eslint/${path || ''}`)
-}
-
 /**
  * Returns the path to the `jobs` directory within the app directory.
  *
@@ -796,14 +805,10 @@ export function onboardingPath(path?: string): string {
  * @param type - The type of the library ('vue-components', 'web-components', or 'functions') for which to return the package.json path.
  * @returns The absolute path to the specified package.json file within the framework directory.
  */
-export function packageJsonPath(
-  type: 'vue-components' | 'web-components' | 'functions',
-): string {
-  if (type === 'vue-components')
-    return frameworkPath('libs/components/vue/package.json')
+export function packageJsonPath(type: 'vue-components' | 'web-components' | 'functions'): string {
+  if (type === 'vue-components') return frameworkPath('libs/components/vue/package.json')
 
-  if (type === 'web-components')
-    return frameworkPath('libs/components/web/package.json')
+  if (type === 'web-components') return frameworkPath('libs/components/web/package.json')
 
   return frameworkPath(`libs/${type}/package.json`)
 }
@@ -852,8 +857,7 @@ export function projectPath(filePath = '', options?: { relative: boolean }): str
   const finalPath = resolve(path, filePath)
 
   // If the `relative` option is true, return the path relative to the current working directory
-  if (options?.relative)
-    return relative(process.cwd(), finalPath)
+  if (options?.relative) return relative(process.cwd(), finalPath)
 
   return finalPath
 }
@@ -879,8 +883,7 @@ export async function findProjectPath(project: string): Promise<string> {
   // since we are targeting a specific project, find its path
   const projectPath = projects.find((proj: string) => proj.includes(project))
 
-  if (!projectPath)
-    throw new Error(`Could not find project with name: ${project}`)
+  if (!projectPath) throw new Error(`Could not find project with name: ${project}`)
 
   return projectPath.startsWith('/') ? projectPath : `/${projectPath}`
 }
@@ -966,8 +969,7 @@ export function realtimePath(path?: string) {
 export function resourcesPath(path?: string, options?: { relative?: boolean }) {
   const absolutePath = projectStoragePath(`resources/${path || ''}`)
 
-  if (options?.relative)
-    return relative(process.cwd(), absolutePath)
+  if (options?.relative) return relative(process.cwd(), absolutePath)
 
   return projectPath(`resources/${path || ''}`)
 }
@@ -1003,8 +1005,7 @@ export function routerPath(path?: string) {
 export function routesPath(path?: string, options?: { relative?: boolean }) {
   const absolutePath = resourcesPath(`routes/${path || ''}`)
 
-  if (options?.relative)
-    return relative(process.cwd(), absolutePath)
+  if (options?.relative) return relative(process.cwd(), absolutePath)
 
   return projectPath(`routes/${path || ''}`)
 }
@@ -1220,13 +1221,23 @@ export function validationPath(path?: string) {
 }
 
 /**
- * Returns the path to the `vite` directory within the core directory.
+ * Returns the path to the `vite-config` directory within the core directory.
+ *
+ * @param path - The relative path to the file or directory within the vite-config directory.
+ * @returns The absolute path to the specified file or directory within the vite-config directory.
+ */
+export function viteConfigPath(path?: string) {
+  return corePath(`vite-config/${path || ''}`)
+}
+
+/**
+ * Returns the path to the `vite-plugin` directory within the core directory.
  *
  * @param path - The relative path to the file or directory within the vite directory.
  * @returns The absolute path to the specified file or directory within the vite directory.
  */
-export function vitePath(path?: string) {
-  return corePath(`vite/${path || ''}`)
+export function vitePluginPath(path?: string) {
+  return corePath(`vite-plugin/${path || ''}`)
 }
 
 /**
@@ -1252,6 +1263,9 @@ export function homeDir(path?: string) {
 export const path = {
   actionsPath,
   userActionsPath,
+  userComponentsPath,
+  userViewsPath,
+  userFunctionsPath,
   aiPath,
   assetsPath,
   relativeActionsPath,
@@ -1297,10 +1311,12 @@ export const path = {
   langPath,
   layoutsPath,
   libsPath,
+  userLibsPath,
   libraryEntryPath,
   lintPath,
   listenersPath,
   loggingPath,
+  logsPath,
   jobsPath,
   modulesPath,
   ormPath,
@@ -1342,6 +1358,8 @@ export const path = {
   tinkerPath,
   typesPath,
   uiPath,
+  userDatabasePath,
+  userMigrationsPath,
   userEventsPath,
   userJobsPath,
   userListenersPath,
@@ -1350,7 +1368,8 @@ export const path = {
   userNotificationsPath,
   utilsPath,
   validationPath,
-  vitePath,
+  viteConfigPath,
+  vitePluginPath,
   xRayPath,
   homeDir,
 
@@ -1369,16 +1388,4 @@ export const path = {
   toNamespacedPath,
 }
 
-export {
-  basename,
-  delimiter,
-  dirname,
-  extname,
-  isAbsolute,
-  join,
-  normalize,
-  relative,
-  resolve,
-  sep,
-  toNamespacedPath,
-}
+export { basename, delimiter, dirname, extname, isAbsolute, join, normalize, relative, resolve, sep, toNamespacedPath }

package/dist/index.d.ts

@@ -1,3 +0,0 @@
-import { path } from './paths';
-export * from './paths';
-export default path;