# Upgrading To 3.0 From 2.x

Hello balm-core πŸŽ‰

Born to build, better enterprise workflow with Node.js

# 1. Installing balm

yarn global add balm-core
yarn add -D balm

OR

npm install -g balm-core
npm install -D balm

# 2. Upgrade entry config file

/path/to/project

  • gulpfile.js => balm.config.js

    module.exports = {
      // Your project config
    };
    

    OR

    const getConfig = require('./config/balmrc.js'); // Your project config
    
    const api = (mix) => {
      // Custom tasks by API
    };
    
    module.exports = (balm) => {
      return {
        config: getConfig(balm),
        api
      };
    };
    
  • update package.json:

    {
      "scripts": {
        "dev": "balm",
        "prod": "balm -p"
      }
    }
    

# 3. balm.config Changes

  • config.paths.source.html
  • config.styles.minified => config.styles.minify
  • config.scripts.hot
  • config.scripts.esbuild
  • config.scripts.buildOptions
  • config.scripts.useTransform
  • config.scripts.transformOptions
  • config.assets.publicUrlPlaceholder
  • config.assets.publicUrl

bundler:

  • esbuild (new)
  • webpack (old)
Last Updated: 3 months ago