Skip to main content

CLI Tool for Sorting Android Studio Changelists

Project description

# Changelist Sort Making Sorting Changelist Files Easy!

  1. Close Android Studio (saves changelists to workspace file)

  2. Open shell from project root directory (or supply workspace file path in arguments)

  3. Run changelist-sort (or cl-sort) add arguments/options if necessary

  4. Reopen Android Studio. Your changelists are sorted.

Note: If you want to combine step 2 and step 3, add an alias to your shell environment.

## Sorting By Module Files are sorted by the name of the top level directory they are located in. In Android projects, each directory in the project root is a module, with a few special cases.

## Sorting By Source Set A specialized Module Sort mode that splits changes by their source set. Apply the -s flag to use this sorting mode.

### Special Changelists & Directories There are special Changelists, and special Directories that are handled differently. - Build Updates Changelist - Root Directory - Gradle Directory

Build Updates Changelist: This is a changelist that is used to collect all of the files that affect the project build. This includes all files in the gradle directory, and any file that ends with the .gradle file extension. There are also Gradle files that end in .properties, which are also sorted into the Build Updates Changelist.

Root Directory: The Root directory is special because the file paths are really short and do not contain a module name. Often, Root directory contains .gradle files which are sorted into the Build Updates Changelist. Any non-Gradle files in the Root directory are sorted into a special Changelist that may be called Root or Project Root.

Gradle Directory: The Gradle Directory is a direct descendant of the Root directory, and may contain toml, gradle, or properties files. These are all sorted into the Build Updates Changelist.

### Module Names and Sorting Comparisons

Changelist Names The name of the changelist must match the module, ignoring letter case and removing spaces.

Otherwise, a new Changelist will be created that matches the module name. - Underscores are replaced with spaces. - Each Word in the Name will start with an uppercase letter.

## Remove Empty Changelists You can remove all empty changelists after a sort has completed by adding the -r flag, or –remove-empty argument.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

changelist_sort-0.2.3.tar.gz (39.1 kB view details)

Uploaded Source

Built Distribution

changelist_sort-0.2.3-py3-none-any.whl (50.4 kB view details)

Uploaded Python 3

File details

Details for the file changelist_sort-0.2.3.tar.gz.

File metadata

  • Download URL: changelist_sort-0.2.3.tar.gz
  • Upload date:
  • Size: 39.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for changelist_sort-0.2.3.tar.gz
Algorithm Hash digest
SHA256 df39063738a4673c2ed6dfcf529273e33db9f6c260c20403e0a3daed555c45e9
MD5 f0e6a01052efa02c5f91ac800d630bcd
BLAKE2b-256 d596fd4e991a3fa17a25dcdd938d9f106f214f7806ccfd8c9b1f343fc871bba3

See more details on using hashes here.

File details

Details for the file changelist_sort-0.2.3-py3-none-any.whl.

File metadata

File hashes

Hashes for changelist_sort-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 598bfdd50d0315edebf88d9facadf2aea13140a3c340e4948b5433f031df4234
MD5 7d97ce8d128dc2b02e0230680afc2329
BLAKE2b-256 f45c8a6326b2f6f9b014db42e083b00b9cc46bf9153abe942fa92a6863e58c59

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page