The pathResolver utility provides consistent path generation across KosmoJS's codebase.

Purpose

pathResolver solves two related path problems:

• Filesystem paths - Where files actually live on disk
• Import paths - How TypeScript imports reference those files (with ~, @, _ prefixes)

Usage

import { pathResolver } from "@kosmojs/core";

const { createPath, createImport } = pathResolver({
  appRoot: "/path/to/project",  // Optional: absolute project root
  sourceFolder: "front",         // Required: source folder name
});

Creating Filesystem Paths

Use createPath methods to generate filesystem paths:

// Source folder files
createPath.src("config.ts")            // → "src/front/config.ts"
createPath.api("users", "index.ts")    // → "src/front/api/users/index.ts"
createPath.pages("dashboard.tsx")      // → "src/front/pages/dashboard.tsx"

// Generated files (lib directory)
createPath.lib("types.ts")             // → "lib/src/front/types.ts"
createPath.libApi("routes.ts")         // → "lib/src/front/api/routes.ts"

Creating Import Paths

Use createImport methods to generate TypeScript import paths with proper prefixes:

// Source folder imports (@/ prefix)
createImport.src("config")             // → "@/front/config"
createImport.api("users/[id]")         // → "@/front/api/users/[id]"
createImport.pages("dashboard")        // → "@/front/pages/dashboard"

// Generated code imports (_/ prefix)
createImport.lib("types")              // → "_/front/types"
createImport.libApi("routes")          // → "_/front/api/routes"

Available Methods

createPath methods:

• coreApi(...paths) - Core API directory files
• src(...paths) - Source folder files
• api(...paths) - API route files
• pages(...paths) - Page component files
• config(...paths) - Configuration files
• entry(...paths) - Entry point files
• lib(...paths) - Generated files root
• libApi(...paths) - Generated API files
• libEntry(...paths) - Generated entry files
• libPages(...paths) - Generated page files

createImport methods:

• coreApi(...paths) - Core API imports with ~/ prefix
• src(...paths) - Source imports with @/ prefix
• config(...paths) - Config imports with @/ prefix
• api(...paths) - API imports with @/ prefix
• pages(...paths) - Page imports with @/ prefix
• lib(...paths) - Generated imports with _/ prefix
• libApi(...paths) - Generated API imports with _/ prefix
• libEntry(...paths) - Generated entry imports with _/ prefix

The resolver ensures your generator uses the same path conventions as KosmoJS built-in generators, maintaining consistency across the codebase.

Handlebars Integration

The createImportHelper method provides a Handlebars-ready helper for template generation. Register it through renderFactory:

import { pathResolver, renderFactory } from "@kosmojs/dev";

const { createPath, createImportHelper } = pathResolver({
  appRoot,
  sourceFolder,
});

const { render, renderToFile } = renderFactory({
  helpers: {
    createImport: createImportHelper,  // Register as "createImport" helper
  },
});

Now you can use it in Handlebars templates:

{{!-- Generate import paths in templates --}}
import { defineRoute } from "{{ createImport 'libApi' }}";
import config from "{{ createImport 'config' }}";

Which compiles to:

import { defineRoute } from "_/front/api";
import config from "@/front/config";

The helper automatically handles Handlebars' argument passing (Handlebars appends an options object as the last argument, which createImportHelper strips off before delegating to createImport).

Usage in templates:

{{createImport method ...paths}}

Where method is any createImport method name: "coreApi", "src", "api", "pages", "lib", "libApi" etc.