@vzhdi/ox

a plugin based frontend framework used for dev and build

Install

Using npm:

npm install --save-dev @vzhdi/ox

or using yarn:

yarn add @vzhdi/ox --dev

Usage

Support script

start

development the app

build

build the app

deploy

deploy the app to server

babel

transform javascript using babel.usage: ox babel ./src ./lib

plugin

build an ox plugin.usage: ox plugin ./src ./lib

{
  "script":"cross-env NODE_ENV=development ox start"
}

Config

config use one file named .oxrc.js located in app root

used plugins may require you set another options

const YourPlugin1 = require('your-plugin-1-path');
const YourPlugin2 = require('your-plugin-2-path');
const NodeEnv = process.env.NODE_ENV;
module.exports = {
  dir: {
    config: './config', // user config dir
  },
  plugins: [
    // regist the plugins you need
    new YourPlugin1(),
    NodeEnv === 'development' ? new YourPlugin2() : null,
  ],
};

Plugin Development

hook : view doc to see how to use hooks and define hooks.

plugin : view doc to see how to write or use plugin.

buildInPlugins : list the buildIn Plugins

assignConfig :view how to assign config info

LICENSE