Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vuejs/vue-migration-helper
CLI tool to aid in migration from Vue 1.x to 2.0
https://github.com/vuejs/vue-migration-helper
Last synced: about 2 months ago
JSON representation
CLI tool to aid in migration from Vue 1.x to 2.0
- Host: GitHub
- URL: https://github.com/vuejs/vue-migration-helper
- Owner: vuejs
- Created: 2016-09-15T22:48:35.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-03-02T10:18:11.000Z (over 5 years ago)
- Last Synced: 2024-03-22T11:28:53.646Z (6 months ago)
- Language: JavaScript
- Size: 152 KB
- Stars: 596
- Watchers: 52
- Forks: 68
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-vue-js - Vue Migration-helper
README
# vue-migration-helper
> CLI tool to aid in migration from Vue 1.x to 2.0. It scans files for Vue-specific code and provides detailed warnings when deprecated patterns are found. It cannot reliably catch _every_ deprecation, but should get you 80% of the way there.
## Usage
``` sh
# install
npm install --global vue-migration-helper
# navigate to a Vue 1.x project directory
cd path/to/my-vue-project
# scan all files in the current directory
vue-migration-helper
# scan all files in specific sub-directories
vue-migration-helper src folder-a folder-b
# scan a specific file or files
vue-migration-helper src/app.vue
```
When you want to update, just run the install again:
``` sh
npm install --global vue-migration-helper
```
## Contributing
While the binary supports Node v4+, tests are written to take advantage of v6+, so you'll need that installed.
``` sh
# clone the project
git clone https://github.com/vuejs/vue-migration-helper.git
# navigate to directory
cd vue-migration-helper
# install the dependencies
npm install
```
Then write a failing test for a rule you'd like to improve. Confirm that it fails with:
``` sh
# run all tests
npm run test -s
```
If your regex skills aren't strong enough to fix the problem yourself, just submit a pull request with the failing test and we'll take it from there. Before you do though, make sure to lint the project for typos and style violations:
``` sh
# lint all files
npm run lint -s
```