索引文件生成器
从文件夹创建索引文件 .
该工具将收集所有带有导出( 重复) 的文件,并以格式创建导出 :
export * from './file-1';
export * from './dir-1/file-1';
export * from './dir-1/file-2';
只有带有导出-的文件才会被添加到列表中(文件包含任何从导出单词开始的行).
使用量
igen [- 不包括...]
例如igen./src./src/index.ts -- 不包括(\. spec-.test)\.t$ ^docs-.ts$
这将为"src"文件夹中的所有文件创建索引文件"src/index.ts",但以".spec.ts"或".test.ts"结尾的所有文件以及文件"src/docs.ts"除外.
命令行参数
文件夹路径: 将要处理的路径 . 创建文件路径:将创建的文件路径.
选项
--path/-p(字符串,默认的第一个参数): 指定要使用的根文件夹。 使用此选项( 多次使用或将文件夹相继列出) , 您可以指定多个切入点 .
--out/-o(字符串,默认的第二个参数): 指定输出文件名和路径(相对于root)或输出文件名(参见模式).
--config/-c (字符串):将一个json文件读作config.
--mode/-m (字符串): 设置生成器模式 :
- 路径( 这是默认) : 将输出文件放入定义的路径, 如果不是绝对的, 那么相对于 cwd .
- root: 将输出文件放入根文件夹.
- 文件夹:每个文件夹的文件,包括单个文件的子文件夹文件.
- 子:每个文件夹的文件,包括所有子文件夹索引文件,忽略单个文件.
--including/-i(字符串):通过regex包含文件. regex会与处理过的文件夹根的相对路径相匹配. 您可以在选项后列出任何 regex 的编号, 或者多次使用, 例如 - 例如 regex1 regex2. 默认为 [/\.ts$/]。 。 。 .
--排除e/-e(字符串):通过regex排除文件. regex会与处理过的文件夹根的相对路径相匹配. 您可以在选项后列出任何 regex 的编号, 或者多次使用, 例如 - 例如 regex1 regex2.
--eol/-l(字符串) : 所用行终. 可能的值 : “ os”( 当前操作系统行结束)、 “ unix ” 、 “ if ” 、 “ n ” (使用 unix 行结束) \n),“win”,“crlf”,“rn”(使用窗口行结尾) \r\n页:1\r),其他任何东西(你可以定义其他任何东西). 默认为"os" .
eol-at-eof(布尔语): 如果在文件结尾处添加一行空行( 默认为真) .
--header/-h (字符串):将标题文本设置在生成文件的开头. 默认为:
This file was generated by a tool.
Do not modify it.
--header-mode (字符串): 设置标题的生成方式, 默认为 multi数字 :
- 残疾 : 不添加页眉.
- “ raw ” : 以正法相加头相.
- '单': 每行写为单行注释
// header。 。 。 . - “ multi” : 将标题写成多行注释, 并用
/* */,每行说明*。 。 。 .
--if- needed/-n(boolean):没有生成导出文件的应否 .
--format/-f(字符串): 导出的格式应生成 。 默认为 : export * from '{rel}/{name}';
您可以使用下列变量:
- {名}:文件名.
- {ext}: 文件的扩展名 .
- {rel}:目录的相对路径.
- {: 目录的绝对路径 .
从代码
从代码中导入 IndexGenerator 课从包.
import { IndexGenerator, Options } from '@droppedcode/index-generator';
忽略文件
您可以在文件( 任何地方) 上添加“ // 索引生成器- ignore” 注释而忽略文件 .
模式
不同模式为此输入生成以下内容:
src
|- f0
|- f1
|- b.ts
|- c.ts
|- a.ts
路径
将输出文件放入定义的路径(带有路径./src而未定义出),如果不是绝对的,则相对于 cwd(这是默认的).
生成的文件不会编译, 因为路径无效 。 您总是应该定义生成文件的输出路径(例如./src/index.ts)或者修改格式以包含需要的路径.
src
|- f0
|- f1
|- b.ts
|- c.ts
|- a.ts
index.ts
export * from './f0/f1/b.ts';
export * from './f0/c.ts';
export * from './a.ts';
根号
将输出文件放入根文件夹 .
src
|- f0
|- f1
|- b.ts
|- c.ts
|- a.ts
|- index.ts
export * from './f0/f1/b';
export * from './f0/c';
export * from './a';
文件夹
每个文件夹的文件,包括单个文件的子文件夹文件.
src
|- f0
|- f1
|- b.ts
|- index.ts
export * from './b';
|- c.ts
|- index.ts
export * from './f1/b';
export * from './c';
|- a.ts
|- index.ts
export * from './f0/f1/b';
export * from './f0/c';
export * from './a';
子目录
每个文件夹的文件,包括所有子文件夹索引文件,忽略单个文件.
src
|- f0
|- f1
|- b.ts
|- index.ts
export * from './b';
|- c.ts
|- index.ts
export * from './f1/index';
export * from './c';
|- a.ts
|- index.ts
export * from './f0/index';
export * from './a';