mdcontext 0.1.0 → 0.2.0

package/src/config/file-provider.ts

@@ -0,0 +1,273 @@
+/**
+ * File-based ConfigProvider
+ *
+ * Creates a custom ConfigProvider that reads from config files:
+ * - mdcontext.config.ts (TypeScript - dynamic import)
+ * - mdcontext.config.js (JavaScript - dynamic import)
+ * - mdcontext.config.json (JSON - file read)
+ * - .mdcontextrc (JSON - file read)
+ * - .mdcontextrc.json (JSON - file read)
+ *
+ * ## Usage
+ *
+ * ```typescript
+ * import { loadConfigFile, createFileConfigProvider } from './config/file-provider.js'
+ * import { Effect, ConfigProvider } from 'effect'
+ *
+ * // Load config and create provider
+ * const result = await loadConfigFile('/path/to/project')
+ * if (result.found) {
+ *   const provider = createFileConfigProvider(result.config)
+ *   // Use with Effect.withConfigProvider
+ * }
+ * ```
+ */
+
+import * as fs from 'node:fs'
+import * as path from 'node:path'
+import { ConfigProvider, Effect } from 'effect'
+import { ConfigError } from '../errors/index.js'
+import type { PartialMdContextConfig } from './service.js'
+
+// ============================================================================
+// Types
+// ============================================================================
+
+/**
+ * Supported config file names in order of precedence
+ */
+export const CONFIG_FILE_NAMES = [
+  'mdcontext.config.ts',
+  'mdcontext.config.js',
+  'mdcontext.config.mjs',
+  'mdcontext.config.json',
+  '.mdcontextrc',
+  '.mdcontextrc.json',
+] as const
+
+export type ConfigFileName = (typeof CONFIG_FILE_NAMES)[number]
+
+/**
+ * Result of loading a config file
+ */
+export type LoadConfigResult =
+  | { found: true; path: string; config: PartialMdContextConfig }
+  | { found: false; searched: string[] }
+
+/**
+ * Config file format
+ */
+export type ConfigFileFormat = 'ts' | 'js' | 'json'
+
+// ============================================================================
+// File Detection
+// ============================================================================
+
+/**
+ * Find a config file starting from the given directory.
+ * Searches up the directory tree until a config file is found or root is reached.
+ *
+ * @param startDir - Directory to start searching from
+ * @returns The path to the config file if found, or null
+ */
+export const findConfigFile = (
+  startDir: string,
+): { path: string; format: ConfigFileFormat } | null => {
+  let currentDir = path.resolve(startDir)
+  const root = path.parse(currentDir).root
+
+  while (currentDir !== root) {
+    for (const fileName of CONFIG_FILE_NAMES) {
+      const configPath = path.join(currentDir, fileName)
+      if (fs.existsSync(configPath)) {
+        const format = getConfigFormat(fileName)
+        return { path: configPath, format }
+      }
+    }
+    const parentDir = path.dirname(currentDir)
+    if (parentDir === currentDir) break
+    currentDir = parentDir
+  }
+
+  return null
+}
+
+/**
+ * Get the format of a config file based on its name
+ */
+const getConfigFormat = (fileName: string): ConfigFileFormat => {
+  if (fileName.endsWith('.ts')) return 'ts'
+  if (fileName.endsWith('.js') || fileName.endsWith('.mjs')) return 'js'
+  return 'json'
+}
+
+// ============================================================================
+// File Loading
+// ============================================================================
+
+/**
+ * Load configuration from a JSON file
+ */
+const loadJsonConfig = (
+  filePath: string,
+): Effect.Effect<PartialMdContextConfig, ConfigError> =>
+  Effect.try({
+    try: () => {
+      const content = fs.readFileSync(filePath, 'utf-8')
+      return JSON.parse(content) as PartialMdContextConfig
+    },
+    catch: (error) =>
+      new ConfigError({
+        field: 'configFile',
+        message: `Failed to load config from ${filePath}: ${error instanceof Error ? error.message : String(error)}`,
+        cause: error,
+      }),
+  })
+
+/**
+ * Load configuration from a JavaScript/TypeScript file using dynamic import
+ */
+const loadJsConfig = (
+  filePath: string,
+): Effect.Effect<PartialMdContextConfig, ConfigError> =>
+  Effect.tryPromise({
+    try: async () => {
+      // Convert to file URL for dynamic import
+      const fileUrl = `file://${filePath}`
+      const module = await import(fileUrl)
+      // Support both default export and named 'config' export
+      const config = module.default ?? module.config
+      if (!config || typeof config !== 'object') {
+        throw new Error(
+          'Config file must export a default object or named "config" export',
+        )
+      }
+      return config as PartialMdContextConfig
+    },
+    catch: (error) =>
+      new ConfigError({
+        field: 'configFile',
+        message: `Failed to load config from ${filePath}: ${error instanceof Error ? error.message : String(error)}`,
+        cause: error,
+      }),
+  })
+
+/**
+ * Load configuration from a file based on its format
+ */
+export const loadConfigFromFile = (
+  filePath: string,
+  format: ConfigFileFormat,
+): Effect.Effect<PartialMdContextConfig, ConfigError> => {
+  switch (format) {
+    case 'json':
+      return loadJsonConfig(filePath)
+    case 'ts':
+    case 'js':
+      return loadJsConfig(filePath)
+  }
+}
+
+/**
+ * Search for and load a config file starting from the given directory.
+ *
+ * @param startDir - Directory to start searching from
+ * @returns LoadConfigResult indicating whether a config was found
+ */
+export const loadConfigFile = (
+  startDir: string,
+): Effect.Effect<LoadConfigResult, ConfigError> =>
+  Effect.gen(function* () {
+    const found = findConfigFile(startDir)
+
+    if (!found) {
+      return {
+        found: false,
+        searched: CONFIG_FILE_NAMES.map((name) => path.join(startDir, name)),
+      } as LoadConfigResult
+    }
+
+    const config = yield* loadConfigFromFile(found.path, found.format)
+
+    return {
+      found: true,
+      path: found.path,
+      config,
+    } as LoadConfigResult
+  })
+
+/**
+ * Load a config file from a specific path (not searching up directories)
+ *
+ * @param configPath - Explicit path to the config file
+ * @returns The loaded configuration
+ */
+export const loadConfigFromPath = (
+  configPath: string,
+): Effect.Effect<PartialMdContextConfig, ConfigError> =>
+  Effect.gen(function* () {
+    const resolvedPath = path.resolve(configPath)
+
+    if (!fs.existsSync(resolvedPath)) {
+      return yield* Effect.fail(
+        new ConfigError({
+          field: 'configFile',
+          message: `Config file not found: ${resolvedPath}`,
+        }),
+      )
+    }
+
+    const format = getConfigFormat(path.basename(configPath))
+    return yield* loadConfigFromFile(resolvedPath, format)
+  })
+
+// ============================================================================
+// ConfigProvider Creation
+// ============================================================================
+
+/**
+ * Create a ConfigProvider from a partial configuration object.
+ *
+ * The provider uses ConfigProvider.fromJson to map the nested config
+ * structure to Effect's config namespace.
+ *
+ * @param config - Partial configuration object
+ * @returns A ConfigProvider that provides the config values
+ */
+export const createFileConfigProvider = (
+  config: PartialMdContextConfig,
+): ConfigProvider.ConfigProvider => ConfigProvider.fromJson(config)
+
+/**
+ * Load config file and create a ConfigProvider in one step.
+ *
+ * If no config file is found, returns a ConfigProvider that provides no values
+ * (Effect will use defaults from the Config schema).
+ *
+ * @param startDir - Directory to start searching for config files
+ * @returns Effect yielding a ConfigProvider
+ */
+export const loadFileConfigProvider = (
+  startDir: string,
+): Effect.Effect<ConfigProvider.ConfigProvider, ConfigError> =>
+  Effect.gen(function* () {
+    const result = yield* loadConfigFile(startDir)
+
+    if (!result.found) {
+      // Return empty provider - defaults will be used
+      return ConfigProvider.fromMap(new Map())
+    }
+
+    return createFileConfigProvider(result.config)
+  })
+
+/**
+ * Load config from a specific file and create a ConfigProvider.
+ *
+ * @param configPath - Path to the config file
+ * @returns Effect yielding a ConfigProvider
+ */
+export const loadFileConfigProviderFromPath = (
+  configPath: string,
+): Effect.Effect<ConfigProvider.ConfigProvider, ConfigError> =>
+  Effect.map(loadConfigFromPath(configPath), createFileConfigProvider)

package/src/config/index.ts

@@ -0,0 +1,72 @@
+/**
+ * Configuration Module
+ *
+ * Exports all configuration-related types, schemas, and utilities.
+ */
+
+export {
+  // File detection
+  CONFIG_FILE_NAMES,
+  type ConfigFileFormat,
+  type ConfigFileName,
+  // Provider creation
+  createFileConfigProvider,
+  findConfigFile,
+  type LoadConfigResult,
+  // File loading
+  loadConfigFile,
+  loadConfigFromPath,
+  loadFileConfigProvider,
+  loadFileConfigProviderFromPath,
+} from './file-provider.js'
+export {
+  // Precedence chain
+  type ConfigProviderOptions,
+  createCliConfigProvider,
+  createConfigProvider,
+  createConfigProviderSync,
+  createEnvConfigProvider,
+  createTestConfigProvider,
+  // Utilities
+  flattenConfig,
+  readEnvConfig,
+} from './precedence.js'
+export {
+  // Default values
+  defaultConfig,
+  // Types
+  type EmbeddingProvider,
+  EmbeddingsConfig,
+  // Config schemas
+  IndexConfig,
+  MdContextConfig,
+  type OpenAIEmbeddingModel,
+  OutputConfig,
+  type OutputFormat,
+  PathsConfig,
+  SearchConfig,
+  SummarizationConfig,
+} from './schema.js'
+export {
+  // Service
+  ConfigService,
+  ConfigServiceDefault,
+  ConfigServiceLive,
+  // Helper functions
+  getConfig,
+  getConfigSection,
+  getConfigValue,
+  // Layer utilities
+  makeConfigLayer,
+  makeConfigLayerPartial,
+  // Merge utilities
+  mergeWithDefaults,
+  type PartialMdContextConfig,
+} from './service.js'
+export {
+  // Testing utilities
+  runWithConfig,
+  runWithConfigSync,
+  TestConfigLayer,
+  withTestConfig,
+} from './testing.js'