weex-toolkit is an official command line tool to help developers to create, debug and build their Weex project.
$ npm install -g weex-toolkit
You can use the weex -v
command to confirm that the installation is successful.
If you have never installed node.js, you should go node.js.org to download and install it.
NOTE: The node version needs to be upper 6.0. You can try n to manage your node versions. If you meet some errors when installing, please go weex-toolkit issues or weex-toolkit faq to find some solution or have a discuss with us.
$ weex create awesome-project
Creates a new weex project. After command running, you can find awesome-project
directory and there are some Weex templates in it.
There are some useful npm scripts you will use in the future:
build
: build the source code and generate the JS bundledev
: run webpack watch configurationserve
: start a hot-reload web server
You need to run npm i
before running npm start
to install project dependencies,after that, the development page will open in the browser automatically
weex-toolkit supports previewing your Weex file(.vue
) in a watch mode. You only need specify your file path.
$ weex preview src/foo.vue
The browser automatically opens the preview page and you can see the layout and effects of your weex page. If you have a Playground app in your mobile devices, you can scan the QR code at the opened page.
Try the command below, you’ll preview the whole directory files.
$ weex preview src --entry src/foo.vue
You need to specify the folder path to preview and the entry file (passed in via --entry
).
Use weex compile
o compile a single weex file or a weex file in an entire folder.
$ weex compile [source] [dist] [options]
Option | Description |
---|---|
-w, --watch |
watch we file changes auto build them and refresh debugger page! [default true ] |
-d,--devtool [devtool] |
set webpack devtool mode |
-e,--ext [ext] |
set enabled extname for compiler default is vue |
-m, --min |
set jsbundle uglify or not. [default false ] |
You can use like this:
$ weex compile src dest --devtool source-map -m
Use weex platform [add|remove] [ios|android]
to add or remove ios / android project templates.
$ weex platform add ios
$ weex platform remove ios
Use weex platform list
to show what platforms your application supported.
You can use weex-toolkit
to run project to android/ios/web
target.
$ weex run ios
$ weex run android
$ weex run web
You can use weex-toolkit
to build project to android/ios/web
target.
$ weex build ios
$ weex build android
$ weex build web
processing...
** Weex devtools ** is a custom devtools for Weex that implements Chrome Debugging Protocol, it is designed to help you quickly inspect your app and debug your JS bundle source in a Chrome web page, both android and iOS platform are supported. So you can use weex-devtools feature by weex-toolkit.
Please make sure your node version is above 6.0 and npm version is above 5.0.
If you want to change your npm registry origin, do not use cnpm
, we recommend you to use nrm
or command like npm config set registry https://registry.npm.taobao.org
.
Since the 1.0.9 version, the weex init
command has been removed. If you want to create the weex project, create it with the weex create
command.
First of all ,please do not install with "sudo"
If a permisiion denied
error occurs,please try sudo chmod 777 /usr/local/lib/node_modules
If you see the following error
Error: permission denied. Please apply the write premission to the directory: "/Users/yourUserName"
We suggest you run sudo chmod 777 ~
or mkdir ~/.xtoolkit && chmod 777 ~/.xtoolkit
windows users may have fsevents installation problems, like:
[email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"win32","arch":"ia32"})
You should remove your node_module
of weex-toolkit, run command like this:
npm install --no-optional weex-toolkit -g
Try:
weex xbind repair toolkit-repair
weex repair
If you encounter an error during the upgrade process, please check your version of npm, the npm version should above 5.0.
Then reload it with the following command:
rm -rf ~/.xtoolkit
npm un weex-toolkit -g
npm i weex-toolkit -g
If you want to run android project, you can use the emulator of Android Studio or a real device
If you install Android SDk by Android studio, you should make sure the Android 6.0 API is installed.
This problem may occur when you use the commands weex create/init/run/platform
.
You need to update your weexpack to latest version.
$ weex update weexpack
If there have some error while update package, please remove ~/.xtoolkit
before update.
$ rm -rf ~/.xtoolkit
$ weex update weexpack
If you are in use during the process, first check your package version is up to date, you can run weex -v
and use weex update weex-devtool@latest
to upgrade your package.