polen 0.11.0-next.15 → 0.11.0-next.17

package/src/api/typings/typings.ts

@@ -0,0 +1,273 @@
+import type { Config } from '#api/config/normalized'
+import { FileSystem } from '@effect/platform'
+import { Effect } from 'effect'
+import * as Path from 'node:path'
+
+// ============================================================================
+// Types
+// ============================================================================
+
+export interface TypeDefinition {
+  /**
+   * The name of the type definition file (without .d.ts extension).
+   * Will be placed under @types/polen-generated/{name}.d.ts
+   */
+  name: string
+  /**
+   * The TypeScript type definition content.
+   */
+  content: string
+}
+
+export interface WriterOptions {
+  /**
+   * The root directory where node_modules exists.
+   * Usually the project root.
+   */
+  projectRoot: string
+}
+
+export interface WriterOptionsWithConfig {
+  /**
+   * The normalized Polen configuration.
+   * The generated types path will be extracted from config.paths.framework.generatedTypes
+   */
+  config: Config
+}
+
+// ============================================================================
+// Paths
+// ============================================================================
+
+export const relativePathGeneratedTypesDir = 'node_modules/@types/polen-generated'
+
+/**
+ * Get the output directory for generated type definitions.
+ */
+export const getGeneratedTypesDir = (projectRoot: string): string => {
+  return Path.join(projectRoot, relativePathGeneratedTypesDir)
+}
+
+/**
+ * Get the full path for a generated type definition file.
+ */
+export const getGeneratedTypePath = (projectRoot: string, name: string): string => {
+  return Path.join(getGeneratedTypesDir(projectRoot), `${name}.d.ts`)
+}
+
+// ============================================================================
+// Package Structure
+// ============================================================================
+
+/**
+ * Ensure the package structure exists for @types/polen-generated.
+ * Creates package.json and index.d.ts if they don't exist.
+ */
+const ensurePackageStructure = (
+  options: WriterOptions,
+): Effect.Effect<void, Error, FileSystem.FileSystem> => {
+  const outputDir = getGeneratedTypesDir(options.projectRoot)
+  const packageJsonPath = Path.join(outputDir, 'package.json')
+  const indexPath = Path.join(outputDir, 'index.d.ts')
+
+  return Effect.gen(function*() {
+    const fs = yield* FileSystem.FileSystem
+
+    // Ensure output directory exists
+    yield* fs.makeDirectory(outputDir, { recursive: true })
+
+    // Check if package.json exists
+    const packageJsonExists = yield* fs.exists(packageJsonPath)
+
+    if (!packageJsonExists) {
+      const packageJson = {
+        name: '@types/polen-generated',
+        version: '0.0.0',
+        type: 'module',
+        exports: {
+          '.': {
+            import: './index.d.ts',
+          },
+        },
+      }
+      yield* fs.writeFileString(packageJsonPath, JSON.stringify(packageJson, null, 2))
+    }
+
+    // Check if index.d.ts exists
+    const indexExists = yield* fs.exists(indexPath)
+
+    if (!indexExists) {
+      const indexContent = `// Auto-generated index file for @types/polen-generated
+// This file is automatically managed by Polen
+// Do not edit this file directly
+
+// This file exists to satisfy TypeScript's module resolution
+// Individual type definition files are placed alongside this index
+export {}
+`
+      yield* fs.writeFileString(indexPath, indexContent)
+    }
+  })
+}
+
+// ============================================================================
+// Writer
+// ============================================================================
+
+/**
+ * Write a TypeScript type definition to the generated types directory.
+ *
+ * @example
+ * ```ts
+ * await Effect.runPromise(
+ *   Typings.write(
+ *     { name: 'config.examples', content: 'declare global { ... }' },
+ *     { projectRoot: '/path/to/project' }
+ *   ).pipe(Effect.provide(FileSystem.layer))
+ * )
+ * ```
+ */
+export const write = (
+  definition: TypeDefinition,
+  options: WriterOptions,
+): Effect.Effect<void, Error, FileSystem.FileSystem> => {
+  const outputDir = getGeneratedTypesDir(options.projectRoot)
+  const outputFile = getGeneratedTypePath(options.projectRoot, definition.name)
+
+  return Effect.gen(function*() {
+    const fs = yield* FileSystem.FileSystem
+
+    // Ensure package structure exists (package.json and index.d.ts)
+    yield* ensurePackageStructure(options)
+
+    // Write the type definition file
+    yield* fs.writeFileString(outputFile, definition.content)
+  })
+}
+
+/**
+ * Write multiple TypeScript type definitions.
+ */
+export const writeMany = (
+  definitions: TypeDefinition[],
+  options: WriterOptions,
+): Effect.Effect<void, Error, FileSystem.FileSystem> => {
+  return Effect.gen(function*() {
+    // Ensure package structure once before writing all definitions
+    yield* ensurePackageStructure(options)
+
+    // Write all definitions without re-checking package structure
+    const fs = yield* FileSystem.FileSystem
+
+    for (const definition of definitions) {
+      const outputFile = getGeneratedTypePath(options.projectRoot, definition.name)
+      yield* fs.writeFileString(outputFile, definition.content)
+    }
+  })
+}
+
+/**
+ * Remove a generated type definition file.
+ */
+export const remove = (
+  name: string,
+  options: WriterOptions,
+): Effect.Effect<void, Error, FileSystem.FileSystem> => {
+  const outputFile = getGeneratedTypePath(options.projectRoot, name)
+
+  return Effect.gen(function*() {
+    const fs = yield* FileSystem.FileSystem
+
+    // Try to remove the file, ignore if it doesn't exist
+    yield* fs.remove(outputFile).pipe(
+      Effect.catchIf(
+        error => (error as any).code === 'ENOENT',
+        () => Effect.void,
+      ),
+    )
+  })
+}
+
+/**
+ * Clear all generated type definitions.
+ */
+export const clear = (
+  options: WriterOptions,
+): Effect.Effect<void, Error, FileSystem.FileSystem> => {
+  const outputDir = getGeneratedTypesDir(options.projectRoot)
+
+  return Effect.gen(function*() {
+    const fs = yield* FileSystem.FileSystem
+
+    // Try to remove the directory, ignore if it doesn't exist
+    yield* fs.remove(outputDir, { recursive: true }).pipe(
+      Effect.catchIf(
+        error => (error as any).code === 'ENOENT',
+        () => Effect.void,
+      ),
+    )
+  })
+}
+
+// ============================================================================
+// Type Definition Builders
+// ============================================================================
+
+/**
+ * Create a global namespace augmentation type definition.
+ *
+ * @example
+ * ```ts
+ * const typeDef = Typings.createGlobalAugmentation(
+ *   'interface Examples { readonly names: readonly ["example1", "example2"] }',
+ *   'Example type definitions'
+ * )
+ * ```
+ */
+export const createGlobalAugmentation = (
+  content: string,
+  header?: string,
+): string => {
+  const headerComment = header
+    ? `// ${header}\n// This file is auto-generated by Polen\n// Do not edit this file directly\n\n`
+    : `// This file is auto-generated by Polen\n// Do not edit this file directly\n\n`
+
+  return `${headerComment}declare global {
+  namespace PolenGlobal {
+    ${content.split('\n').join('\n    ')}
+  }
+}
+
+// Ensure the file is treated as a module
+export {}
+`
+}
+
+/**
+ * Create a module augmentation type definition.
+ *
+ * @example
+ * ```ts
+ * const typeDef = Typings.createModuleAugmentation(
+ *   '#api/examples/config',
+ *   'export type AvailableExampleNames = Polen.AvailableExampleNames'
+ * )
+ * ```
+ */
+export const createModuleAugmentation = (
+  modulePath: string,
+  content: string,
+  header?: string,
+): string => {
+  const headerComment = header
+    ? `// ${header}\n// This file is auto-generated by Polen\n// Do not edit this file directly\n\n`
+    : `// This file is auto-generated by Polen\n// Do not edit this file directly\n\n`
+
+  return `${headerComment}declare module '${modulePath}' {
+  ${content.split('\n').join('\n  ')}
+}
+
+// Ensure the file is treated as a module
+export {}
+`
+}

package/src/cli/_/parameters.ts

@@ -1,17 +1,17 @@
-import { z } from 'zod'
+import { Args, Options } from '@effect/cli'
 
 /**
- * Common parameter schemas for CLI commands
+ * Common parameter schemas for Effect CLI commands
  */
 
-export const projectParameter = z
-  .string()
-  .optional()
-  .describe(`The path to the project directory. Default is CWD (current working directory).`)
+export const projectParameter = Args.text({ name: 'project' }).pipe(
+  Args.optional,
+  Args.withDescription('The path to the project directory. Default is CWD (current working directory).'),
+)
 
-export const allowGlobalParameter = z
-  .boolean()
-  .optional()
-  .describe(
-    `Allow using global Polen in a project with local Polen. Not recommended as it can cause version conflicts.`,
-  )
+export const allowGlobalParameter = Options.boolean('allow-global').pipe(
+  Options.optional,
+  Options.withDescription(
+    'Allow using global Polen in a project with local Polen. Not recommended as it can cause version conflicts.',
+  ),
+)

package/src/cli/commands/build.ts

@@ -1,75 +1,66 @@
-// @ts-nocheck
-import { Api } from '#api/index'
-import { allowGlobalParameter, projectParameter } from '#cli/_/parameters'
+import { Api } from '#api/$'
 import { ensureOptionalAbsoluteWithCwd } from '#lib/kit-temp'
-import * as NodeFileSystem from '@effect/platform-node/NodeFileSystem'
-import { Command } from '@molt/command'
-import { Effect } from 'effect'
-import { z } from 'zod'
+import { Command, Options } from '@effect/cli'
+import { Effect, Option } from 'effect'
+import { allowGlobalParameter, projectParameter } from '../_/parameters.js'
 
-// todo remove these inline defs once using effect cli instead of molt
-export const BuildArchitectureEnum = {
-  ssg: `ssg`,
-  spa: `spa`,
-  ssr: `ssr`,
-} as const
+// Define all the options exactly matching the original
+const debug = Options.boolean('debug').pipe(
+  Options.withAlias('d'),
+  Options.withDefault(false),
+  Options.withDescription('Enable debug mode'),
+)
 
-export const BuildArchitecture = z.nativeEnum(BuildArchitectureEnum)
+const architecture = Options.choice('architecture', ['ssg', 'ssr']).pipe(
+  Options.withAlias('a'),
+  Options.withDefault('ssg' as const),
+  Options.withDescription('Which kind of application architecture to output.'),
+)
 
-const args = Command.create()
-  .parameter(`--debug -d`, z.boolean().default(false))
-  .parameter(
-    `--project -p`,
-    projectParameter,
-  )
-  .parameter(
-    `--architecture -a`,
-    BuildArchitecture.default('ssg').describe('Which kind of application architecture to output.'),
-  )
-  .parameter(
-    `--base -b`,
-    z.string().optional().describe('Base public path for deployment (e.g., /my-project/)'),
-  )
-  .parameter(
-    `--port`,
-    z.number().optional().describe('Default port for the SSR application'),
-  )
-  .parameter(`--allow-global`, allowGlobalParameter)
-  .settings({
-    parameters: {
-      environment: {
-        $default: {
-          // todo prfix seting doesn't seem to work with Molt!
-          prefix: `POLEN_CREATE_`,
-          enabled: false,
-        },
-      },
-    },
-  })
-  .parse()
+const base = Options.text('base').pipe(
+  Options.withAlias('b'),
+  Options.optional,
+  Options.withDescription('Base public path for deployment (e.g., /my-project/)'),
+)
 
-const dir = ensureOptionalAbsoluteWithCwd(args.project)
+const port = Options.integer('port').pipe(
+  Options.optional,
+  Options.withDescription('Default port for the SSR application'),
+)
+
+export const build = Command.make(
+  'build',
+  {
+    debug,
+    project: projectParameter,
+    architecture,
+    base,
+    port,
+    allowGlobal: allowGlobalParameter,
+  },
+  ({ debug, project, architecture, base, port, allowGlobal }) =>
+    Effect.gen(function*() {
+      const dir = ensureOptionalAbsoluteWithCwd(Option.getOrUndefined(project))
 
-if (!await Api.Project.validateProjectDirectory(dir)) {
-  process.exit(1)
-}
+      const isValidProject = yield* Effect.promise(() => Api.Project.validateProjectDirectory(dir))
+      if (!isValidProject) {
+        return yield* Effect.fail(new Error('Invalid project directory'))
+      }
 
-await Effect.runPromise(
-  Api.Builder.build({
-    dir,
-    overrides: {
-      build: {
-        architecture: args.architecture,
-        base: args.base,
-      },
-      server: {
-        port: args.port,
-      },
-      advanced: {
-        debug: args.debug,
-      },
-    },
-  }).pipe(
-    Effect.provide(NodeFileSystem.layer),
-  ),
+      yield* Api.Builder.build({
+        dir,
+        overrides: {
+          build: {
+            architecture,
+            base: Option.getOrUndefined(base),
+          },
+          server: {
+            port: Option.getOrUndefined(port),
+          },
+          advanced: {
+            debug,
+          },
+        },
+      })
+    }),
 )

package/src/cli/commands/cache/delete.ts

@@ -1,28 +1,21 @@
-import { Api } from '#api/index'
-import { allowGlobalParameter, projectParameter } from '#cli/_/parameters'
+import { Api } from '#api/$'
 import { ensureOptionalAbsoluteWithCwd } from '#lib/kit-temp'
-import { Command } from '@molt/command'
+import { Command } from '@effect/cli'
 import consola from 'consola'
+import { Effect, Option } from 'effect'
+import { allowGlobalParameter, projectParameter } from '../../_/parameters.js'
 
-const args = Command.create()
-  .parameter(
-    `--project -p`,
-    projectParameter,
-  )
-  .parameter(`--allow-global`, allowGlobalParameter)
-  .settings({
-    parameters: {
-      environment: {
-        $default: {
-          prefix: `POLEN_CACHE_`,
-          enabled: false,
-        },
-      },
-    },
-  })
-  .parse()
+export const cacheDelete = Command.make(
+  'delete',
+  {
+    project: projectParameter,
+    allowGlobal: allowGlobalParameter,
+  },
+  ({ project, allowGlobal }) =>
+    Effect.gen(function*() {
+      const dir = ensureOptionalAbsoluteWithCwd(Option.getOrUndefined(project))
 
-const dir = ensureOptionalAbsoluteWithCwd(args.project)
-
-await Api.Cache.deleteAll(dir)
-consola.success(`Polen caches deleted`)
+      yield* Effect.promise(() => Api.Cache.deleteAll(dir))
+      consola.success('Polen caches deleted')
+    }),
+)

package/src/cli/commands/cache/show.ts

@@ -1,25 +1,13 @@
-import { Api } from '#api/index'
-import { allowGlobalParameter } from '#cli/_/parameters'
-import { Command } from '@molt/command'
-import { z } from 'zod'
-
-const args = Command.create()
-  .parameter(
-    `--depth -d`,
-    z.number().min(0).max(5).default(2).describe(`Maximum depth for directory tree display`),
-  )
-  .parameter(`--allow-global`, allowGlobalParameter)
-  .settings({
-    parameters: {
-      environment: {
-        $default: {
-          prefix: `POLEN_CACHE_`,
-          enabled: false,
-        },
-      },
-    },
-  })
-  .parse()
+import { Api } from '#api/$'
+import { Command, Options } from '@effect/cli'
+import { Effect } from 'effect'
+import { allowGlobalParameter } from '../../_/parameters.js'
+
+const depth = Options.integer('depth').pipe(
+  Options.withAlias('d'),
+  Options.withDefault(2),
+  Options.withDescription('Maximum depth for directory tree display'),
+)
 
 // Helper to format bytes
 const formatBytes = (bytes: number): string => {
@@ -30,16 +18,16 @@ const formatBytes = (bytes: number): string => {
 }
 
 // Helper to render directory tree
-const renderTree = (nodes: Api.Cache.TreeNode[], prefix = ``, isLast = true): string[] => {
+const renderTree = (nodes: Api.Cache.TreeNode[], prefix = '', isLast = true): string[] => {
   const lines: string[] = []
 
   nodes.forEach((node, index) => {
     const isLastNode = index === nodes.length - 1
-    const connector = isLastNode ? `└─` : `├─`
-    const extension = isLastNode ? `  ` : `│ `
+    const connector = isLastNode ? '└─' : '├─'
+    const extension = isLastNode ? '  ' : '│ '
 
     let line = `${prefix}${connector} ${node.name}`
-    if (node.type === `file` && node.size !== undefined) {
+    if (node.type === 'file' && node.size !== undefined) {
       line += ` (${formatBytes(node.size)})`
     }
     lines.push(line)
@@ -53,49 +41,59 @@ const renderTree = (nodes: Api.Cache.TreeNode[], prefix = ``, isLast = true): st
   return lines
 }
 
-// Get cache info
-const info = await Api.Cache.info({ depth: args.depth })
-
-console.log(`Root: ${info.rootPath}`)
-console.log()
-
-// Development assets
-console.log(`Development assets: ${info.developmentAssets.path.replace(info.rootPath + `/`, ``)}`)
-if (info.developmentAssets.exists) {
-  const size = info.developmentAssets.size ? ` (${formatBytes(info.developmentAssets.size)})` : ``
-  console.log(`  Status: exists${size}`)
-
-  if (info.developmentAssets.tree && info.developmentAssets.tree.length > 0) {
-    console.log(`  Contents:`)
-    const treeLines = renderTree(info.developmentAssets.tree, `    `)
-    treeLines.forEach(line => console.log(line))
-  }
-} else {
-  console.log(`  Status: empty`)
-}
-
-console.log()
-
-// Vite cache
-console.log(`Vite:`)
-if (info.vite.exists) {
-  const size = info.vite.size ? ` (${formatBytes(info.vite.size)})` : ``
-  console.log(`  Status: exists${size}`)
-
-  if (info.vite.optimizedDependencies && info.vite.optimizedDependencies.length > 0) {
-    const deps = info.vite.optimizedDependencies
-    const showing = Math.min(10, deps.length)
-    const more = deps.length - showing
-
-    console.log(`  Optimized dependencies (${deps.length}):`)
-    deps.slice(0, showing).forEach(dep => {
-      console.log(`    ${dep.name} (${formatBytes(dep.size)})`)
-    })
-
-    if (more > 0) {
-      console.log(`    ... (${more} more)`)
-    }
-  }
-} else {
-  console.log(`  Status: empty`)
-}
+export const cacheShow = Command.make(
+  'show',
+  {
+    depth,
+    allowGlobal: allowGlobalParameter,
+  },
+  ({ depth, allowGlobal }) =>
+    Effect.gen(function*() {
+      // Get cache info
+      const info = yield* Effect.promise(() => Api.Cache.info({ depth }))
+
+      console.log(`Root: ${info.rootPath}`)
+      console.log()
+
+      // Development assets
+      console.log(`Development assets: ${info.developmentAssets.path.replace(info.rootPath + '/', '')}`)
+      if (info.developmentAssets.exists) {
+        const size = info.developmentAssets.size ? ` (${formatBytes(info.developmentAssets.size)})` : ''
+        console.log(`  Status: exists${size}`)
+
+        if (info.developmentAssets.tree && info.developmentAssets.tree.length > 0) {
+          console.log('  Contents:')
+          const treeLines = renderTree(info.developmentAssets.tree, '    ')
+          treeLines.forEach(line => console.log(line))
+        }
+      } else {
+        console.log('  Status: empty')
+      }
+
+      console.log()
+
+      // Vite cache
+      console.log('Vite:')
+      if (info.vite.exists) {
+        const size = info.vite.size ? ` (${formatBytes(info.vite.size)})` : ''
+        console.log(`  Status: exists${size}`)
+
+        if (info.vite.optimizedDependencies && info.vite.optimizedDependencies.length > 0) {
+          const deps = info.vite.optimizedDependencies
+          const showing = Math.min(10, deps.length)
+          const more = deps.length - showing
+
+          console.log(`  Optimized dependencies (${deps.length}):`)
+          deps.slice(0, showing).forEach(dep => {
+            console.log(`    ${dep.name} (${formatBytes(dep.size)})`)
+          })
+
+          if (more > 0) {
+            console.log(`    ... (${more} more)`)
+          }
+        }
+      } else {
+        console.log('  Status: empty')
+      }
+    }),
+)

package/src/cli/commands/cache.ts

@@ -1,9 +1,27 @@
-#!/usr/bin/env node
+import { Command } from '@effect/cli'
+import { Console, Effect } from 'effect'
 
-import { Cli, Path } from '@wollybeard/kit'
+// Import subcommands
+import { cacheDelete } from './cache/delete.js'
+import { cacheShow } from './cache/show.js'
 
-// Remove the "cache" argument before dispatching to subcommands
-process.argv = process.argv.slice(0, 2).concat(process.argv.slice(3))
+// Default cache command that shows usage
+const cacheDefault = Command.make(
+  'cache',
+  {},
+  () =>
+    Effect.gen(function*() {
+      yield* Console.error(`Usage: polen cache <command>
 
-const commandsDir = Path.join(import.meta.dirname, `cache`)
-await Cli.dispatch(commandsDir)
+Commands:
+  delete    Delete all Polen-generated caches
+  show      Display information about Polen caches
+`)
+      return yield* Effect.fail(new Error('No cache subcommand specified'))
+    }),
+)
+
+// Export the cache command with subcommands
+export const cache = cacheDefault.pipe(
+  Command.withSubcommands([cacheDelete, cacheShow]),
+)