@freshes/house v1.2.2

Documentation

Usage

yarn add -D @freshes/house

Guide

Core files of house have:

• src/Runners/DevelopmentRunner.js, to start development environment.
• src/Runners/ProductionRunner.js, to build production environment.
• src/Runners/ServerRunner.js, after building production, it will start a Express to set proxy and open web page for preview.

Development

Add new file ./script/development.js in project root path.

// ./script/development.js
import DevelopmentRunner from '@freshes/house/src/Runners/DevelopmentRunner.js'

new DevelopmentRunner()
  .setOptions(require('./configs/options'))
  // set proxy map by http-proxy-middleware
  .setProxy(require('./configs/proxy'))
  // set app browser env by webpack.DefinePlugin
  .setAppEnvs(require('./configs/appEnvs'))
  // extend webpack or express
  .extend(runner => {})
  // Finally run
  .run()

Then edit ./package.json

{
  "scripts": {
    "start": "node ./scripts/development.js"
  }
}

About runner.extend

runner has two built-in builder, they are webpackBuilder and expressBuilder.

new DevelopmentRunner().extend(runner => {
  // you can refer to api documentation, the documentation will be uploaded
  runner.webpackBuilder.xxx
  runner.expressBuilder.xxx
})

Sentry Hash

新增 VERSION_HASH 的环境的变量，默认取当前 git commit 的 hash 值。