yx_icon_fonts_flutter/icon_generator_config.templ...

58 lines
1.6 KiB
YAML

# 图标字体生成器配置文件模板
# 复制此文件到您的项目根目录,重命名为 icon_generator_config.yaml
# 并根据需要修改配置
# 生成器信息
generator:
# 项目名称(用于生成的代码注释)
name: "MyApp Icons"
# 版本
version: "1.0"
# 作者
author: "Your Name"
# 输入配置
input:
# 字体文件路径(相对于项目根目录)
# 这个文件从 iconfont.cn 下载
font_file: "assets/fonts/iconfont.ttf"
# JSON 配置文件路径(从 iconfont.cn 下载)
# 包含所有图标的 unicode 编码和名称
json_file: "assets/fonts/iconfont.json"
# 字体家族名称
# 需要与 pubspec.yaml 中 flutter.fonts 配置的 family 一致
# 例如:
# flutter:
# fonts:
# - family: iconfont
# fonts:
# - asset: assets/fonts/iconfont.ttf
font_family: "iconfont"
# 字体包名(可选)
# 如果字体文件位于另一个 package 中,请指定包名
# font_package: "my_icons_package"
# 输出配置
output:
# 生成的 Dart 文件路径
# 建议放在 lib/generated/ 目录下,并添加到 .gitignore
file_path: "lib/generated/icons.dart"
# 生成的类名
# 使用时: Icon(AppIcons.iconName, size: 24)
class_name: "AppIcons"
# 是否生成文档注释
# 设为 true 会为每个图标生成 Unicode 说明
generate_docs: true
# 是否使用 const 构造函数
use_const_constructor: true
# 包导入路径(可选)
# 如果需要在生成的文件中添加特定的 package 导入
# package_import: "package:my_app/common/icons.dart"