dts-bundle 配置项翻译

var opts = {
    // 必填项

    // 模块的名称，例如package.json中的名称
    // - 用于声明模块和进行导入/引用
    name: 'cool-project',
    // 入口点的路径（主模块生成的.d.ts文件）
    // 如果你想递归加载路径下的所有.d.ts文件，可以使用"path/project/**/*.d.ts"
    //  ^ *** 实验性功能，需要测试，参见"All .d.ts files"部分
    // - 相对路径或绝对路径
    main: 'build/index.d.ts',

    // 可选项

    // 用于查找类型声明的基本目录（即该项目自身）
    // - 默认值：main的目录名
    baseDir: 'build',
    // 输出文件的路径。相对于baseDir，但也可以使用绝对路径。
    // 如果以"~/"开头，则相对于当前路径。参见https://github.com/TypeStrong/dts-bundle/issues/26
    //  ^ *** 实验性功能，需要测试
    // - 默认值："<baseDir>/<name>.d.ts"
    out: 'dist/cool-project.d.ts',
    // 包括baseDir之外的类型声明（例如node.d.ts）
    // - 默认值：false
    externals: false,
    // 引用外部模块使用<reference path="..." />标签 *** 实验性功能，需要测试
    // - 默认值：false
    referenceExternals: false,
    // 用于排除类型声明的过滤器，可以是正则表达式或回调函数。路径相对于opts.baseDir
    // - 正则表达式：匹配的文件将被排除
    // - 函数：(file:String, external:Boolean) 返回true表示排除，返回false表示允许
    // - 总是使用正斜杠（即使在Windows上）
    // - 默认值：*pass*
    exclude: /^defs\/$/,
    // 删除所有源类型声明（即"<baseDir>/**/*.d.ts"）
    // - 默认值：false
    removeSource: false,
    // 输出文件中使用的换行符
    newline: os.EOL,
    // 输出文件中使用的缩进
    // - 默认值：4个空格
    indent: '	',
    // 用于重写模块名称的前缀
    // - 默认值：''
    prefix: '__',
    // 用于重写模块路径名称的分隔符
    // - 默认值：斜杠（如子模块）
    separator: '/',
    // 启用详细模式，打印有关所有引用、包含和排除的详细信息
    // - 默认值：false
    verbose: false,
    // 发出警告，即使未找到包含的文件。参见"Files not found"部分
    // *** 实验性功能，需要测试
    // - 默认值：false
    emitOnIncludedFileNotFound: false,
    // 发出警告，即使没有找到包含的文件。参见"Files not found"部分
    // *** 实验性功能，需要测试
    // - 默认值：false
    emitOnNoIncludedFileNotFound: false,    
    // 将d.ts输出设计为模块文件夹。（无declare modules）
    outputAsModuleFolder: false,
    // 包含头部信息的文件路径
    // // 在输出文件中插入一个头部，例如：http://definitelytyped.org/guides/contributing.html#header
    // - 默认值：null
    headerPath: "path/to/header/file",
    // 头部信息的文本内容
    // 与headerPath不兼容
    // // 在输出文件中插入一个头部，例如：http://definitelytyped.org/guides/contributing.html#header
    // - 默认值：''
    headerTex: "" 
};

// 导入模块
var dts = require('dts-bundle');

// 执行
dts.bundle(opts);