首页
/ Wagmi CLI Foundry插件默认排除列表问题解析

Wagmi CLI Foundry插件默认排除列表问题解析

2025-06-03 11:27:04作者:钟日瑜

问题背景

在使用Wagmi CLI的Foundry插件时,开发者发现当指定exclude配置项时,插件原本内置的默认排除列表(defaultExcludes)会被完全覆盖,而不是合并。这导致一些本应被默认排除的文件类型不再被忽略。

技术细节分析

Wagmi CLI的Foundry插件原本设计了一个默认排除列表(defaultExcludes),包含了一些常见的需要忽略的文件模式,如测试文件、脚本文件和特定目录等。这个设计本意是帮助开发者自动过滤掉不需要处理的文件。

然而,在插件实现中存在一个逻辑问题:当用户通过配置显式指定exclude选项时,插件会直接用用户提供的列表完全替换默认列表,而不是将两者合并。这导致用户必须手动重新指定所有需要排除的模式,包括那些原本默认就应该排除的内容。

解决方案演进

项目维护者采取了以下解决路径:

  1. 临时解决方案:首先将默认排除列表(defaultExcludes)导出,使开发者可以在配置中手动引用并合并这个列表。这样开发者可以显式地将默认排除项与自定义排除项结合使用。

  2. 未来改进方向:考虑在后续版本中修改插件行为,使其自动合并默认排除列表和用户指定的排除列表,而不是完全替换。这将提供更符合直觉的使用体验。

对开发者的建议

在当前版本中,开发者如果需要自定义排除规则,可以采用以下模式:

import { defaultExcludes } from '@wagmi/cli/plugins/foundry'

export default defineConfig({
  out: "typescript/generated/wagmi.ts",
  contracts: [],
  plugins: [
    foundry({
      exclude: [...defaultExcludes, "proxy/**.sol/**"],
    }),
  ],
});

这种方式确保了既保留了默认的排除规则,又能够添加项目特定的排除模式。

总结

这个问题展示了在开发工具类库时,配置项合并策略的重要性。默认值应该作为基础,用户自定义配置应该是对默认值的补充而非完全替代。Wagmi CLI团队已经意识到这一点,并计划在未来版本中改进这一行为,为开发者提供更友好的使用体验。

登录后查看全文
热门项目推荐
相关项目推荐