Skip to content

Commit ce3470f

Browse files
committed
chore: update roadmap
1 parent df8c326 commit ce3470f

File tree

1 file changed

+15
-32
lines changed

1 file changed

+15
-32
lines changed

README.md

+15-32
Original file line numberDiff line numberDiff line change
@@ -6,50 +6,33 @@ This repository contains a collection of codemod scripts for use with [JSCodeshi
66

77
Inspired by [react-codemod](https://github.com/reactjs/react-codemod).
88

9-
## Usage
9+
## Command Line Usage
1010

11-
`npx vue-codemod -t <transformation> -f <path> [...options]`
11+
`npx vue-codemod -t <transformation> --params [transformation params] <path> [...additional options]`
1212

13-
- `transformation` - name of transformation, see available transformations below. Or you can provide a path to a custom transformation module.
14-
- `path` - files or directory to transform
15-
- use the `--dry` options for a dry-run
13+
- `transformation` (required) - name of transformation, see available transformations below; or you can provide a path to a custom transformation module.
14+
- `path` (required) - files or directory to transform.
15+
- `--params` (optional) - additional transformation specific args .
16+
- use the `--dry` options for a dry-run.
1617

17-
## TODOs
18+
## Programmatic API
19+
20+
TODO
21+
22+
## Roadmap
1823

1924
(Sort by priority)
2025

21-
- [ ] Basic testing setup and an MVP
26+
- [ ] Basic testing setup and a dummy CLI
27+
- [ ] Support applying `jscodeshift` codemods to `.vue` files
28+
- [ ] Provide a programmatic interface for usage in `vue-cli-plugin-vue-next`
2229
- [ ] Define an interface for transformation of template blocks
23-
- [ ] Automatically apply transformations to `.vue` file without explicitly depending on `vue-jscodeshift-adapter` (should open source this repo after finishing this one)
2430
- [ ] A playground for writing transformations
2531
- [ ] Implement more transformations for [active RFCs](https://github.com/vuejs/rfcs/tree/master/active-rfcs)
26-
- [ ] Support `.ts` and `<script lang="ts">`
2732

2833
## Included Transformations
2934

30-
### rfc-0009
31-
32-
Alias of [`new-vue-to-create-app`](#new-vue-to-create-app)
33-
34-
### rfc-0013
35-
36-
**WIP**
37-
Runs [`object-to-composition-api`](#object-to-composition-api) and [`remove-composition-api-plugin`](#remove-composition-api-plugin)
38-
39-
### new-vue-to-create-app
40-
41-
Implements [RFC-0009 Global API Change](https://github.com/vuejs/rfcs/blob/master/active-rfcs/0009-global-api-change.md).
42-
Converts `new Vue(...).$mount('#app')` calls to `createApp(...).mount(App, '#app')`.
43-
44-
### object-to-composition-api
45-
46-
**WIP**
47-
Implements [RFC-0013 Composition API](https://github.com/vuejs/rfcs/blob/master/active-rfcs/0013-composition-api.md).
48-
Migrated from https://github.com/vuejs/function-api-converter
49-
50-
### remove-composition-api-plugin
51-
52-
**TODO**: remove the usage of `@vue/composition-api` package as it's supported by default in Vue 3.
35+
TODO
5336

5437
## Custom Transformation
5538

0 commit comments

Comments
 (0)