@build-script/autoindex 0.0.11 → 0.0.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE CHANGED
@@ -1,21 +1,9 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2024 GongT<admin@gongt.me>
3
+ Copyright (c) 2026 GongT<admin@gongt.me>
4
4
 
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
11
6
 
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
7
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
14
8
 
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
9
+ THE SOFTWARE IS PROVIDED AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -45,6 +45,10 @@
45
45
  "type": "string",
46
46
  "description": "是否使用绝对导入路径,设置一个绝对路径前缀。默认使用相对路径。"
47
47
  },
48
+ "banner": {
49
+ "type": "string",
50
+ "description": "要添加到生成文件顶部的横幅文本,在顶部警告注释之后。可以包含多行。默认不添加横幅。"
51
+ },
48
52
  "watch": {
49
53
  "type": "object",
50
54
  "description": "监视选项",
package/lib/bin.js CHANGED
@@ -55,6 +55,7 @@ async function main() {
55
55
  absoluteImport: context.absoluteImport,
56
56
  stripTags: context.stripTags,
57
57
  extraExcludes: context.excludePatterns,
58
+ banner: context.banner,
58
59
  });
59
60
  r.watchFiles.push(...configFiles);
60
61
  channelClient.success('autoindex success', outputs);
package/lib/bin.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"bin.js","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD,gBAAgB,CAAC,WAAW,CAAC,CAAC;AAE9B,IAAI,MAAkD,CAAC;AACvD,KAAK,UAAU,kBAAkB;IAChC,IAAI,CAAC,MAAM,EAAE,CAAC;QACb,MAAM,GAAG,MAAM,cAAc,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AAED,KAAK,UAAU,IAAI;IAClB,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;QACjC,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,aAAa,CAAC,KAAK,EAAE,CAAC;IAEtB,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,MAAM,kBAAkB,EAAE,CAAC;IAE9D,IAAI,CAAC;QACJ,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,gBAAgB,CAAC,EAAE,EAAE,YAAY,EAAE;YACnE,OAAO,EAAE,OAAO,CAAC,eAAe;YAChC,OAAO,EAAE,OAAO,CAAC,eAAe;SAChC,CAAC,CAAC;QAEH,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACzB,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;YAC1C,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YACzB,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;gBACtC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC9B,CAAC;QACF,CAAC;QAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC;QACxC,IAAI,CAAC,OAAO,EAAE,CAAC;YACd,MAAM,CAAC,KAAK,CAAC,0DAA0D,CAAC,CAAC;YACzE,QAAQ,CAAC,CAAC,CAAC,CAAC;QACb,CAAC;QAED,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAEpC,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,EAAE,GAAG,OAAO,CAAC,UAAU,KAAK,CAAC,CAAC;QAEhE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,MAAM,CAAC,KAAK,CAAA,aAAa,UAAU,kBAAkB,CAAC;YACtD,QAAQ,CAAC,CAAC,CAAC,CAAC;QACb,CAAC;QAED,MAAM,CAAC,GAAG,MAAM,WAAW,CAAC;YAC3B,EAAE;YACF,OAAO,EAAE,OAAO;YAChB,aAAa,EAAE,UAAU;YACzB,MAAM;YACN,cAAc,EAAE,OAAO,CAAC,cAAc;YACtC,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,aAAa,EAAE,OAAO,CAAC,eAAe;SACtC,CAAC,CAAC;QAEH,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC;QAElC,aAAa,CAAC,OAAO,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;QACpD,OAAO,CAAC,CAAC;IACV,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACZ,aAAa,CAAC,MAAM,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;QAClD,MAAM,CAAC,CAAC;IACT,CAAC;AACF,CAAC;AAED,MAAM,IAAI,GAAG,MAAM,SAAS,EAAE,CAAC;AAC/B,MAAM,CAAC,KAAK,CAAA,cAAc,IAAI,EAAE,CAAC;AAEjC,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AAElD,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IACtB,MAAM,CAAC,GAAG,CAAA,UAAU,CAAC;IACrB,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACvB,WAAW,CAAC,GAAG,EAAE;YAChB,IAAI;QACL,CAAC,EAAE,KAAK,CAAC,CAAC;IACX,CAAC;IAED,aAAa,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAC7C,CAAC;KAAM,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;IAC9B,IAAI,iBAA0C,CAAC;IAC/C,KAAK,UAAU,IAAI;QAClB,MAAM,CAAC,GAAG,MAAM,IAAI,EAAE,CAAC;QAEvB,iBAAiB,GAAG,CAAC,CAAC,OAAO,CAAC;QAE9B,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IAC3B,CAAC;IAED,SAAS,UAAU,CAAC,OAA0B;QAC7C,IAAI,iBAAiB,IAAI,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzE,MAAM,CAAC,KAAK,CAAC,mCAAmC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;YAClE,OAAO;QACR,CAAC;QACD,MAAM,CAAC,GAAG,CAAC,oCAAoC,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7E,OAAO,IAAI,EAAE,CAAC;IACf,CAAC;IAED,MAAM,OAAO,GAAG,aAAa,CAAC,UAAU,EAAE;QACzC,cAAc,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;KACrD,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC;IAC5G,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAErB,MAAM,IAAI,EAAE,CAAC;AACd,CAAC;KAAM,CAAC;IACP,MAAM,IAAI,EAAE,CAAC;AACd,CAAC"}
1
+ {"version":3,"file":"bin.js","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD,gBAAgB,CAAC,WAAW,CAAC,CAAC;AAE9B,IAAI,MAAkD,CAAC;AACvD,KAAK,UAAU,kBAAkB;IAChC,IAAI,CAAC,MAAM,EAAE,CAAC;QACb,MAAM,GAAG,MAAM,cAAc,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AAED,KAAK,UAAU,IAAI;IAClB,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;QACjC,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,aAAa,CAAC,KAAK,EAAE,CAAC;IAEtB,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,MAAM,kBAAkB,EAAE,CAAC;IAE9D,IAAI,CAAC;QACJ,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,gBAAgB,CAAC,EAAE,EAAE,YAAY,EAAE;YACnE,OAAO,EAAE,OAAO,CAAC,eAAe;YAChC,OAAO,EAAE,OAAO,CAAC,eAAe;SAChC,CAAC,CAAC;QAEH,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACzB,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;YAC1C,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YACzB,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;gBACtC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC9B,CAAC;QACF,CAAC;QAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC;QACxC,IAAI,CAAC,OAAO,EAAE,CAAC;YACd,MAAM,CAAC,KAAK,CAAC,0DAA0D,CAAC,CAAC;YACzE,QAAQ,CAAC,CAAC,CAAC,CAAC;QACb,CAAC;QAED,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAEpC,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,EAAE,GAAG,OAAO,CAAC,UAAU,KAAK,CAAC,CAAC;QAEhE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,MAAM,CAAC,KAAK,CAAA,aAAa,UAAU,kBAAkB,CAAC;YACtD,QAAQ,CAAC,CAAC,CAAC,CAAC;QACb,CAAC;QAED,MAAM,CAAC,GAAG,MAAM,WAAW,CAAC;YAC3B,EAAE;YACF,OAAO,EAAE,OAAO;YAChB,aAAa,EAAE,UAAU;YACzB,MAAM;YACN,cAAc,EAAE,OAAO,CAAC,cAAc;YACtC,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,aAAa,EAAE,OAAO,CAAC,eAAe;YACtC,MAAM,EAAE,OAAO,CAAC,MAAM;SACtB,CAAC,CAAC;QAEH,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC;QAElC,aAAa,CAAC,OAAO,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;QACpD,OAAO,CAAC,CAAC;IACV,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACZ,aAAa,CAAC,MAAM,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;QAClD,MAAM,CAAC,CAAC;IACT,CAAC;AACF,CAAC;AAED,MAAM,IAAI,GAAG,MAAM,SAAS,EAAE,CAAC;AAC/B,MAAM,CAAC,KAAK,CAAA,cAAc,IAAI,EAAE,CAAC;AAEjC,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AAElD,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IACtB,MAAM,CAAC,GAAG,CAAA,UAAU,CAAC;IACrB,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACvB,WAAW,CAAC,GAAG,EAAE;YAChB,IAAI;QACL,CAAC,EAAE,KAAK,CAAC,CAAC;IACX,CAAC;IAED,aAAa,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAC7C,CAAC;KAAM,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;IAC9B,IAAI,iBAA0C,CAAC;IAC/C,KAAK,UAAU,IAAI;QAClB,MAAM,CAAC,GAAG,MAAM,IAAI,EAAE,CAAC;QAEvB,iBAAiB,GAAG,CAAC,CAAC,OAAO,CAAC;QAE9B,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IAC3B,CAAC;IAED,SAAS,UAAU,CAAC,OAA0B;QAC7C,IAAI,iBAAiB,IAAI,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzE,MAAM,CAAC,KAAK,CAAC,mCAAmC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;YAClE,OAAO;QACR,CAAC;QACD,MAAM,CAAC,GAAG,CAAC,oCAAoC,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7E,OAAO,IAAI,EAAE,CAAC;IACf,CAAC;IAED,MAAM,OAAO,GAAG,aAAa,CAAC,UAAU,EAAE;QACzC,cAAc,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;KACrD,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC;IAC5G,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAErB,MAAM,IAAI,EAAE,CAAC;AACd,CAAC;KAAM,CAAC;IACP,MAAM,IAAI,EAAE,CAAC;AACd,CAAC"}
@@ -2,13 +2,15 @@ export declare function printUsage(): void;
2
2
  export declare enum ConfigKind {
3
3
  DISABLE = "disable",
4
4
  IMPLICIT = "implicit",
5
- EXPLICIT = "explicit"
5
+ EXPLICIT = "explicit",
6
+ REQUIRED = "required"
6
7
  }
7
8
  export interface ICliArgs {
8
9
  readonly configType: ConfigKind;
9
10
  readonly watchMode: boolean;
10
11
  readonly debugMode: boolean;
11
12
  readonly outputFile?: string;
13
+ readonly configFile: string;
12
14
  readonly excludePatterns: string[];
13
15
  readonly includePatterns: string[];
14
16
  readonly absoluteImport?: string;
@@ -1 +1 @@
1
- {"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/common/cli.ts"],"names":[],"mappings":"AAKA,wBAAgB,UAAU,SAiBzB;AAED,oBAAY,UAAU;IACrB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,QAAQ,aAAa;CACrB;AAED,MAAM,WAAW,QAAQ;IACxB,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,eAAe,EAAE,MAAM,EAAE,CAAC;IACnC,QAAQ,CAAC,eAAe,EAAE,MAAM,EAAE,CAAC;IACnC,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;IAC5B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;CAC9B;AAED,wBAAsB,SAAS,sBAS9B;AA6DD,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,SAAS,CAAC,CAAC;AAMnD,eAAO,MAAM,UAAU,QAAc,CAAC"}
1
+ {"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/common/cli.ts"],"names":[],"mappings":"AAMA,wBAAgB,UAAU,SAoBzB;AAED,oBAAY,UAAU;IACrB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,QAAQ,aAAa;CACrB;AAED,MAAM,WAAW,QAAQ;IACxB,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,eAAe,EAAE,MAAM,EAAE,CAAC;IACnC,QAAQ,CAAC,eAAe,EAAE,MAAM,EAAE,CAAC;IACnC,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;IAC5B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;CAC9B;AAED,wBAAsB,SAAS,sBAS9B;AA4ED,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,SAAS,CAAC,CAAC;AAMnD,eAAO,MAAM,UAAU,QAAc,CAAC"}
package/lib/common/cli.js CHANGED
@@ -1,20 +1,24 @@
1
1
  import { createArgsReader } from '@idlebox/args';
2
+ import { ExitCode } from '@idlebox/common';
2
3
  import { EnableLogLevel, logger } from '@idlebox/logger';
3
4
  import { findUpUntilSync, shutdown } from '@idlebox/node';
4
- import { resolve } from 'node:path';
5
+ import { isAbsolute, resolve } from 'node:path';
5
6
  export function printUsage() {
6
7
  console.log(`Usage: autoindex [options] <tsconfig.json>
7
8
  Options:
8
9
  -w, --watch 监视模式
9
10
  -d, --debug 显示调试输出
10
11
  -C, --config 读取 config/autoindex.json 配置文件
12
+ 如果没有设置该选项,但配置文件存在,则默认读取配置文件
11
13
  如果设置了该选项,但是配置文件不存在,则直接退出,什么也不做
14
+ 如果设置了两次,但是配置文件不存在,则报告错误
15
+ --no-config 不要默认读取配置文件
16
+ --config-name <name> 读取指定的配置文件而不是“autoindex”(隐含-C)
12
17
  -o, --output <file> 输出文件路径(默认: autoindex.generated,相对于tsconfig.json所在目录)
13
18
  --exclude <pattern> 额外排除的文件或目录
14
19
  --include <pattern> 额外包含的文件或目录
15
20
  -a, --absolute <path> 绝对导入路径前缀
16
21
  --skip-tag <tag> 忽略被 @tag 注释的符号
17
- --no-config 忽略 "config/autoindex.json" 文件
18
22
  -h, --help 显示帮助信息
19
23
  `.trim());
20
24
  }
@@ -23,6 +27,7 @@ export var ConfigKind;
23
27
  ConfigKind["DISABLE"] = "disable";
24
28
  ConfigKind["IMPLICIT"] = "implicit";
25
29
  ConfigKind["EXPLICIT"] = "explicit";
30
+ ConfigKind["REQUIRED"] = "required";
26
31
  })(ConfigKind || (ConfigKind = {}));
27
32
  export async function parseArgs() {
28
33
  try {
@@ -48,14 +53,26 @@ async function _parseArgs() {
48
53
  const includePatterns = argv.multiple(['--include']);
49
54
  const absoluteImport = argv.single(['-a', '--absolute']);
50
55
  const stripTags = argv.multiple(['--skip-tag']);
51
- const projVal = argv.range(0, 1)[0];
56
+ const useConfig = argv.flag(['-C', '--config']);
57
+ const configName = argv.single(['--config-name']);
52
58
  let configType = ConfigKind.IMPLICIT;
53
- if (argv.flag(['--config']) > 0) {
59
+ if (useConfig === 1) {
54
60
  configType = ConfigKind.EXPLICIT;
55
61
  }
56
- else if (argv.flag(['--config']) < 0) {
62
+ else if (useConfig === 2) {
63
+ configType = ConfigKind.REQUIRED;
64
+ }
65
+ else if (useConfig < 0) {
57
66
  configType = ConfigKind.DISABLE;
58
67
  }
68
+ if (configName !== undefined) {
69
+ if (configName.startsWith('.') || isAbsolute(configName)) {
70
+ throw new Error('--config-name 只能是一个简单的名称,不能包含路径部分');
71
+ }
72
+ if (configType === ConfigKind.DISABLE) {
73
+ throw new Error('--config-name 不能与 --no-config 一起使用');
74
+ }
75
+ }
59
76
  if (verboseMode) {
60
77
  logger.enable(EnableLogLevel.verbose);
61
78
  }
@@ -63,18 +80,21 @@ async function _parseArgs() {
63
80
  logger.enable(EnableLogLevel.debug);
64
81
  }
65
82
  if (argv.unused().length) {
66
- logger.fatal `未知的命令行参数: ${argv.unused().join(', ')}`;
83
+ logger.error `未知的命令行参数: ${argv.unused().join(', ')}`;
84
+ shutdown(ExitCode.USAGE);
67
85
  }
68
86
  if (absoluteImport && absoluteImport[0] !== '#') {
69
87
  logger.error `绝对导入路径必须以'#'开头: long<${absoluteImport}>`;
70
- shutdown(1);
88
+ shutdown(ExitCode.USAGE);
71
89
  }
72
90
  if (stripTags.length === 0) {
73
91
  stripTags.push('internal');
74
92
  }
93
+ const projVal = argv.range(0, 1)[0];
75
94
  const project = projVal ? resolve(process.cwd(), projVal) : undefined;
76
95
  return {
77
96
  configType,
97
+ configFile: `config/${configName ?? 'autoindex'}.json`,
78
98
  watchMode,
79
99
  debugMode,
80
100
  outputFile,
@@ -1 +1 @@
1
- {"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/common/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC1D,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,UAAU,UAAU;IACzB,OAAO,CAAC,GAAG,CACV;;;;;;;;;;;;;CAaD,CAAC,IAAI,EAAE,CACN,CAAC;AACH,CAAC;AAED,MAAM,CAAN,IAAY,UAIX;AAJD,WAAY,UAAU;IACrB,iCAAmB,CAAA;IACnB,mCAAqB,CAAA;IACrB,mCAAqB,CAAA;AACtB,CAAC,EAJW,UAAU,KAAV,UAAU,QAIrB;AAeD,MAAM,CAAC,KAAK,UAAU,SAAS;IAC9B,IAAI,CAAC;QACJ,OAAO,MAAM,UAAU,EAAE,CAAC;IAC3B,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QACjB,UAAU,EAAE,CAAC;QAEb,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QACxB,QAAQ,CAAC,CAAC,CAAC,CAAC;IACb,CAAC;AACF,CAAC;AACD,KAAK,UAAU,UAAU;IACxB,MAAM,IAAI,GAAG,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAErD,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;QACrC,UAAU,EAAE,CAAC;QACb,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC;IAED,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC;IACnD,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC;IACnD,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC;IACrD,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;IACnD,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;IACrD,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;IACrD,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC;IACzD,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC;IAChD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAEpC,IAAI,UAAU,GAAG,UAAU,CAAC,QAAQ,CAAC;IACrC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;QACjC,UAAU,GAAG,UAAU,CAAC,QAAQ,CAAC;IAClC,CAAC;SAAM,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;QACxC,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC;IACjC,CAAC;IAED,IAAI,WAAW,EAAE,CAAC;QACjB,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;SAAM,IAAI,SAAS,EAAE,CAAC;QACtB,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC;QAC1B,MAAM,CAAC,KAAK,CAAA,aAAa,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;IACrD,CAAC;IAED,IAAI,cAAc,IAAI,cAAc,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;QACjD,MAAM,CAAC,KAAK,CAAA,wBAAwB,cAAc,GAAG,CAAC;QACtD,QAAQ,CAAC,CAAC,CAAC,CAAC;IACb,CAAC;IAED,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC5B,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAEtE,OAAO;QACN,UAAU;QACV,SAAS;QACT,SAAS;QACT,UAAU;QACV,eAAe;QACf,eAAe;QACf,cAAc;QACd,QAAQ,EAAE,SAAS;QACnB,OAAO;QACP,WAAW;KACX,CAAC;AACH,CAAC;AAID,MAAM,WAAW,GAAG,eAAe,CAAC,EAAE,IAAI,EAAE,uBAAuB,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;AAClG,IAAI,CAAC,WAAW,EAAE,CAAC;IAClB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;AAC/D,CAAC;AACD,MAAM,CAAC,MAAM,UAAU,GAAG,WAAW,CAAC"}
1
+ {"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/common/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEhD,MAAM,UAAU,UAAU;IACzB,OAAO,CAAC,GAAG,CACV;;;;;;;;;;;;;;;;CAgBD,CAAC,IAAI,EAAE,CACN,CAAC;AACH,CAAC;AAED,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IACrB,iCAAmB,CAAA;IACnB,mCAAqB,CAAA;IACrB,mCAAqB,CAAA;IACrB,mCAAqB,CAAA;AACtB,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB;AAgBD,MAAM,CAAC,KAAK,UAAU,SAAS;IAC9B,IAAI,CAAC;QACJ,OAAO,MAAM,UAAU,EAAE,CAAC;IAC3B,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QACjB,UAAU,EAAE,CAAC;QAEb,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QACxB,QAAQ,CAAC,CAAC,CAAC,CAAC;IACb,CAAC;AACF,CAAC;AACD,KAAK,UAAU,UAAU;IACxB,MAAM,IAAI,GAAG,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAErD,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;QACrC,UAAU,EAAE,CAAC;QACb,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC;IAED,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC;IACnD,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC;IACnD,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC;IACrD,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;IACnD,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;IACrD,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;IACrD,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC;IACzD,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC;IAChD,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;IAChD,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC;IAElD,IAAI,UAAU,GAAG,UAAU,CAAC,QAAQ,CAAC;IACrC,IAAI,SAAS,KAAK,CAAC,EAAE,CAAC;QACrB,UAAU,GAAG,UAAU,CAAC,QAAQ,CAAC;IAClC,CAAC;SAAM,IAAI,SAAS,KAAK,CAAC,EAAE,CAAC;QAC5B,UAAU,GAAG,UAAU,CAAC,QAAQ,CAAC;IAClC,CAAC;SAAM,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;QAC1B,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC;IACjC,CAAC;IAED,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC9B,IAAI,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YAC1D,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,UAAU,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACvD,CAAC;IACF,CAAC;IAED,IAAI,WAAW,EAAE,CAAC;QACjB,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;SAAM,IAAI,SAAS,EAAE,CAAC;QACtB,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC;QAC1B,MAAM,CAAC,KAAK,CAAA,aAAa,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACpD,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED,IAAI,cAAc,IAAI,cAAc,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;QACjD,MAAM,CAAC,KAAK,CAAA,wBAAwB,cAAc,GAAG,CAAC;QACtD,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC5B,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACpC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAEtE,OAAO;QACN,UAAU;QACV,UAAU,EAAE,UAAU,UAAU,IAAI,WAAW,OAAO;QACtD,SAAS;QACT,SAAS;QACT,UAAU;QACV,eAAe;QACf,eAAe;QACf,cAAc;QACd,QAAQ,EAAE,SAAS;QACnB,OAAO;QACP,WAAW;KACX,CAAC;AACH,CAAC;AAID,MAAM,WAAW,GAAG,eAAe,CAAC,EAAE,IAAI,EAAE,uBAAuB,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;AAClG,IAAI,CAAC,WAAW,EAAE,CAAC;IAClB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;AAC/D,CAAC;AACD,MAAM,CAAC,MAAM,UAAU,GAAG,WAAW,CAAC"}
@@ -10,6 +10,7 @@ export interface IContext {
10
10
  stripTags: string[];
11
11
  project: string;
12
12
  verboseMode: boolean;
13
+ banner: string;
13
14
  }
14
15
  export declare function createContext(args: ICliArgs, logger: IMyLogger): Promise<IContext>;
15
16
  //# sourceMappingURL=config.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/common/config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAGjD,OAAO,EAA0B,KAAK,QAAQ,EAAE,MAAM,UAAU,CAAC;AAWjE,MAAM,WAAW,QAAQ;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,cAAc,EAAE,SAAS,GAAG,MAAM,CAAC;IACnC,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;CACrB;AAsDD,wBAAsB,aAAa,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,CA2BxF"}
1
+ {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/common/config.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAIjD,OAAO,EAA0B,KAAK,QAAQ,EAAE,MAAM,UAAU,CAAC;AAYjE,MAAM,WAAW,QAAQ;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,cAAc,EAAE,SAAS,GAAG,MAAM,CAAC;IACnC,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CACf;AA0ED,wBAAsB,aAAa,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,CA6BxF"}
@@ -1,13 +1,15 @@
1
1
  import { NotFoundError, ProjectConfig } from '@build-script/rushstack-config-loader';
2
+ import { ExitCode } from '@idlebox/common';
2
3
  import { findUpUntilSync, shutdown } from '@idlebox/node';
3
- import { resolve } from 'node:path';
4
+ import { readFile } from 'node:fs/promises';
5
+ import { basename, resolve } from 'node:path';
4
6
  import { ConfigKind, schemaFile } from './cli.js';
5
- async function loadConfigFile(configType, context, logger) {
7
+ async function loadConfigFile(configType, configFile, context, logger) {
6
8
  if (configType === ConfigKind.DISABLE) {
7
- logger.debug `由于命令行参数,跳过配置文件: config/autoindex.json`;
9
+ logger.debug `由于命令行参数,跳过配置文件: ${configFile}`;
8
10
  return;
9
11
  }
10
- logger.debug `即将加载配置文件: config/autoindex.json`;
12
+ logger.debug `即将加载配置文件: ${configFile}`;
11
13
  logger.verbose `使用schema文件: ${schemaFile}`;
12
14
  const packageJsonFile = findUpUntilSync({ file: ['package.json', 'package.yaml'], from: context.project ?? process.cwd() });
13
15
  if (!packageJsonFile) {
@@ -18,7 +20,7 @@ async function loadConfigFile(configType, context, logger) {
18
20
  const projectRoot = resolve(packageJsonFile, '..');
19
21
  const config = new ProjectConfig(projectRoot, undefined, logger);
20
22
  try {
21
- const configFileData = config.loadSingleJson('autoindex', schemaFile);
23
+ const configFileData = config.loadSingleJson(basename(configFile, '.json'), schemaFile);
22
24
  logger.verbose `内容: ${configFileData}`;
23
25
  if (!context.project) {
24
26
  if (!configFileData.project) {
@@ -43,10 +45,30 @@ async function loadConfigFile(configType, context, logger) {
43
45
  context.stripTags = [];
44
46
  if (configFileData.stripTags?.length)
45
47
  context.stripTags.push(...configFileData.stripTags);
48
+ if (configFileData.banner) {
49
+ if (context.banner)
50
+ context.banner += '\n';
51
+ let banner = configFileData.banner;
52
+ if (banner.startsWith('@')) {
53
+ const info = config.getFileInfo(banner.slice(1));
54
+ if (!info.effective) {
55
+ logger.error `无法加载banner文件: ${banner}`;
56
+ shutdown(1);
57
+ }
58
+ banner = await readFile(info.effective, 'utf-8');
59
+ }
60
+ context.banner += banner;
61
+ }
46
62
  }
47
63
  catch (e) {
48
64
  if (e instanceof NotFoundError) {
49
- logger.verbose `由于文件不存在,未使用配置文件(${e})`;
65
+ if (configType === ConfigKind.REQUIRED) {
66
+ logger.error(`无法加载配置文件: ${e.message}`);
67
+ shutdown(ExitCode.USAGE);
68
+ }
69
+ else {
70
+ logger.verbose `由于文件不存在,未使用配置文件(${e})`;
71
+ }
50
72
  }
51
73
  else {
52
74
  throw e;
@@ -64,15 +86,17 @@ export async function createContext(args, logger) {
64
86
  stripTags: args.skipTags,
65
87
  project: args.project,
66
88
  verboseMode: args.verboseMode,
89
+ banner: '',
67
90
  };
68
- await loadConfigFile(args.configType, context, logger);
91
+ await loadConfigFile(args.configType, args.configFile, context, logger);
69
92
  if (!context.outputFile) {
70
93
  context.outputFile = './autoindex.generated';
71
94
  }
72
95
  if (!context.project) {
73
96
  if (args.configType === ConfigKind.IMPLICIT) {
74
97
  // 如果是隐式配置,则必须在命令行中指定项目路径
75
- logger.fatal `未指定项目路径,需要额外参数或在配置文件中指定`;
98
+ logger.error `未指定项目路径,需要额外参数或在配置文件中指定`;
99
+ shutdown(ExitCode.USAGE);
76
100
  }
77
101
  }
78
102
  logger.verbose `最终配置: ${context}`;
@@ -1 +1 @@
1
- {"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/common/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AAErF,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC1D,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,UAAU,EAAiB,MAAM,UAAU,CAAC;AAuBjE,KAAK,UAAU,cAAc,CAAC,UAAsB,EAAE,OAA0B,EAAE,MAAiB;IAClG,IAAI,UAAU,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC;QACvC,MAAM,CAAC,KAAK,CAAA,uCAAuC,CAAC;QACpD,OAAO;IACR,CAAC;IAED,MAAM,CAAC,KAAK,CAAA,iCAAiC,CAAC;IAC9C,MAAM,CAAC,OAAO,CAAA,eAAe,UAAU,EAAE,CAAC;IAE1C,MAAM,eAAe,GAAG,eAAe,CAAC,EAAE,IAAI,EAAE,CAAC,cAAc,EAAE,cAAc,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5H,IAAI,CAAC,eAAe,EAAE,CAAC;QACtB,MAAM,CAAC,KAAK,CAAA,yBAAyB,CAAC;QACtC,QAAQ,CAAC,CAAC,CAAC,CAAC;IACb,CAAC;IACD,MAAM,CAAC,KAAK,CAAA,cAAc,eAAe,EAAE,CAAC;IAC5C,MAAM,WAAW,GAAG,OAAO,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IAEnD,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,WAAW,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAEjE,IAAI,CAAC;QACJ,MAAM,cAAc,GAAG,MAAM,CAAC,cAAc,CAAc,WAAW,EAAE,UAAU,CAAC,CAAC;QACnF,MAAM,CAAC,OAAO,CAAA,OAAO,cAAc,EAAE,CAAC;QAEtC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACtB,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;gBAC7B,MAAM,CAAC,KAAK,CAAA,qBAAqB,CAAC;gBAClC,QAAQ,CAAC,CAAC,CAAC,CAAC;YACb,CAAC;YACD,OAAO,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC;QAC1C,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,cAAc,IAAI,cAAc,CAAC,QAAQ;YAAE,OAAO,CAAC,cAAc,GAAG,cAAc,CAAC,QAAQ,CAAC;QAEzG,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,cAAc,CAAC,MAAM;YAAE,OAAO,CAAC,UAAU,GAAG,cAAc,CAAC,MAAM,CAAC;QAE7F,IAAI,CAAC,OAAO,CAAC,eAAe;YAAE,OAAO,CAAC,eAAe,GAAG,EAAE,CAAC;QAC3D,IAAI,cAAc,CAAC,OAAO,EAAE,MAAM;YAAE,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;QAE5F,IAAI,CAAC,OAAO,CAAC,eAAe;YAAE,OAAO,CAAC,eAAe,GAAG,EAAE,CAAC;QAC3D,IAAI,cAAc,CAAC,OAAO,EAAE,MAAM;YAAE,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;QAE5F,IAAI,CAAC,OAAO,CAAC,SAAS;YAAE,OAAO,CAAC,SAAS,GAAG,EAAE,CAAC;QAC/C,IAAI,cAAc,CAAC,SAAS,EAAE,MAAM;YAAE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;IAC3F,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACrB,IAAI,CAAC,YAAY,aAAa,EAAE,CAAC;YAChC,MAAM,CAAC,OAAO,CAAA,mBAAmB,CAAC,GAAG,CAAC;QACvC,CAAC;aAAM,CAAC;YACP,MAAM,CAAC,CAAC;QACT,CAAC;IACF,CAAC;AACF,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,IAAc,EAAE,MAAiB;IACpE,MAAM,OAAO,GAAsB;QAClC,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,cAAc,EAAE,SAAS;QACzB,SAAS,EAAE,IAAI,CAAC,QAAQ;QACxB,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,WAAW,EAAE,IAAI,CAAC,WAAW;KAC7B,CAAC;IAEF,MAAM,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAEvD,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;QACzB,OAAO,CAAC,UAAU,GAAG,uBAAuB,CAAC;IAC9C,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACtB,IAAI,IAAI,CAAC,UAAU,KAAK,UAAU,CAAC,QAAQ,EAAE,CAAC;YAC7C,yBAAyB;YACzB,MAAM,CAAC,KAAK,CAAA,yBAAyB,CAAC;QACvC,CAAC;IACF,CAAC;IAED,MAAM,CAAC,OAAO,CAAA,SAAS,OAAO,EAAE,CAAC;IACjC,OAAO,OAAmB,CAAC;AAC5B,CAAC"}
1
+ {"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/common/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACrF,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,UAAU,EAAiB,MAAM,UAAU,CAAC;AAyBjE,KAAK,UAAU,cAAc,CAAC,UAAsB,EAAE,UAAkB,EAAE,OAA0B,EAAE,MAAiB;IACtH,IAAI,UAAU,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC;QACvC,MAAM,CAAC,KAAK,CAAA,mBAAmB,UAAU,EAAE,CAAC;QAC5C,OAAO;IACR,CAAC;IAED,MAAM,CAAC,KAAK,CAAA,aAAa,UAAU,EAAE,CAAC;IACtC,MAAM,CAAC,OAAO,CAAA,eAAe,UAAU,EAAE,CAAC;IAE1C,MAAM,eAAe,GAAG,eAAe,CAAC,EAAE,IAAI,EAAE,CAAC,cAAc,EAAE,cAAc,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5H,IAAI,CAAC,eAAe,EAAE,CAAC;QACtB,MAAM,CAAC,KAAK,CAAA,yBAAyB,CAAC;QACtC,QAAQ,CAAC,CAAC,CAAC,CAAC;IACb,CAAC;IACD,MAAM,CAAC,KAAK,CAAA,cAAc,eAAe,EAAE,CAAC;IAC5C,MAAM,WAAW,GAAG,OAAO,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IAEnD,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,WAAW,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAEjE,IAAI,CAAC;QACJ,MAAM,cAAc,GAAG,MAAM,CAAC,cAAc,CAAc,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,UAAU,CAAC,CAAC;QACrG,MAAM,CAAC,OAAO,CAAA,OAAO,cAAc,EAAE,CAAC;QAEtC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACtB,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;gBAC7B,MAAM,CAAC,KAAK,CAAA,qBAAqB,CAAC;gBAClC,QAAQ,CAAC,CAAC,CAAC,CAAC;YACb,CAAC;YACD,OAAO,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC;QAC1C,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,cAAc,IAAI,cAAc,CAAC,QAAQ;YAAE,OAAO,CAAC,cAAc,GAAG,cAAc,CAAC,QAAQ,CAAC;QAEzG,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,cAAc,CAAC,MAAM;YAAE,OAAO,CAAC,UAAU,GAAG,cAAc,CAAC,MAAM,CAAC;QAE7F,IAAI,CAAC,OAAO,CAAC,eAAe;YAAE,OAAO,CAAC,eAAe,GAAG,EAAE,CAAC;QAC3D,IAAI,cAAc,CAAC,OAAO,EAAE,MAAM;YAAE,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;QAE5F,IAAI,CAAC,OAAO,CAAC,eAAe;YAAE,OAAO,CAAC,eAAe,GAAG,EAAE,CAAC;QAC3D,IAAI,cAAc,CAAC,OAAO,EAAE,MAAM;YAAE,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;QAE5F,IAAI,CAAC,OAAO,CAAC,SAAS;YAAE,OAAO,CAAC,SAAS,GAAG,EAAE,CAAC;QAC/C,IAAI,cAAc,CAAC,SAAS,EAAE,MAAM;YAAE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;QAE1F,IAAI,cAAc,CAAC,MAAM,EAAE,CAAC;YAC3B,IAAI,OAAO,CAAC,MAAM;gBAAE,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC;YAC3C,IAAI,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC;YACnC,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBACjD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;oBACrB,MAAM,CAAC,KAAK,CAAA,iBAAiB,MAAM,EAAE,CAAC;oBACtC,QAAQ,CAAC,CAAC,CAAC,CAAC;gBACb,CAAC;gBAED,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YAClD,CAAC;YACD,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC;QAC1B,CAAC;IACF,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACrB,IAAI,CAAC,YAAY,aAAa,EAAE,CAAC;YAChC,IAAI,UAAU,KAAK,UAAU,CAAC,QAAQ,EAAE,CAAC;gBACxC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;gBACvC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACP,MAAM,CAAC,OAAO,CAAA,mBAAmB,CAAC,GAAG,CAAC;YACvC,CAAC;QACF,CAAC;aAAM,CAAC;YACP,MAAM,CAAC,CAAC;QACT,CAAC;IACF,CAAC;AACF,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,IAAc,EAAE,MAAiB;IACpE,MAAM,OAAO,GAAsB;QAClC,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,cAAc,EAAE,SAAS;QACzB,SAAS,EAAE,IAAI,CAAC,QAAQ;QACxB,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,MAAM,EAAE,EAAE;KACV,CAAC;IAEF,MAAM,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAExE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;QACzB,OAAO,CAAC,UAAU,GAAG,uBAAuB,CAAC;IAC9C,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACtB,IAAI,IAAI,CAAC,UAAU,KAAK,UAAU,CAAC,QAAQ,EAAE,CAAC;YAC7C,yBAAyB;YACzB,MAAM,CAAC,KAAK,CAAA,yBAAyB,CAAC;YACtC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC1B,CAAC;IACF,CAAC;IAED,MAAM,CAAC,OAAO,CAAA,SAAS,OAAO,EAAE,CAAC;IACjC,OAAO,OAAmB,CAAC;AAC5B,CAAC"}
@@ -11,12 +11,13 @@ export interface ICreateIndexContext {
11
11
  outputFileAbs: string;
12
12
  logger: IMyLogger;
13
13
  verbose?: boolean;
14
+ banner?: string;
14
15
  }
15
16
  export declare function createStandaloneIgnore(logger: IMyLogger, outputFileAbs: string, extraExcludes?: readonly string[]): IgnoreFiles;
16
17
  interface IRet {
17
18
  watchFiles: string[];
18
19
  ignores: IgnoreFiles;
19
20
  }
20
- export declare function createIndex({ logger, outputFileAbs, project, ts, absoluteImport, extraExcludes, stripTags, }: ICreateIndexContext): Promise<IRet>;
21
+ export declare function createIndex({ logger, outputFileAbs, project, ts, absoluteImport, extraExcludes, stripTags, banner, }: ICreateIndexContext): Promise<IRet>;
21
22
  export {};
22
23
  //# sourceMappingURL=create.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../src/common/create.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAc,WAAW,EAAmE,MAAM,sCAAsC,CAAC;AAEhJ,OAAO,KAAK,aAAa,MAAM,YAAY,CAAC;AAE5C,wBAAgB,UAAU,CAAC,EAAE,EAAE,OAAO,aAAa,EAAE,EAAE,EAAE,aAAa,CAAC,aAAa,GAAG,aAAa,CAAC,UAAU,UAK9G;AAED,MAAM,WAAW,mBAAmB;IACnC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC9B,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,EAAE,EAAE,OAAO,aAAa,CAAC;IACzB,OAAO,EAAE,aAAa,CAAC,iBAAiB,CAAC;IACzC,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,eAIjH;AAiBD,UAAU,IAAI;IACb,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,OAAO,EAAE,WAAW,CAAC;CACrB;AAMD,wBAAsB,WAAW,CAAC,EACjC,MAAM,EACN,aAAa,EACb,OAAO,EACP,EAAE,EACF,cAAc,EACd,aAAkB,EAClB,SAAwB,GACxB,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAuFrC"}
1
+ {"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../src/common/create.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAc,WAAW,EAAmE,MAAM,sCAAsC,CAAC;AAEhJ,OAAO,KAAK,aAAa,MAAM,YAAY,CAAC;AAG5C,wBAAgB,UAAU,CAAC,EAAE,EAAE,OAAO,aAAa,EAAE,EAAE,EAAE,aAAa,CAAC,aAAa,GAAG,aAAa,CAAC,UAAU,UAK9G;AAED,MAAM,WAAW,mBAAmB;IACnC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC9B,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,EAAE,EAAE,OAAO,aAAa,CAAC;IACzB,OAAO,EAAE,aAAa,CAAC,iBAAiB,CAAC;IACzC,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,eAIjH;AAiBD,UAAU,IAAI;IACb,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,OAAO,EAAE,WAAW,CAAC;CACrB;AAMD,wBAAsB,WAAW,CAAC,EACjC,MAAM,EACN,aAAa,EACb,OAAO,EACP,EAAE,EACF,cAAc,EACd,aAAkB,EAClB,SAAwB,EACxB,MAAW,GACX,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAuFrC"}
@@ -1,7 +1,8 @@
1
1
  import { camelCase, ucfirst } from '@idlebox/common';
2
2
  import { ensureParentExists, relativePath, writeFileIfChange } from '@idlebox/node';
3
3
  import { ExportKind, IgnoreFiles, TypescriptProject } from '@idlebox/typescript-surface-analyzer';
4
- import { basename, dirname } from 'node:path';
4
+ import { dirname } from 'node:path';
5
+ import { headerComments, linterInstructions } from './modify-comment.js';
5
6
  export function idToString(ts, id) {
6
7
  if (ts.isIdentifier(id)) {
7
8
  return id.escapedText.toString();
@@ -30,7 +31,7 @@ function applyIgnores(ignores, outputFileAbs, extraExcludes) {
30
31
  function sort_file(a, b) {
31
32
  return a.relativePath.localeCompare(b.relativePath);
32
33
  }
33
- export async function createIndex({ logger, outputFileAbs, project, ts, absoluteImport, extraExcludes = [], stripTags = ['internal'], }) {
34
+ export async function createIndex({ logger, outputFileAbs, project, ts, absoluteImport, extraExcludes = [], stripTags = ['internal'], banner = '', }) {
34
35
  if (!project.options.rootDir || !project.options.configFilePath) {
35
36
  logger.error('%o', project.options);
36
37
  throw new Error(`missing rootDir and {internal}configFilePath`);
@@ -51,12 +52,12 @@ export async function createIndex({ logger, outputFileAbs, project, ts, absolute
51
52
  logger.debug('rootDir: %s', project.options.rootDir);
52
53
  logger.debug('configFilePath: %s', project.options.configFilePath);
53
54
  logger.debug('index dir: %s', indexDir);
54
- const header = ['// DO NOT EDIT THIS FILE', '// @ts-ignore', '/* eslint-disable */'];
55
+ const header = [headerComments, banner, linterInstructions];
55
56
  const content = [];
56
57
  const input_files = [];
57
58
  for (const file of list.sort(sort_file)) {
58
59
  if (file.absolutePath === outputFileAbs) {
59
- throw new Error(`override output file: ${outputFileAbs} (are you import xxx from ${basename(outputFileAbs)}?)`);
60
+ throw new Error(`override source file: ${outputFileAbs}`);
60
61
  }
61
62
  const path = importSpec(absoluteImport ?? indexDir, file.relativePath);
62
63
  content.push(`/* ${file.relativePath} */`);
@@ -1 +1 @@
1
- {"version":3,"file":"create.js","sourceRoot":"","sources":["../../src/common/create.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAErD,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACpF,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,iBAAiB,EAAgD,MAAM,sCAAsC,CAAC;AAChJ,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAG9C,MAAM,UAAU,UAAU,CAAC,EAAwB,EAAE,EAA0D;IAC9G,IAAI,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC;QACzB,OAAO,EAAE,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;IAClC,CAAC;IACD,OAAO,EAAE,CAAC,IAAI,CAAC;AAChB,CAAC;AAaD,MAAM,UAAU,sBAAsB,CAAC,MAAiB,EAAE,aAAqB,EAAE,aAAiC;IACjH,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;IACxC,YAAY,CAAC,OAAO,EAAE,aAAa,EAAE,aAAa,CAAC,CAAC;IACpD,OAAO,OAAO,CAAC;AAChB,CAAC;AAED,SAAS,YAAY,CAAC,OAAoB,EAAE,aAAqB,EAAE,aAAiC;IACnG,OAAO,CAAC,GAAG,CAAC,SAAS,iBAAiB,CAAC,CAAS;QAC/C,OAAO,CAAC,KAAK,aAAa,CAAC;IAC5B,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAC5B,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IAC7B,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAC9B,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;IAClC,IAAI,aAAa,EAAE,CAAC;QACnB,KAAK,MAAM,OAAO,IAAI,aAAa,EAAE,CAAC;YACrC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACtB,CAAC;IACF,CAAC;AACF,CAAC;AAOD,SAAS,SAAS,CAAC,CAAkB,EAAE,CAAkB;IACxD,OAAO,CAAC,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,EACjC,MAAM,EACN,aAAa,EACb,OAAO,EACP,EAAE,EACF,cAAc,EACd,aAAa,GAAG,EAAE,EAClB,SAAS,GAAG,CAAC,UAAU,CAAC,GACH;IACrB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;QACjE,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IACjE,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,oBAAoB,OAAO,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IACvE,CAAC;IAED,MAAM,CAAC,GAAG,IAAI,iBAAiB,CAAC,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IACrD,MAAM,CAAC,GAAG,CAAC,yBAAyB,EAAE,aAAa,CAAC,CAAC;IACrD,YAAY,CAAC,CAAC,CAAC,iBAAiB,EAAE,aAAa,EAAE,aAAa,CAAC,CAAC;IAEhE,MAAM,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAElC,MAAM,QAAQ,GAAG,KAAK,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,cAAwB,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;SACtI,KAAK,CAAC,GAAG,CAAC;SACV,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC;SAC7B,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;SACf,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;IACd,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACrD,MAAM,CAAC,KAAK,CAAC,oBAAoB,EAAE,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IACnE,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;IACxC,MAAM,MAAM,GAAG,CAAC,0BAA0B,EAAE,eAAe,EAAE,sBAAsB,CAAC,CAAC;IACrF,MAAM,OAAO,GAAG,EAAE,CAAC;IACnB,MAAM,WAAW,GAAG,EAAE,CAAC;IACvB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QACzC,IAAI,IAAI,CAAC,YAAY,KAAK,aAAa,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CAAC,yBAAyB,aAAa,6BAA6B,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACjH,CAAC;QAED,MAAM,IAAI,GAAG,UAAU,CAAC,cAAc,IAAI,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACvE,OAAO,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,YAAY,KAAK,CAAC,CAAC;QAE3C,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACjC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,EAAE,CAAC;gBAC7C,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;oBACnB,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,IAAI,GAAG,CAAC,SAAS,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;wBACxD,gCAAgC;wBAChC,SAAS;oBACV,CAAC;gBACF,CAAC;gBACD,OAAO,CAAC,IAAI,CAAC,YAAY,OAAO,CAAC,GAAG,CAAC,KAAK,UAAU,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,CAAC,YAAY,IAAI,IAAI,CAAC,CAAC;YACvF,CAAC;QACF,CAAC;QACD,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YAC5B,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAChC,KAAK,MAAM,EAAE,SAAS,EAAE,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBAC7C,IAAI,SAAS,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;oBAC/B,OAAO,CAAC,IAAI,CAAC,oBAAoB,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;gBACxF,CAAC;qBAAM,CAAC;oBACP,OAAO,CAAC,IAAI,CAAC,oBAAoB,SAAS,CAAC,IAAI,IAAI,CAAC,CAAC;gBACtD,CAAC;YACF,CAAC;QACF,CAAC;QACD,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAC7B,IAAI,EAAE,GAAG,EAAE,CAAC;YACZ,IAAI,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;gBAC3B,EAAE,GAAG,UAAU,CAAC,EAAE,EAAE,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;YAC5C,CAAC;iBAAM,CAAC;gBACP,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAClC,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,KAAK,UAAU,CAAC,KAAK,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,EAAE,CAAC;oBACjG,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;gBAClB,CAAC;YACF,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,YAAY,IAAI,IAAI,CAAC,CAAC;QAC/D,CAAC;QAED,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACrC,CAAC;IAED,MAAM,kBAAkB,CAAC,aAAa,CAAC,CAAC;IACxC,MAAM,CAAC,GAAG,MAAM,iBAAiB,CAAC,aAAa,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAElG,IAAI,CAAC,EAAE,CAAC;QACP,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAChC,CAAC;SAAM,CAAC;QACP,MAAM,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;IAC3C,CAAC;IAED,OAAO;QACN,UAAU,EAAE,WAAW;QACvB,OAAO,EAAE,CAAC,CAAC,iBAAiB;KAC5B,CAAC;AACH,CAAC;AAED,MAAM,KAAK,GAAG,SAAS,CAAC;AACxB,MAAM,aAAa,GAAG,aAAa,CAAC;AACpC,SAAS,UAAU,CAAC,QAAgB,EAAE,MAAc;IACnD,OAAO,GAAG,QAAQ,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;AAC1G,CAAC;AAED,SAAS,OAAO,CAAC,GAAsB;IACtC,IAAI,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,EAAE,CAAC;QAClC,OAAO,OAAO,CAAC;IAChB,CAAC;IACD,OAAO,EAAE,CAAC;AACX,CAAC"}
1
+ {"version":3,"file":"create.js","sourceRoot":"","sources":["../../src/common/create.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAErD,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACpF,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,iBAAiB,EAAgD,MAAM,sCAAsC,CAAC;AAChJ,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAEzE,MAAM,UAAU,UAAU,CAAC,EAAwB,EAAE,EAA0D;IAC9G,IAAI,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC;QACzB,OAAO,EAAE,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;IAClC,CAAC;IACD,OAAO,EAAE,CAAC,IAAI,CAAC;AAChB,CAAC;AAcD,MAAM,UAAU,sBAAsB,CAAC,MAAiB,EAAE,aAAqB,EAAE,aAAiC;IACjH,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;IACxC,YAAY,CAAC,OAAO,EAAE,aAAa,EAAE,aAAa,CAAC,CAAC;IACpD,OAAO,OAAO,CAAC;AAChB,CAAC;AAED,SAAS,YAAY,CAAC,OAAoB,EAAE,aAAqB,EAAE,aAAiC;IACnG,OAAO,CAAC,GAAG,CAAC,SAAS,iBAAiB,CAAC,CAAS;QAC/C,OAAO,CAAC,KAAK,aAAa,CAAC;IAC5B,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAC5B,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IAC7B,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAC9B,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;IAClC,IAAI,aAAa,EAAE,CAAC;QACnB,KAAK,MAAM,OAAO,IAAI,aAAa,EAAE,CAAC;YACrC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACtB,CAAC;IACF,CAAC;AACF,CAAC;AAOD,SAAS,SAAS,CAAC,CAAkB,EAAE,CAAkB;IACxD,OAAO,CAAC,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,EACjC,MAAM,EACN,aAAa,EACb,OAAO,EACP,EAAE,EACF,cAAc,EACd,aAAa,GAAG,EAAE,EAClB,SAAS,GAAG,CAAC,UAAU,CAAC,EACxB,MAAM,GAAG,EAAE,GACU;IACrB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;QACjE,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IACjE,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,oBAAoB,OAAO,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IACvE,CAAC;IAED,MAAM,CAAC,GAAG,IAAI,iBAAiB,CAAC,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IACrD,MAAM,CAAC,GAAG,CAAC,yBAAyB,EAAE,aAAa,CAAC,CAAC;IACrD,YAAY,CAAC,CAAC,CAAC,iBAAiB,EAAE,aAAa,EAAE,aAAa,CAAC,CAAC;IAEhE,MAAM,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAElC,MAAM,QAAQ,GAAG,KAAK,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,cAAwB,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;SACtI,KAAK,CAAC,GAAG,CAAC;SACV,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC;SAC7B,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;SACf,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;IACd,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACrD,MAAM,CAAC,KAAK,CAAC,oBAAoB,EAAE,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IACnE,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;IACxC,MAAM,MAAM,GAAG,CAAC,cAAc,EAAE,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAC5D,MAAM,OAAO,GAAG,EAAE,CAAC;IACnB,MAAM,WAAW,GAAG,EAAE,CAAC;IACvB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QACzC,IAAI,IAAI,CAAC,YAAY,KAAK,aAAa,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CAAC,yBAAyB,aAAa,EAAE,CAAC,CAAC;QAC3D,CAAC;QAED,MAAM,IAAI,GAAG,UAAU,CAAC,cAAc,IAAI,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACvE,OAAO,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,YAAY,KAAK,CAAC,CAAC;QAE3C,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACjC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,EAAE,CAAC;gBAC7C,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;oBACnB,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,IAAI,GAAG,CAAC,SAAS,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;wBACxD,gCAAgC;wBAChC,SAAS;oBACV,CAAC;gBACF,CAAC;gBACD,OAAO,CAAC,IAAI,CAAC,YAAY,OAAO,CAAC,GAAG,CAAC,KAAK,UAAU,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,CAAC,YAAY,IAAI,IAAI,CAAC,CAAC;YACvF,CAAC;QACF,CAAC;QACD,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YAC5B,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAChC,KAAK,MAAM,EAAE,SAAS,EAAE,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBAC7C,IAAI,SAAS,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;oBAC/B,OAAO,CAAC,IAAI,CAAC,oBAAoB,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;gBACxF,CAAC;qBAAM,CAAC;oBACP,OAAO,CAAC,IAAI,CAAC,oBAAoB,SAAS,CAAC,IAAI,IAAI,CAAC,CAAC;gBACtD,CAAC;YACF,CAAC;QACF,CAAC;QACD,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAC7B,IAAI,EAAE,GAAG,EAAE,CAAC;YACZ,IAAI,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;gBAC3B,EAAE,GAAG,UAAU,CAAC,EAAE,EAAE,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;YAC5C,CAAC;iBAAM,CAAC;gBACP,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAClC,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,KAAK,UAAU,CAAC,KAAK,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,EAAE,CAAC;oBACjG,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;gBAClB,CAAC;YACF,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,YAAY,IAAI,IAAI,CAAC,CAAC;QAC/D,CAAC;QAED,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACrC,CAAC;IAED,MAAM,kBAAkB,CAAC,aAAa,CAAC,CAAC;IACxC,MAAM,CAAC,GAAG,MAAM,iBAAiB,CAAC,aAAa,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAElG,IAAI,CAAC,EAAE,CAAC;QACP,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAChC,CAAC;SAAM,CAAC;QACP,MAAM,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;IAC3C,CAAC;IAED,OAAO;QACN,UAAU,EAAE,WAAW;QACvB,OAAO,EAAE,CAAC,CAAC,iBAAiB;KAC5B,CAAC;AACH,CAAC;AAED,MAAM,KAAK,GAAG,SAAS,CAAC;AACxB,MAAM,aAAa,GAAG,aAAa,CAAC;AACpC,SAAS,UAAU,CAAC,QAAgB,EAAE,MAAc;IACnD,OAAO,GAAG,QAAQ,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;AAC1G,CAAC;AAED,SAAS,OAAO,CAAC,GAAsB;IACtC,IAAI,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,EAAE,CAAC;QAClC,OAAO,OAAO,CAAC;IAChB,CAAC;IACD,OAAO,EAAE,CAAC;AACX,CAAC"}
@@ -0,0 +1,3 @@
1
+ export declare const headerComments: string;
2
+ export declare const linterInstructions: string;
3
+ //# sourceMappingURL=modify-comment.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"modify-comment.d.ts","sourceRoot":"","sources":["../../src/common/modify-comment.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,cAAc,QASnB,CAAC;AAET,eAAO,MAAM,kBAAkB,QAKvB,CAAC"}
@@ -0,0 +1,18 @@
1
+ import pkgJson from '../../package.json' with { type: 'json' };
2
+ export const headerComments = `
3
+ /******************************************************************************
4
+ * GENERATED FILE, DO NOT MODIFY
5
+ * 这是生成的文件,千万不要修改
6
+ *
7
+ * ${pkgJson.name} - Automatic TypeScript index file generator
8
+ * https://github.com/GongT/baobao
9
+ *
10
+ ******************************************************************************/
11
+ `.trim();
12
+ export const linterInstructions = `
13
+ // biome-ignore-all lint: generated file
14
+ // biome-ignore-all assist: generated file
15
+ /* eslint-disable */
16
+ // @ts-ignore
17
+ `.trim();
18
+ //# sourceMappingURL=modify-comment.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"modify-comment.js","sourceRoot":"","sources":["../../src/common/modify-comment.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,oBAAoB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAC/D,MAAM,CAAC,MAAM,cAAc,GAAG;;;;;KAKzB,OAAO,CAAC,IAAI;;;;CAIhB,CAAC,IAAI,EAAE,CAAC;AAET,MAAM,CAAC,MAAM,kBAAkB,GAAG;;;;;CAKjC,CAAC,IAAI,EAAE,CAAC"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@build-script/autoindex",
3
3
  "type": "module",
4
- "version": "0.0.11",
4
+ "version": "0.0.13",
5
5
  "bin": {
6
6
  "autoindex": "./loader/bin.js"
7
7
  },
@@ -13,25 +13,25 @@
13
13
  "./package.json": "./package.json"
14
14
  },
15
15
  "dependencies": {
16
- "comment-json": "^4.2.5",
17
- "glob": "^11.0.3",
16
+ "comment-json": "^4.5.1",
17
+ "glob": "^13.0.0",
18
18
  "tslib": "^2.8.1",
19
- "typescript": "^5.8.3",
20
- "@build-script/rushstack-config-loader": "^0.0.27",
21
- "@idlebox/common": "^1.5.3",
22
- "@idlebox/chokidar": "^0.1.11",
23
- "@idlebox/logger": "^0.0.12",
24
- "@idlebox/args": "^0.0.18",
25
- "@idlebox/node": "^1.4.18",
26
- "@idlebox/source-map-support": "^0.0.11",
27
- "@mpis/client": "^0.0.12",
28
- "@idlebox/typescript-surface-analyzer": "^0.0.32"
19
+ "typescript": "^5.9.3",
20
+ "@build-script/rushstack-config-loader": "^0.0.29",
21
+ "@idlebox/args": "^0.0.20",
22
+ "@idlebox/chokidar": "^0.1.12",
23
+ "@idlebox/common": "^1.5.11",
24
+ "@idlebox/logger": "^0.0.14",
25
+ "@idlebox/node": "^1.4.20",
26
+ "@idlebox/typescript-surface-analyzer": "^0.0.34",
27
+ "@idlebox/source-map-support": "^0.0.14",
28
+ "@mpis/client": "^0.0.14"
29
29
  },
30
30
  "devDependencies": {
31
- "@types/node": "^24.0.14",
31
+ "@types/node": "^25.0.8",
32
+ "@idlebox/esbuild-executer": "^0.0.10",
32
33
  "@build-script/single-dog-asset": "latest",
33
- "@idlebox/esbuild-executer": "^0.0.8",
34
- "@mpis/run": "^0.0.14"
34
+ "@mpis/run": "^0.0.17"
35
35
  },
36
36
  "sideEffects": false,
37
37
  "license": "MIT",
package/src/bin.ts CHANGED
@@ -68,6 +68,7 @@ async function main() {
68
68
  absoluteImport: context.absoluteImport,
69
69
  stripTags: context.stripTags,
70
70
  extraExcludes: context.excludePatterns,
71
+ banner: context.banner,
71
72
  });
72
73
 
73
74
  r.watchFiles.push(...configFiles);
package/src/common/cli.ts CHANGED
@@ -1,7 +1,8 @@
1
1
  import { createArgsReader } from '@idlebox/args';
2
+ import { ExitCode } from '@idlebox/common';
2
3
  import { EnableLogLevel, logger } from '@idlebox/logger';
3
4
  import { findUpUntilSync, shutdown } from '@idlebox/node';
4
- import { resolve } from 'node:path';
5
+ import { isAbsolute, resolve } from 'node:path';
5
6
 
6
7
  export function printUsage() {
7
8
  console.log(
@@ -10,13 +11,16 @@ Options:
10
11
  -w, --watch 监视模式
11
12
  -d, --debug 显示调试输出
12
13
  -C, --config 读取 config/autoindex.json 配置文件
14
+ 如果没有设置该选项,但配置文件存在,则默认读取配置文件
13
15
  如果设置了该选项,但是配置文件不存在,则直接退出,什么也不做
16
+ 如果设置了两次,但是配置文件不存在,则报告错误
17
+ --no-config 不要默认读取配置文件
18
+ --config-name <name> 读取指定的配置文件而不是“autoindex”(隐含-C)
14
19
  -o, --output <file> 输出文件路径(默认: autoindex.generated,相对于tsconfig.json所在目录)
15
20
  --exclude <pattern> 额外排除的文件或目录
16
21
  --include <pattern> 额外包含的文件或目录
17
22
  -a, --absolute <path> 绝对导入路径前缀
18
23
  --skip-tag <tag> 忽略被 @tag 注释的符号
19
- --no-config 忽略 "config/autoindex.json" 文件
20
24
  -h, --help 显示帮助信息
21
25
  `.trim(),
22
26
  );
@@ -26,6 +30,7 @@ export enum ConfigKind {
26
30
  DISABLE = 'disable',
27
31
  IMPLICIT = 'implicit',
28
32
  EXPLICIT = 'explicit',
33
+ REQUIRED = 'required',
29
34
  }
30
35
 
31
36
  export interface ICliArgs {
@@ -33,6 +38,7 @@ export interface ICliArgs {
33
38
  readonly watchMode: boolean;
34
39
  readonly debugMode: boolean;
35
40
  readonly outputFile?: string;
41
+ readonly configFile: string;
36
42
  readonly excludePatterns: string[];
37
43
  readonly includePatterns: string[];
38
44
  readonly absoluteImport?: string;
@@ -67,15 +73,27 @@ async function _parseArgs(): Promise<ICliArgs> {
67
73
  const includePatterns = argv.multiple(['--include']);
68
74
  const absoluteImport = argv.single(['-a', '--absolute']);
69
75
  const stripTags = argv.multiple(['--skip-tag']);
70
- const projVal = argv.range(0, 1)[0];
76
+ const useConfig = argv.flag(['-C', '--config']);
77
+ const configName = argv.single(['--config-name']);
71
78
 
72
79
  let configType = ConfigKind.IMPLICIT;
73
- if (argv.flag(['--config']) > 0) {
80
+ if (useConfig === 1) {
74
81
  configType = ConfigKind.EXPLICIT;
75
- } else if (argv.flag(['--config']) < 0) {
82
+ } else if (useConfig === 2) {
83
+ configType = ConfigKind.REQUIRED;
84
+ } else if (useConfig < 0) {
76
85
  configType = ConfigKind.DISABLE;
77
86
  }
78
87
 
88
+ if (configName !== undefined) {
89
+ if (configName.startsWith('.') || isAbsolute(configName)) {
90
+ throw new Error('--config-name 只能是一个简单的名称,不能包含路径部分');
91
+ }
92
+ if (configType === ConfigKind.DISABLE) {
93
+ throw new Error('--config-name 不能与 --no-config 一起使用');
94
+ }
95
+ }
96
+
79
97
  if (verboseMode) {
80
98
  logger.enable(EnableLogLevel.verbose);
81
99
  } else if (debugMode) {
@@ -83,22 +101,25 @@ async function _parseArgs(): Promise<ICliArgs> {
83
101
  }
84
102
 
85
103
  if (argv.unused().length) {
86
- logger.fatal`未知的命令行参数: ${argv.unused().join(', ')}`;
104
+ logger.error`未知的命令行参数: ${argv.unused().join(', ')}`;
105
+ shutdown(ExitCode.USAGE);
87
106
  }
88
107
 
89
108
  if (absoluteImport && absoluteImport[0] !== '#') {
90
109
  logger.error`绝对导入路径必须以'#'开头: long<${absoluteImport}>`;
91
- shutdown(1);
110
+ shutdown(ExitCode.USAGE);
92
111
  }
93
112
 
94
113
  if (stripTags.length === 0) {
95
114
  stripTags.push('internal');
96
115
  }
97
116
 
117
+ const projVal = argv.range(0, 1)[0];
98
118
  const project = projVal ? resolve(process.cwd(), projVal) : undefined;
99
119
 
100
120
  return {
101
121
  configType,
122
+ configFile: `config/${configName ?? 'autoindex'}.json`,
102
123
  watchMode,
103
124
  debugMode,
104
125
  outputFile,
@@ -1,7 +1,9 @@
1
1
  import { NotFoundError, ProjectConfig } from '@build-script/rushstack-config-loader';
2
+ import { ExitCode } from '@idlebox/common';
2
3
  import type { IMyLogger } from '@idlebox/logger';
3
4
  import { findUpUntilSync, shutdown } from '@idlebox/node';
4
- import { resolve } from 'node:path';
5
+ import { readFile } from 'node:fs/promises';
6
+ import { basename, resolve } from 'node:path';
5
7
  import { ConfigKind, schemaFile, type ICliArgs } from './cli.js';
6
8
 
7
9
  interface IConfigFile {
@@ -11,6 +13,7 @@ interface IConfigFile {
11
13
  exclude?: string[];
12
14
  stripTags?: string[];
13
15
  absolute?: string;
16
+ banner?: string;
14
17
  }
15
18
 
16
19
  export interface IContext {
@@ -23,15 +26,16 @@ export interface IContext {
23
26
  stripTags: string[];
24
27
  project: string;
25
28
  verboseMode: boolean;
29
+ banner: string;
26
30
  }
27
31
 
28
- async function loadConfigFile(configType: ConfigKind, context: Partial<IContext>, logger: IMyLogger) {
32
+ async function loadConfigFile(configType: ConfigKind, configFile: string, context: Partial<IContext>, logger: IMyLogger) {
29
33
  if (configType === ConfigKind.DISABLE) {
30
- logger.debug`由于命令行参数,跳过配置文件: config/autoindex.json`;
34
+ logger.debug`由于命令行参数,跳过配置文件: ${configFile}`;
31
35
  return;
32
36
  }
33
37
 
34
- logger.debug`即将加载配置文件: config/autoindex.json`;
38
+ logger.debug`即将加载配置文件: ${configFile}`;
35
39
  logger.verbose`使用schema文件: ${schemaFile}`;
36
40
 
37
41
  const packageJsonFile = findUpUntilSync({ file: ['package.json', 'package.yaml'], from: context.project ?? process.cwd() });
@@ -45,7 +49,7 @@ async function loadConfigFile(configType: ConfigKind, context: Partial<IContext>
45
49
  const config = new ProjectConfig(projectRoot, undefined, logger);
46
50
 
47
51
  try {
48
- const configFileData = config.loadSingleJson<IConfigFile>('autoindex', schemaFile);
52
+ const configFileData = config.loadSingleJson<IConfigFile>(basename(configFile, '.json'), schemaFile);
49
53
  logger.verbose`内容: ${configFileData}`;
50
54
 
51
55
  if (!context.project) {
@@ -68,9 +72,29 @@ async function loadConfigFile(configType: ConfigKind, context: Partial<IContext>
68
72
 
69
73
  if (!context.stripTags) context.stripTags = [];
70
74
  if (configFileData.stripTags?.length) context.stripTags.push(...configFileData.stripTags);
75
+
76
+ if (configFileData.banner) {
77
+ if (context.banner) context.banner += '\n';
78
+ let banner = configFileData.banner;
79
+ if (banner.startsWith('@')) {
80
+ const info = config.getFileInfo(banner.slice(1));
81
+ if (!info.effective) {
82
+ logger.error`无法加载banner文件: ${banner}`;
83
+ shutdown(1);
84
+ }
85
+
86
+ banner = await readFile(info.effective, 'utf-8');
87
+ }
88
+ context.banner += banner;
89
+ }
71
90
  } catch (e: unknown) {
72
91
  if (e instanceof NotFoundError) {
73
- logger.verbose`由于文件不存在,未使用配置文件(${e})`;
92
+ if (configType === ConfigKind.REQUIRED) {
93
+ logger.error(`无法加载配置文件: ${e.message}`);
94
+ shutdown(ExitCode.USAGE);
95
+ } else {
96
+ logger.verbose`由于文件不存在,未使用配置文件(${e})`;
97
+ }
74
98
  } else {
75
99
  throw e;
76
100
  }
@@ -88,9 +112,10 @@ export async function createContext(args: ICliArgs, logger: IMyLogger): Promise<
88
112
  stripTags: args.skipTags,
89
113
  project: args.project,
90
114
  verboseMode: args.verboseMode,
115
+ banner: '',
91
116
  };
92
117
 
93
- await loadConfigFile(args.configType, context, logger);
118
+ await loadConfigFile(args.configType, args.configFile, context, logger);
94
119
 
95
120
  if (!context.outputFile) {
96
121
  context.outputFile = './autoindex.generated';
@@ -98,7 +123,8 @@ export async function createContext(args: ICliArgs, logger: IMyLogger): Promise<
98
123
  if (!context.project) {
99
124
  if (args.configType === ConfigKind.IMPLICIT) {
100
125
  // 如果是隐式配置,则必须在命令行中指定项目路径
101
- logger.fatal`未指定项目路径,需要额外参数或在配置文件中指定`;
126
+ logger.error`未指定项目路径,需要额外参数或在配置文件中指定`;
127
+ shutdown(ExitCode.USAGE);
102
128
  }
103
129
  }
104
130
 
@@ -2,8 +2,9 @@ import { camelCase, ucfirst } from '@idlebox/common';
2
2
  import type { IMyLogger } from '@idlebox/logger';
3
3
  import { ensureParentExists, relativePath, writeFileIfChange } from '@idlebox/node';
4
4
  import { ExportKind, IgnoreFiles, TypescriptProject, type IIdentifierResult, type ITypescriptFile } from '@idlebox/typescript-surface-analyzer';
5
- import { basename, dirname } from 'node:path';
5
+ import { dirname } from 'node:path';
6
6
  import type TypeScriptApi from 'typescript';
7
+ import { headerComments, linterInstructions } from './modify-comment.js';
7
8
 
8
9
  export function idToString(ts: typeof TypeScriptApi, id: TypeScriptApi.StringLiteral | TypeScriptApi.Identifier) {
9
10
  if (ts.isIdentifier(id)) {
@@ -21,6 +22,7 @@ export interface ICreateIndexContext {
21
22
  outputFileAbs: string;
22
23
  logger: IMyLogger;
23
24
  verbose?: boolean;
25
+ banner?: string;
24
26
  }
25
27
 
26
28
  export function createStandaloneIgnore(logger: IMyLogger, outputFileAbs: string, extraExcludes?: readonly string[]) {
@@ -61,6 +63,7 @@ export async function createIndex({
61
63
  absoluteImport,
62
64
  extraExcludes = [],
63
65
  stripTags = ['internal'],
66
+ banner = '',
64
67
  }: ICreateIndexContext): Promise<IRet> {
65
68
  if (!project.options.rootDir || !project.options.configFilePath) {
66
69
  logger.error('%o', project.options);
@@ -85,12 +88,12 @@ export async function createIndex({
85
88
  logger.debug('rootDir: %s', project.options.rootDir);
86
89
  logger.debug('configFilePath: %s', project.options.configFilePath);
87
90
  logger.debug('index dir: %s', indexDir);
88
- const header = ['// DO NOT EDIT THIS FILE', '// @ts-ignore', '/* eslint-disable */'];
91
+ const header = [headerComments, banner, linterInstructions];
89
92
  const content = [];
90
93
  const input_files = [];
91
94
  for (const file of list.sort(sort_file)) {
92
95
  if (file.absolutePath === outputFileAbs) {
93
- throw new Error(`override output file: ${outputFileAbs} (are you import xxx from ${basename(outputFileAbs)}?)`);
96
+ throw new Error(`override source file: ${outputFileAbs}`);
94
97
  }
95
98
 
96
99
  const path = importSpec(absoluteImport ?? indexDir, file.relativePath);
@@ -0,0 +1,18 @@
1
+ import pkgJson from '../../package.json' with { type: 'json' };
2
+ export const headerComments = `
3
+ /******************************************************************************
4
+ * GENERATED FILE, DO NOT MODIFY
5
+ * 这是生成的文件,千万不要修改
6
+ *
7
+ * ${pkgJson.name} - Automatic TypeScript index file generator
8
+ * https://github.com/GongT/baobao
9
+ *
10
+ ******************************************************************************/
11
+ `.trim();
12
+
13
+ export const linterInstructions = `
14
+ // biome-ignore-all lint: generated file
15
+ // biome-ignore-all assist: generated file
16
+ /* eslint-disable */
17
+ // @ts-ignore
18
+ `.trim();