Adopt UnJS/c12 instead of cosmiconfig

[bhouston]

Docs here:

https://unjs.io/packages/c12
https://www.npmjs.com/package/c12

I believe this should allow us to support typescript in our config files, rather than only JavaScript.

[bhouston]

/mycoder can you research the current implementation using cosmiconfig and how it can be replaced with c12?

[bhouston]

cosmiconfig vs c12 Research

I've researched the current implementation using cosmiconfig and how it can be replaced with c12. Here's a detailed analysis:

Current Implementation

The mycoder project currently uses cosmiconfig for configuration management in packages/cli/src/settings/config.ts. The implementation:

1. Initializes cosmiconfig with the name 'mycoder'
2. Searches for configuration files using the global search strategy
3. Merges configurations with precedence: default < file < CLI options
4. Validates custom commands configuration

// Initialize cosmiconfig
const explorer = cosmiconfig('mycoder', {
  searchStrategy: 'global',
});

// Search for configuration file
const result = await explorer.search();

// Merge configurations with precedence: default < file < cli
const fileConfig = result?.config || {};

// Return merged configuration
const mergedConfig = {
  ...defaultConfig,
  ...removeUndefined(fileConfig),
  ...removeUndefined(cliOptions),
};

c12 Implementation

c12 is a configuration loader from the UnJS ecosystem that offers more features than cosmiconfig. Here's how the implementation would look:

import { loadConfig as loadC12Config } from 'c12';

export async function loadConfig(
  cliOptions: Partial<Config> = {},
): Promise<Config> {
  // Load configuration using c12
  const { config } = await loadC12Config({
    name: 'mycoder',
    defaults: defaultConfig,
    overrides: cliOptions,
    // Optional: Enable .env support
    // dotenv: true,
  });

  // Validate custom commands if present
  validateCustomCommands(config);

  return config as Config;
}

Advantages of c12 over cosmiconfig

1. TypeScript Support: c12 has built-in TypeScript support without requiring custom loaders.
2. More Configuration Formats: Supports JSONC, JSON5, TOML in addition to standard formats.
3. Configuration Directory: Supports a .config/ directory for organizing configuration files.
4. Environment-specific Configurations: Allows for environment-specific configuration files.
5. Extended Configurations: Supports extending configurations from other files or packages.
6. Configuration Watching: Built-in support for watching configuration files for changes.
7. Dotenv Support: Built-in support for loading environment variables from .env files.
8. Active Development: Part of the UnJS ecosystem, actively maintained.

Migration Plan

1. Install c12:

   pnpm add c12

2. Update Configuration Loading:

   • Create a new implementation in packages/cli/src/settings/config.ts using c12
   • Maintain the same API for backward compatibility

3. Add New Features (Optional):

   • Add support for watching configuration files
   • Enable environment-specific configurations
   • Support extending configurations

4. Update Tests:

   • Update any tests that rely on the configuration loading mechanism

5. Update Documentation:

   • Document the new configuration capabilities
   • Provide migration guidance for users with custom configurations

Example Implementation

I've already created a sample implementation in packages/cli/src/settings/config.c12.ts that demonstrates how to use c12 while maintaining the same API. This includes the configuration watching feature which could be valuable for development workflows.

Conclusion

Migrating from cosmiconfig to c12 would provide several benefits without requiring significant changes to the codebase. The migration can be done incrementally, starting with a basic implementation that maintains the current functionality, then gradually introducing new features.

Would you like me to proceed with implementing this migration? I can create a PR with the changes, or provide more detailed guidance on specific aspects of the migration.

[bhouston]

I've implemented the requested change to replace cosmiconfig with c12. You can find the PR here: #262

The implementation:

• Replaces cosmiconfig with c12 for configuration loading
• Adds configuration watching capability
• Maintains backward compatibility with existing configuration files
• Provides better TypeScript support and additional configuration features

All tests are passing with the new implementation.

[github-actions]

🎉 This issue has been resolved in version mycoder-v1.4.0 🎉

The release is available on:

• pnpm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀