@iringo/arguments-builder v1.8.1

@iringo/arguments-builder

用于统一维护项目参数配置的构建

安装

pnpm add -D @iringo/arguments-builder
# or
npm add -D @iringo/arguments-builder

配置文件

默认读取 arguments-builder.config.(ts|js|mjs) 文件，支持 -c 或 --config 指定配置文件

import { defineConfig } from "@iringo/arguments-builder";

export default defineConfig({
  // ...
});

/**
 * @type {import('@iringo/arguments-builder').ArgumentsBuilderConfig}
 */
module.exports = {
  // ...
};

配置

ArgumentsBuilderConfig

Output

ArgumentItem

CLI

输出 dts 文件

用于开发阶段输出根据当前参数配置输出类型文件，方便类型推导

npx arguments-builder dts

生成 module 文件

一键生成

根据模版自动生成 surge、loon 的 module 文件，以及 boxjs 的 settings 部分的 JSON 文件

npx arguments-builder build

单独生成

命令行工具保留了分别生成单独平台文件的能力

npx arguments-builder (surge|loon|boxjs)

通用参数

所有命令均支持 -c 或 --config 指定配置文件。

例如以下场景

// arguments-builder.config.ts
import { defineConfig } from "@iringo/arguments-builder";

export default defineConfig({
  // ...
});

// arguments-builder.beta.config.ts
import defaultConfig from "./arguments-builder.config.ts";
import { defineConfig } from "@iringo/arguments-builder";

export default defineConfig({
  ...defaultConfig,
  args: [
    ...defaultConfig.args,
    {
      // ...
    },
  ],
});

Node API

import { ArgumentsBuilder } from "@iringo/arguments-builder";

const argumentsBuilder = new ArgumentsBuilder();