README.md

vue-cli

WIP: this is the work in progress branch of the upcoming vue-cli 3.0. Only for preview for template maintainers.

Development Setup

This project uses a monorepo setup that requires using Yarn because it relies on Yarn workspaces.

# install dependencies
yarn

# link `vue` executable
# if you have the old vue-cli installed globally, you may
# need to uninstall it first.
cd packages/@vue/cli
yarn link

# create test projects in /packages/test
cd -
cd packages/test
vue create test-app
cd test-app
yarn serve

Testing Tips

The full test suite is rather slow, because it has a number of e2e tests that performs full webpack builds of actual projects. To narrow down the tests needed to run during development, you can use the test-package script to run tests for specific packages:

yarn test cli cli-services

If the package is a plugin, you can commit the cli-plugin- prefix:

yarn test typescript

To further narrow down tests, you can also specify your own regex:

yarn test -g <filenameRegex>

You can also pass --watch to any of the test scripts to run tests in watch mode.

Note that jest -o (running tests related to modified files) isn't always accurate because some tests spawn child processes.

Plugin Development

See dedicated section in docs.