Edam

  • 关于
  • 使用
  • 特性
  • 进阶学习
  • 中文
  • GitHub

>Usage

关于

  • 为什么需要edam?
  • 为什么叫edam

使用

  • 安装
  • 选项

高级

  • 执行流程
  • 书写模板
  • 书写Loader
  • 书写插件 ⚠WIP
  • 独立cli
  • 单元测试
编辑

选项

offlineFallback

  • Type: boolean

当离线状态下,是否使用本地模板缓存作为兼容方案

defaultcli
true--offline-fallback=true|false

updateNotify

  • Type: boolean

是否提示升级 update-notifier

defaultcli
true--update-notify=true|false

cacheDir

  • Type: string|boolean

缓存存放的目录路径

defaultcli
an computed value--cache-dir=<string>

includes

  • Type: string|string[]|Function|RegExp

哪些文件需要被覆盖(默认包括所有文件)

当你需要覆盖某些文件的时候,可以用该字段,如 --includes=README.md

defaultcli
() => true--includes=<string>,<string>

excludes

  • Type: string|string[]|Function|RegExp

相反与 inlcudes

defaultcli
() => false--excludes=<string>,<string>

extends

  • Type: string[]

继承额外的 edam 配置文件

defaultcli
[]--extends=<string,string>

plugins

  • Type: string[]|[[Function, object]]|Function[]

插件注册列表

defaultcli
[]--plugins=<string,string>

debug

  • Type: boolean

开启 debug 模式,当 --silent 开启时不会生效

defaultcli
false-d, --debug=true|false

pull.npmClient

  • Type: npm|yarn

指定安装 npm 包的客户端

defaultcli
npm--pull.npm-client=<string>

pull.npmClientArgs

  • Type: npm|yarn

指定安装 npm 包时的参数,如 --pull.npm-client-args="--registry=http://example.com"

defaultcli
string[]--pull.npm-client-args=<string>

pull.git

  • Type: clone|download

指定拉取 git 仓库的方式;

  • clone: 使用 git clone
  • download: download tar 包
defaultcli
clone--pull.git=<string>

userc

  • Type: boolean

是否使用 运行时配置文件,如 .edamrc / package.json 中 edam 配置

defaultcli
true--userc=true|false

yes

  • Type: boolean

使用默认值问答,而不是需要输入交互

defaultcli
false-y, --yes

storePrompts

  • Type: boolean

是否存储问答交互

defaultcli
true--store-prompts=true|false

output

  • Type: string

输出文件夹

defaultcli
process.cwd()-o <string>, --output=<string>

silent

  • Type: boolean

静默模式

defaultcli
false-s, --silent

overwrite

  • Type: boolean

是否覆盖已经存在的文件

defaultcli
false-w, --overwrite

clean

  • Type: boolean

在写入之前,是否清空输出目录

defaultcli
false--clean
← 安装执行流程 →

Powered by 🍔 Haier.