Skip to content

Instantly share code, notes, and snippets.

@dlew
Created November 9, 2018 16:36
Star You must be signed in to star a gist
Save dlew/5db1b780896bbc6f542e7c00a11db6a0 to your computer and use it in GitHub Desktop.
Simple AndroidX Migration Script
#!/usr/bin/env bash
# I've found that the "Migrate to AndroidX" converter in Android Studio doesn't work very
# well, so I wrote my own script to do the simple job of converting package names.
#
# You can download a CSV of package names here: https://developer.android.com/topic/libraries/support-library/downloads/androidx-class-mapping.csv
#
# It'll run faster on a clean build because then there are fewer files to scan over.
#
# Uses `gsed` because I'm on a Mac. Can easily replace with `sed` if you don't have `gsed`.
#
# This isn't perfect; it won't find every conversion issue. You break it you buy it. Viewer discretion is advised.
MAPPING_FILE=path/to/androidx-class-mapping.csv
PROJECT_DIR=path/to/android/project
replace=""
while IFS=, read -r from to
do
replace+="; s/$from/$to/g"
done <<< "$(cat $MAPPING_FILE)"
find $PROJECT_DIR \( -name "*.kt" -o -name "*.java" -o -name "*.xml" \) -type f -not -path '*/\.git*' -print0 | xargs -0 gsed -i "$replace"
@himattm
Copy link

himattm commented Nov 14, 2018

Thanks for this!

@cmargonis
Copy link

Thank you!

@ondrj
Copy link

ondrj commented Nov 20, 2018

Great job, thanks a lot!

@vashisthg
Copy link

Thanks Dan Leu
We can add

android.support.design.widget.FloatingActionButton,com.google.android.material.floatingactionbutton.FloatingActionButton
android.support.design.widget.AppBarLayout,com.google.android.material.appbar.AppBarLayout

to the csv if using AppBarLayout and FloatingActionButton

@lwasylkowski
Copy link

Some more missing classes:

android.support.design.widget.Snackbar,com.google.android.material.snackbar.Snackbar
android.support.design.widget.BottomSheetBehavior,com.google.android.material.bottomsheet.BottomSheetBehavior
android.support.design.widget.TextInputEditText,com.google.android.material.textfield.TextInputEditText
android.support.design.widget.TextInputLayout,com.google.android.material.textfield.TextInputLayout

@Kisty
Copy link

Kisty commented Nov 28, 2018

Thanks for this, Dan!

Android relevant issue for missing mappings: https://issuetracker.google.com/issues/119776865

@AndiMiko
Copy link

AndiMiko commented Feb 8, 2019

This string doesn't work on windows 10 or Linux. "xargs: Argument list too long" even with just few files

@AndiMiko
Copy link

AndiMiko commented Feb 9, 2019

I wrote a python script which can be used cross-platform in case you have the same issue: https://gist.github.com/AndiMiko/58ecc04a64ac4f89eb5262176ab3fc9e

@carstenhag
Copy link

On Mac run: brew install gnu-sed to get gsed.

@balascript
Copy link

Thanks a Ton Dan!

@vaudevillen
Copy link

Oh my goodness, thank you!!

@loganj
Copy link

loganj commented Jun 19, 2019

Here is a much faster version – replaces find with rg and sed with perl, and I think it works just as well. I terminated the original script after 28 minutes. This rg/perl version completed after about 1 minute.

https://gist.github.com/loganj/7535a13e98be83460f362b63dbd13e07

@dudeinthemirror
Copy link

Thanks Dan. I wrote a script based on your idea with some added enhancements: https://gist.github.com/dudeinthemirror/cb4942e0ee5c3df0fcb678d1798e1d4d

@maxpinto
Copy link

maxpinto commented Jul 5, 2019

thank you.

@mochadwi
Copy link

mochadwi commented Nov 8, 2019

Awesome this is what we're looking for!!! Thanks for the people here.

@NurseyitTursunkulov
Copy link

how to use this script?

@draekko
Copy link

draekko commented Dec 28, 2019

Did a fork for Linux (i'm on Ubuntu) to work around the xarg too long argument list error, and assumes the csv file is in the same directory as the script. https://gist.github.com/draekko/4019f0342553b6c0cbeca1d185245dd1

Hope this helps someone else, thanks for the original, saved me a lot of work.

@OlivierFreyssinet
Copy link

Thank you, this saved me hours of pain 🙏

@zmtzawqlp
Copy link

after run the script.sh
It seems that there is an error: android.support.v7.widget.GridLayoutManager => androidx.gridlayout.widget.GridLayoutManager
It should be : android.support.v7.widget.GridLayoutManager => androidx.recyclerview.widget.GridLayoutManager

@nicreuss
Copy link

I've noticed a substantial performance improvement by running gradle clean before running this script.
The comment on line 8 suggests this but it is easy to overlook.

It'll run faster on a clean build because then there are fewer files to scan over.

The script now runs in 18s instead of 2m43s!

@bikcrum
Copy link

bikcrum commented Jun 24, 2021

brew install gnu-sed

Thanks.

@yogendrajs
Copy link

any idea of migrating away from AndroidX

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment