如何在Oclif框架中为多个指定命令添加相同的flag？

有两种常用的实现方案，都可以实现仅给部分指定命令添加公共flag，不会全局生效：

方案1：抽离公共flag变量，按需引入 #

适合仅需要共享flag定义，没有其他公共逻辑的场景：

1. 单独新建文件存放公共flag定义，例如src/flags/shared.ts：

import { Flags } from '@oclif/core'

// 仅列表类命令使用的公共flag集合
export const listOnlyFlags = {
  filter: Flags.string({
    char: 'f',
    description: '按指定条件过滤返回结果',
    required: false
  })
}

2. 在需要用到该flag的列表类命令中引入即可：

import { Command, Flags } from '@oclif/core'
import { listOnlyFlags } from '../../flags/shared'

export default class UserList extends Command {
  static flags = {
    // 引入列表类公共flag
    ...listOnlyFlags,
    // 补充当前命令独有的flag
    all: Flags.boolean({
      char: 'a',
      description: '返回全量数据，忽略分页'
    })
  }

  async run() {
    const { flags } = await this.parse(UserList)
    // 直接使用flags.filter获取参数值
  }
}

方案2：封装列表命令基类，按需继承 #

适合列表类命令除了flag还有大量公共逻辑的场景：

1. 封装抽象基类，例如src/commands/base/list-command.ts：

import { Command, Flags } from '@oclif/core'

export default abstract class ListCommand extends Command {
  // 公共flag定义
  static flags = {
    filter: Flags.string({
      char: 'f',
      description: '按指定条件过滤返回结果',
      required: false
    }),
    page: Flags.integer({
      char: 'p',
      description: '分页页码',
      default: 1
    }),
    pageSize: Flags.integer({
      char: 's',
      description: '每页返回条数',
      default: 20
    })
  }

  // 还可以封装公共方法，比如分页校验、结果格式化等
  protected validatePagination(page: number, pageSize: number) {
    if (page < 1) throw new Error('页码不能小于1')
    if (pageSize < 1 || pageSize > 100) throw new Error('每页条数需在1-100范围内')
  }
}

2. 对应列表命令继承该基类即可：

import ListCommand from '../../base/list-command'
import { Flags } from '@oclif/core'

export default class OrderList extends ListCommand {
  static flags = {
    // 继承基类所有公共flag
    ...super.flags,
    // 补充当前命令独有flag
    paid: Flags.boolean({
      description: '仅返回已支付的订单'
    })
  }

  async run() {
    const { flags } = await this.parse(OrderList)
    this.validatePagination(flags.page, flags.pageSize)
    // 后续业务逻辑
  }
}

注意事项 #

• 两种方案都仅对主动引入/继承的命令生效，不会影响其他非列表类命令
• 后续需要调整公共flag的配置时，仅需要修改一处即可全局生效，无需挨个调整每个命令的定义
• 如果你使用JavaScript版本的oclif，去掉上述示例中的TypeScript类型定义，逻辑完全通用
• 不要将公共flag放到全局hook或者根命令的flag定义中，否则会对所有命令生效

内容的提问来源于stack exchange，提问作者lakshmiravali rimmalapudi