@reliverse/rempts-plugin-config 2.3.1

package/README.md

@@ -0,0 +1,174 @@
+# rempts-plugin-config
+
+Configuration file merger plugin for Rempts CLI framework. Loads and merges configuration from multiple sources including user home directory and project-specific config files.
+
+## Installation
+
+```bash
+bun add rempts-plugin-config
+```
+
+## Usage
+
+```typescript
+import { createCLI } from '@reliverse/rempts-core'
+import { configMergerPlugin } from '@reliverse/rempts-plugin-config'
+
+const cli = await createCLI({
+  name: 'my-cli',
+  version: '1.0.0',
+  plugins: [
+    configMergerPlugin({
+      sources: [
+        '~/.config/{{name}}/config.json',
+        '.{{name}}rc.json',
+        '.{{name}}rc',
+        'package.json'
+      ]
+    })
+  ]
+})
+
+// Config is automatically merged into your CLI configuration
+```
+
+## Options
+
+```typescript
+interface ConfigMergerOptions {
+  /**
+   * List of config file paths to load
+   * Supports {{name}} template which is replaced with CLI name
+   * Paths starting with ~ are expanded to home directory
+   */
+  sources: string[]
+
+  /**
+   * Merge strategy for combining configs
+   * - 'deep': Recursively merge objects (default)
+   * - 'shallow': Only merge top-level properties
+   */
+  mergeStrategy?: 'deep' | 'shallow'
+
+  /**
+   * Stop after finding the first config file
+   * Default: false (loads and merges all found configs)
+   */
+  stopOnFirst?: boolean
+
+  /**
+   * Custom config parser (e.g., for YAML, TOML)
+   * Default: JSON.parse
+   */
+  parser?: (content: string) => any
+
+  /**
+   * Transform config after loading
+   */
+  transform?: (config: any) => any
+}
+```
+
+## Config File Formats
+
+By default, the plugin supports JSON files. Common patterns:
+
+### RC Files
+
+```bash
+# These are equivalent for a CLI named "my-cli"
+.my-clirc
+.my-clirc.json
+```
+
+### Home Directory Config
+
+```bash
+~/.config/my-cli/config.json
+~/.my-clirc
+```
+
+### Package.json
+
+```json
+{
+  "name": "my-project",
+  "version": "1.0.0",
+  "my-cli": {
+    "apiKey": "secret",
+    "theme": "dark"
+  }
+}
+```
+
+## Template Variables
+
+- `{{name}}` - Replaced with your CLI's name
+
+## Load Order
+
+Configs are loaded in the order specified and merged together. Later configs override earlier ones.
+
+```typescript
+// Example: User config overrides defaults
+configMergerPlugin({
+  sources: [
+    '/etc/my-cli/defaults.json',    // System defaults
+    '~/.config/my-cli/config.json', // User config
+    '.my-clirc'                     // Project config
+  ]
+})
+```
+
+## Stop on First
+
+Use `stopOnFirst` to implement fallback behavior:
+
+```typescript
+configMergerPlugin({
+  sources: [
+    '.my-clirc',                    // Check project first
+    '~/.config/my-cli/config.json', // Then user
+    '/etc/my-cli/defaults.json'     // Finally system
+  ],
+  stopOnFirst: true // Use only the first found
+})
+```
+
+## Custom Parsers
+
+Support other formats with custom parsers:
+
+```typescript
+import { parse as parseYAML } from 'yaml'
+
+configMergerPlugin({
+  sources: ['.my-cli.yml', '.my-cli.yaml'],
+  parser: parseYAML
+})
+```
+
+## Transform Configs
+
+Apply transformations after loading:
+
+```typescript
+configMergerPlugin({
+  sources: ['.my-clirc'],
+  transform: (config) => {
+    // Expand environment variables
+    if (config.apiKey === '$API_KEY') {
+      config.apiKey = process.env.API_KEY
+    }
+    return config
+  }
+})
+```
+
+## Error Handling
+
+Missing config files are silently ignored. Parse errors are logged but don't crash the CLI.
+
+## License
+
+MIT © blefnk

package/dist/mod.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Config merger plugin for Rempts
+ * Loads configuration from multiple sources and merges them
+ */
+export interface ConfigPluginOptions {
+    /**
+     * Config file sources to load
+     * Supports template variables: {{name}} for app name
+     * Default: ['~/.config/{{name}}/config.json', '.{{name}}rc', '.{{name}}rc.json']
+     */
+    sources?: string[];
+    /**
+     * Merge strategy
+     * - 'deep': Recursively merge objects (default)
+     * - 'shallow': Only merge top-level properties
+     */
+    mergeStrategy?: "shallow" | "deep";
+    /**
+     * Whether to stop on first found config
+     * Default: false (loads and merges all found configs)
+     */
+    stopOnFirst?: boolean;
+}
+/**
+ * Config merger plugin factory
+ */
+export declare const configMergerPlugin: any;
+export default configMergerPlugin;

package/dist/mod.js

@@ -0,0 +1,54 @@
+import { access, readFile } from "node:fs/promises";
+import { homedir } from "node:os";
+import { join } from "node:path";
+import { createPlugin } from "@reliverse/rempts-core/plugin";
+import { deepMerge } from "@reliverse/rempts-core/utils";
+export const configMergerPlugin = createPlugin((options = {}) => {
+  const sources = options.sources || [
+    "~/.config/{{name}}/config.json",
+    ".{{name}}rc",
+    ".{{name}}rc.json",
+    ".config/{{name}}.json"
+  ];
+  return () => ({
+    async setup(context) {
+      const appName = context.config.name || "rempts";
+      const configs = [];
+      for (const source of sources) {
+        let path = source.replace(/^~/, homedir()).replace(/\{\{name\}\}/g, appName);
+        if (!(path.startsWith("/") || path.startsWith(homedir()))) {
+          path = join(context.paths.cwd, path);
+        }
+        try {
+          await access(path);
+          const content = await readFile(path, "utf-8");
+          let config;
+          try {
+            config = JSON.parse(content);
+          } catch (parseError) {
+            context.logger.warn(`Failed to parse config file ${path}: ${parseError}`);
+            continue;
+          }
+          configs.push(config);
+          context.logger.debug(`Loaded config from ${path}`);
+          if (options.stopOnFirst) {
+            break;
+          }
+        } catch {
+          context.logger.debug(`Config file not found: ${path}`);
+        }
+      }
+      if (configs.length > 0) {
+        let merged;
+        if (options.mergeStrategy === "shallow") {
+          merged = Object.assign({}, ...configs);
+        } else {
+          merged = deepMerge(...configs);
+        }
+        context.updateConfig(merged);
+        context.logger.info(`Merged ${configs.length} config file(s)`);
+      }
+    }
+  });
+});
+export default configMergerPlugin;

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@reliverse/rempts-plugin-config",
+  "version": "2.3.1",
+  "description": "Config merger plugin for Rempts - loads config from multiple sources",
+  "keywords": [
+    "cli",
+    "config",
+    "plugin",
+    "rempts"
+  ],
+  "license": "MIT",
+  "author": "bun dler Team",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "type": "module",
+  "main": "./src/mod.ts",
+  "types": "./src/mod.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/mod.d.ts",
+      "default": "./dist/mod.js"
+    }
+  },
+  "dependencies": {
+    "@reliverse/rempts-core": "2.3.1",
+    "@reliverse/rempts-utils": "2.3.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/mod.ts

@@ -0,0 +1,106 @@
+/**
+ * Config merger plugin for Rempts
+ * Loads configuration from multiple sources and merges them
+ */
+
+import { access, readFile } from "node:fs/promises";
+import { homedir } from "node:os";
+import { join } from "node:path";
+import { createPlugin } from "@reliverse/rempts-core/plugin";
+import { deepMerge } from "@reliverse/rempts-core/utils";
+
+export interface ConfigPluginOptions {
+  /**
+   * Config file sources to load
+   * Supports template variables: {{name}} for app name
+   * Default: ['~/.config/{{name}}/config.json', '.{{name}}rc', '.{{name}}rc.json']
+   */
+  sources?: string[];
+
+  /**
+   * Merge strategy
+   * - 'deep': Recursively merge objects (default)
+   * - 'shallow': Only merge top-level properties
+   */
+  mergeStrategy?: "shallow" | "deep";
+
+  /**
+   * Whether to stop on first found config
+   * Default: false (loads and merges all found configs)
+   */
+  stopOnFirst?: boolean;
+}
+
+/**
+ * Config merger plugin factory
+ */
+export const configMergerPlugin = createPlugin<ConfigPluginOptions, {}>((options = {}) => {
+  const sources = options.sources || [
+    "~/.config/{{name}}/config.json",
+    ".{{name}}rc",
+    ".{{name}}rc.json",
+    ".config/{{name}}.json",
+  ];
+
+  return () => ({
+    async setup(context) {
+      const appName = context.config.name || "rempts";
+      const configs: any[] = [];
+
+      for (const source of sources) {
+        // Resolve template variables and home directory
+        let path = source.replace(/^~/, homedir()).replace(/\{\{name\}\}/g, appName);
+
+        // Resolve relative paths from context cwd
+        if (!(path.startsWith("/") || path.startsWith(homedir()))) {
+          path = join(context.paths.cwd, path);
+        }
+
+        try {
+          // Check if file exists
+          await access(path);
+
+          // Read and parse config
+          const content = await readFile(path, "utf-8");
+          let config: any;
+
+          try {
+            config = JSON.parse(content);
+          } catch (parseError) {
+            context.logger.warn(`Failed to parse config file ${path}: ${parseError}`);
+            continue;
+          }
+
+          configs.push(config);
+          context.logger.debug(`Loaded config from ${path}`);
+
+          // Stop if requested
+          if (options.stopOnFirst) {
+            break;
+          }
+        } catch {
+          // File doesn't exist, skip silently
+          context.logger.debug(`Config file not found: ${path}`);
+        }
+      }
+
+      if (configs.length > 0) {
+        // Merge all found configs
+        let merged: any;
+
+        if (options.mergeStrategy === "shallow") {
+          merged = Object.assign({}, ...configs);
+        } else {
+          // Deep merge is already available
+          merged = deepMerge(...configs);
+        }
+
+        context.updateConfig(merged);
+        context.logger.info(`Merged ${configs.length} config file(s)`);
+      }
+    },
+  });
+});
+
+// Default export for convenience
+export default configMergerPlugin;