vue-jscodeshift-adapter

vue-jscodeshift-adapter

Run jscodeshift on Vue single file components

Install

npm install vue-jscodeshift-adapter -D

Usage

The instructions below assume you're familiar with jscodeshift.

Run a codemod on some .js and/or .vue files

When transforming	fileInfo.source will be
.js file	the contents of the file
.vue file	the contents of <script>

The source file will be updated appropriately based on the return value of your transform().

If .vue file doesn't have a <script>, your transform() will not be called and the source file will not be changed.

1. Create wrapped transform function

my-transform.js:

const adapt = require('vue-jscodeshift-adapter');
const someCodemod = require('some-codemod');

module.exports = adapt(someCodemod);

2. Run jscodeshift

$ jscodeshift <path> -t my-transform.js --extensions vue,js

See jscodeshift readme for more info on jscodeshift CLI.

License

MIT

Changelog

[2.0.0] - 2018-03-25

Breaking Change

The "modify any block of a vue component" use case is temporarily not supported until the API is figured out.

As of 2.0.0, this module can only

• transform js files
• transform the <script> block of vue files