fec-builder/src/bin.ts

通用的前端构建工具，屏蔽业务无关的细节配置，开箱即用

#! /usr/bin/env node

import { setAutoFreeze } from 'immer'
import yargs from 'yargs'

import { setBuildRoot, setBuildConfigFilePath } from './utils/paths'
import { Env, setEnv } from './utils/build-env'
import logger from './utils/logger'
import prepare from './prepare'
import clean from './clean'
import generate from './generate'
import upload from './upload'
import serve from './serve'
import { setNeedAnalyze } from './utils/build-conf'
import test from './test'

// 禁掉 auto freeze，否则有的插件改数据时会异常，
// 比如 postcss-loader 会去 delete options 上的 plugins 字段；
// 详情见 https://immerjs.github.io/immer/docs/freezing
setAutoFreeze(false)

const options: Record<string, yargs.Options> = {
  BUILD_ROOT: {
    alias: 'r',
    desc: 'Root path of your project (which contains build-config.json)',
    type: 'string',
    default: process.cwd()
  },
  BUILD_ENV: {
    alias: 'e',
    desc: 'Environment for build, one of [ development, production ]',
    type: 'string',
    default: Env.Dev
  },
  PORT: {
    alias: 'p',
    desc: 'Port for dev server',
    type: 'number',
    default: 80
  },
  BUILD_CONFIG_FILE: {
    alias: 'c',
    desc: 'Path of build config file. If provided, it will be used superior to build-config.json under BUILD_ROOT',
    type: 'string'
  },
  verbose: {
    type: 'boolean',
    desc: 'Output more info',
    default: false
  }
}

interface Command {
  desc: string
  handler: (args: yargs.Arguments) => unknown
  isDefault?: boolean
}

const commands: Record<string, Command> = {
  clean: {
    desc: 'Clean result file',
    handler: clean
  },
  generate: {
    desc: 'Generate result file',
    handler: generate
  },
  upload: {
    desc: 'Upload result file',
    handler: upload
  },
  test: {
    desc: 'Run unit test cases',
    handler: test
  },
  build: {
    desc: 'Clean, generate & upload result file',
    async handler() {
      await clean()
      await generate()
      await upload()
    }
  },
  serve: {
    isDefault: true,
    desc: 'Launch the dev server',
    handler(args) {
      return serve(args.PORT as number)
    }
  },
  analyze: {
    desc: 'Visually analyze bundle dependencies',
    async handler() {
      setNeedAnalyze(true)
      await generate()
    }
  }
}

function applyArgv(argv: yargs.Arguments) {
  if (argv.verbose) {
    logger.level = 'debug'
  }

  if (argv.BUILD_ROOT) {
    setBuildRoot(argv.BUILD_ROOT as string)
  }

  if (argv.BUILD_CONFIG_FILE) {
    setBuildConfigFilePath(argv.BUILD_CONFIG_FILE as string)
  }

  if (argv.BUILD_ENV) {
    const value = argv.BUILD_ENV as Env
    if (!Object.values(Env).includes(value)) {
      logger.warn('Invalid BUILD_ENV value:', value)
    } else {
      setEnv(argv.BUILD_ENV as Env)
    }
  }
}

function handleError(e: unknown) {
  if (Array.isArray(e)) {
    e.forEach(item => logger.error(item))
  } else {
    e && logger.error(e)
  }
  logger.fatal('Encountered error, exit 1')
  process.exit(1)
}

let parser = yargs(process.argv.slice(2))

Object.entries(options).forEach(([name, option]) => {
  parser = parser.option(name, option)
})

Object.entries(commands).forEach(([name, { desc, handler, isDefault }]) => {
  const command = isDefault ? [name, '*'] : name
  parser = parser.command(command, desc, () => {}, async argv => {
    applyArgv(argv)

    try {
      await prepare()
      await handler(argv)
    } catch(e) {
      handleError(e)
    }
  })
})

// enable --version
parser.version()
  .help('h').alias('h', 'help')
  .locale('en')
  .argv