Configuration Loading

/**
 * Entry function for loading both commitizen and commitlint configurations
 * @param options - Loading options including cwd and explicit config path
 * @returns Promise resolving to merged configuration object
 */
function configLoader(options?: UserOptions): Promise<{
  rules?: Partial<RulesConfig>;
  prompt?: CommitizenGitOptions;
}>;

interface UserOptions {
  /** Debug mode working directory */
  cwd?: string;
  
  /** Directly specify the configuration path */
  configPath?: string;
}

import { configLoader } from "cz-git";

// Load configuration from default locations
const config = await configLoader();

// Load from specific directory
const config = await configLoader({ cwd: '/path/to/project' });

// Load from explicit config file
const config = await configLoader({ 
  configPath: './custom-cz.config.js' 
});

// Access loaded configuration
console.log(config.prompt?.types);
console.log(config.rules?.['type-enum']);

/**
 * Load commitlint configuration from various file formats
 * @param cwd - Working directory to search from
 * @returns Promise resolving to commitlint configuration
 */
function clLoader(cwd?: string): Promise<CommitlintOptions>;

interface CommitlintOptions {
  /** Commitlint validation rules */
  rules?: Partial<RulesConfig>;
  
  /** Prompt configuration from commitlint */
  prompt?: any;
}

/**
 * Load commitizen configuration from various sources
 * @param cwd - Working directory to search from
 * @returns Promise resolving to commitizen configuration
 */
function czLoader(cwd?: string): Promise<CommitizenGitOptions>;

/**
 * Load AI configuration from user home directory
 * @returns Promise resolving to AI configuration
 */
function aiLoader(): Promise<{
  openAIToken: string;
  apiEndpoint: string;
  apiProxy: string;
  apiModel: string;
}>;

import { aiLoader } from "cz-git";

// Load AI configuration
const aiConfig = await aiLoader();

console.log(aiConfig.openAIToken); // API token if set
console.log(aiConfig.apiModel);    // Preferred model

/**
 * Generic configuration loader using cosmiconfig
 * @param options - Loader configuration options
 * @returns Promise resolving to configuration result or null
 */
function loader(options: LoaderOptions): Promise<{
  config: any;
  filepath: string;
} | null>;

interface LoaderOptions {
  /** Module name for cosmiconfig */
  moduleName: string;
  
  /** Working directory to search from */
  cwd?: string;
  
  /** Stop searching at this directory */
  stopDir?: string;
  
  /** Explicit file path to load */
  explicitPath?: string;
  
  /** File names to search for */
  searchPlaces?: string[];
  
  /** Package.json property path */
  packageProp?: string[];
}

import { loader } from "cz-git";

// Custom configuration loading
const result = await loader({
  moduleName: 'mycommit',
  searchPlaces: ['.mycommitrc', 'mycommit.config.js'],
  packageProp: ['config', 'mycommit']
});

if (result) {
  console.log('Config found at:', result.filepath);
  console.log('Config content:', result.config);
}

interface SupportedFormats {
  /** JSON configuration files */
  json: '.json' | '.commitlintrc' | '.czrc';
  
  /** YAML configuration files */  
  yaml: '.yaml' | '.yml';
  
  /** JavaScript configuration files */
  javascript: '.js' | '.cjs' | '.mjs';
  
  /** TypeScript configuration files */
  typescript: '.ts' | '.cts' | '.mts';
  
  /** Package.json fields */
  packageJson: 'package.json';
}

// cz.config.js
export default {
  types: [
    { value: 'feat', name: 'feat: New feature' },
    { value: 'fix', name: 'fix: Bug fix' }
  ],
  useEmoji: true,
  scopes: ['core', 'ui', 'api']
};

// .commitlintrc.js  
export default {
  rules: {
    'type-enum': [2, 'always', ['feat', 'fix', 'docs']],
  },
  prompt: {
    messages: {
      type: 'Select the type of change:'
    }
  }
};

// package.json
{
  "config": {
    "commitizen": {
      "path": "cz-git",
      "czConfig": "./cz.config.js"
    }
  }
}

# .commitlintrc.yml
rules:
  type-enum:
    - 2
    - always
    - [feat, fix, docs, style, refactor]
prompt:
  useEmoji: true
  emojiAlign: center

interface ConfigurationMerging {
  /** Final merged configuration priority */
  priority: [
    'explicitPath',
    'czConfig', 
    'commitlintPrompt',
    'aiConfig',
    'defaults'
  ];
}

# Enable debug mode
CZ_DEBUG=1 npx cz

# Output shows:
# commitlint config-file: /project/.commitlintrc.js
# cz config-file: /project/cz.config.js
# Specify config file: /custom/path/config.js