Contribute

Notice: y is the alias for yarn, n is the alias for npm.

Set up

Install dev deps after git clone the repo.

$ y

Bootstrap every package with yarn. (Need to execute when new package is included)

$ y bootstrap

Link umi globally.

$ cd packages/umi
$ y link

Monitor file changes and transform with babel.

$ y build --watch

Run test.

# Including e2e test
$ y test

# Unit test only
$ y debug .test.(t|j)s

# Test specified file and watch
$ y debug getMockData.test.js -w

Run umi dev in examples/func-test.

$ cd examples/func-test
$ umi dev

Then open http://localhost:8000/ in your browser.

Run umi build in examples/simple.

$ cd examples/func-test
$ umi build

# Build without compress
$ COMPRESS=none umi build

Publish to npm.

# Generator the changelog first.
$ y changelog

# Do not use yarn for this command.
$ n run publish

Debug doc in local.

$ y doc:dev

Deploy doc to umijs.org.

$ y doc:deploy

Debug umi ui in local.

$ y ui:build --watch

# Then run umi ui under a umi project.
$ umi ui

# Or
$ umi dev --ui