What is vue-codemod?

vuejs/vue-codemod — explained in plain English

Analysis updated 2026-08-01 · repo last pushed 2023-01-07

★ 287TypeScriptAudience · developerComplexity · 3/5DormantSetup · moderate

Mindmap

mindmap
  root((repo))
    What it does
      Rewrites Vue 2 code
      Applies automated transformations
      Scans files and folders
    How it works
      Runs from command line
      Built on JSCodeshift
      Browser playground included
    Use cases
      Migrate Vue 2 to Vue 3
      Auto-fix breaking changes
      Experiment before applying
    Audience
      Development teams
      Large-scale upgrades
    Project status
      Experimental stage
      Detailed roadmap
      Some manual fixes needed

mindmap root((repo)) What it does Rewrites Vue 2 code Applies automated transformations Scans files and folders How it works Runs from command line Built on JSCodeshift Browser playground included Use cases Migrate Vue 2 to Vue 3 Auto-fix breaking changes Experiment before applying Audience Development teams Large-scale upgrades Project status Experimental stage Detailed roadmap Some manual fixes needed

What do people build with it?

USE CASE 1

Automatically rewrite old Vue 2 app instance creation syntax to Vue 3 format across a whole project.

USE CASE 2

Experiment with code transformations in a browser playground before running them on your real codebase.

USE CASE 3

Follow a staged migration path: auto-fix simple issues with a linter, run codemods for structural changes, then install Vue 3.

What is it built with?

TypeScriptVue.jsJSCodeshiftVue CLI

How does it compare?

	vuejs/vue-codemod	opencoredev/login-with-chatgpt	eli-labz/third-eye
Stars	287	286	285
Language	TypeScript	TypeScript	TypeScript
Last pushed	2023-01-07	—	—
Maintenance	Dormant	—	—
Setup difficulty	moderate	easy	—
Complexity	3/5	2/5	—
Audience	developer	developer	developer

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · moderate Time to first run · 30min

Requires an existing Vue 2 codebase to transform and familiarity with running JSCodeshift-based CLI tools.

No license information was provided in the explanation, so the permissions for using this code are unclear.

So what is it?

vue-codemod is a toolkit that automatically rewrites Vue.js code to help teams migrate their apps from Vue 2 to Vue 3. When a framework releases a major new version, the way you write code often changes. Instead of a team of developers manually updating hundreds of files by hand, this tool scans the codebase and applies those changes automatically. At a high level, it works by reading your existing source files, identifying patterns that need updating, and rewriting them in place. For example, if Vue 3 changed how you create a new app instance, the tool finds the old syntax and replaces it with the new one. You run it from the command line, pointing it at a file or folder, and it applies a specific "transformation", a script designed to handle one particular change. The project also includes a browser-based playground where developers can experiment with transformations before running them on a real codebase. This tool is designed for development teams who have existing applications built on Vue 2 and want to upgrade to Vue 3. The migration involves a large number of breaking changes, from how global APIs work to how routing and state management are set up. The README outlines a detailed migration path: developers first use a linter to auto-fix simple issues, then run these codemods for more complex structural changes, then install Vue 3 itself. It's a practical tool for anyone facing a large-scale upgrade who wants to save time and reduce human error. The project is still explicitly marked as experimental, and the README shows a detailed roadmap of what has been built and what is still in progress. Some transformations are fully implemented, while many others are marked as not yet started. The README is also transparent about limitations, it notes that some changes are too nuanced to automate and will always require manual fixes. The tool is built on top of JSCodeshift, a widely used utility for running large-scale code modifications, and is designed to integrate into the broader Vue CLI ecosystem.

Copy-paste prompts

Prompt 1

I have a Vue 2 app I want to migrate to Vue 3. Walk me through using vue-codemod to automatically rewrite my source files, including how to run it from the command line on a specific folder.

Prompt 2

Help me set up the browser-based playground from vue-codemod so I can test a transformation on a snippet of my Vue 2 code before applying it to my entire project.

Prompt 3

My Vue 2 to Vue 3 migration has both simple lint fixes and complex structural changes. Help me create a step-by-step upgrade plan using a linter, vue-codemod transformations, and the Vue 3 install.

Prompt 4

Which vue-codemod transformations are fully implemented and which are still experimental or not started? Help me figure out which of my Vue 2 to Vue 3 changes can be automated and which need manual fixes.

Frequently asked questions