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.3.tar.gz (35.8 kB view details)

Uploaded Source

Built Distribution

changelist_sort-0.3-py3-none-any.whl (43.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: changelist_sort-0.3.tar.gz
  • Upload date:
  • Size: 35.8 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.3.tar.gz
Algorithm Hash digest
SHA256 a25c516dfeb27f0ab48b9ff6f4bb50dfb8e55240d1bdda9934d02ce7e4c4d3bf
MD5 91bbe2f6dbb0a5c58dc57d6a60f7b616
BLAKE2b-256 50849c608380c378b103ee508bfd91ed33be38590cd36faf7a2a9d56c99579c6

See more details on using hashes here.

Provenance

The following attestation bundles were made for changelist_sort-0.3.tar.gz:

Publisher: publish.yml on DK96-OS/changelist-sort

Attestations:

File details

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

File metadata

File hashes

Hashes for changelist_sort-0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f7e7ed4cd2b596930b2f879d7fad6872e68ed4a6b44d71a2619472282cd0ce3b
MD5 deff86451183fae2aabcedf00ce3b81e
BLAKE2b-256 9ae696bbd8885f8a85248fe07f6dd41e36221634b986729ba784bc93334c03bc

See more details on using hashes here.

Provenance

The following attestation bundles were made for changelist_sort-0.3-py3-none-any.whl:

Publisher: publish.yml on DK96-OS/changelist-sort

Attestations:

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