0.1.2 • Published 5 years ago

@walrus/walrus-plugin-update-config v0.1.2

Weekly downloads
-
License
MIT
Repository
github
Last release
5 years ago

插件使用场景: 需要在启动服务时,修改项目配置文件,可配合umi-plugin-deploy-config使用

NPM version

📦 安装

// npm
npm install --dev @walrus/cli @walrus/walrus-plugin-update-config

// yarn
yarn add --dev @walrus/cli @walrus/walrus-plugin-update-config

🔨 使用

项目根目录下添加配置文件

// walrus.config.ts

import { IConfig } from '@walrus/types';

const config: IConfig = {
  plugins: [
    ['@walrus/walrus-plugin-update-config, {
      // 配置文件目录
      dir: '',
      // 配置文件名称
      fileName: '',
      // 迭代函数
      iterator: (key, obj) => {
        if (key === 'baseURL') {
          return 'test';
        }
        return obj[key];
      }
    }]
  ]
};

package.json添加如下代码

"scripts": {
  "update-config": "walrus update-config"
}

执行 yarn update-config

可运行 walrus help update-config 查看帮助信息

📝 配置项

key类型默认值是否必填説明
dirstringprocess.cwd()false配置文件所在目录
fileNamestringconfig.jsfalse配置文件名称
iteratorfunction--true转换处理函数

👷 命令行参数

  • '--dir dir': 'config file dir (default: process.cwd())'
  • '--file-name name': 'config file name (default: config.js)'