Skip to content

Commit

Permalink
Update reade
Browse files Browse the repository at this point in the history
  • Loading branch information
victorcuena committed Aug 8, 2023
1 parent bdf8663 commit 17ebeef
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .github/workflows/vue-class-migrator.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
name: CI

on:
push:
branches: [ main ]
Expand Down
19 changes: 18 additions & 1 deletion README.MD
Original file line number Diff line number Diff line change
@@ -1,17 +1,25 @@

![CI](https://github.com/getyourguide/vue-class-migrator/workflows/CI/badge.svg)

![npm](https://img.shields.io/npm/v/vue-class-migrator)
![npm](https://img.shields.io/npm/dm/vue-class-migrator)


## Migrator CLI Tool

This utility will help migrate vue and typescript files that use the decorator `@component` from `vue-class-components`. Behind the scenes, we use `ts-morpth` for parsing and generating files.

### Installation

TODO

### Hot to use the tool

Accepted options
- -d: Directory that you want to migrate, relative to this package.
- --sfc: (Optional flag, default: false) Removes original ts and scss files and generates a final vue SFC.

```
npm install
npm run migrate -- -d <your_path>
```

Expand Down Expand Up @@ -61,3 +69,12 @@ In addition to migrating the class to the defineComponent format, vue-class-migr
|@Component||
|@Mixins||

## Security

For sensitive security matters please contact [[email protected]](mailto:[email protected]).

## Legal

Copyright 2023 GetYourGuide GmbH.

vue-class-migrator is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full text.

0 comments on commit 17ebeef

Please sign in to comment.