安卓>> android-resources-checker>> 返回
项目作者： fabiocarballo

项目描述 ：
Inspect the resources of your android projects and understand which ones are not being used and could potentially be removed.
高级语言： Python
项目地址: git://github.com/fabiocarballo/android-resources-checker.git
创建时间： 2021-03-27T05:36:09Z
项目社区：https://github.com/fabiocarballo/android-resources-checker
开源协议：MIT License
下载


Android Resources Checker

Flake8
Black
Coverage
License

What

This program will inspect the resources of your app and help you understand which ones are not being used and could
potentially be removed.

Main features:

  • Identify the unused resources in your android project.
  • Identify the unused resources in your android library (when you have a multi-repo setup)
  • Listing of the unused resources (name, type and size)
  • Deletion of the unused resources

Installing

This program requires Python, supporting from 3.8.x and 3.9.x

In order to install run:

  1. pip install -U android-resources-checker

Using

Inspecting your app resources.

Imagining your app in the project subject-app, you can trigger the resources inspection by running:

  1. android-resources-checker --app /path/to/subject-app

Inspecting your library app resources.

In the case you have two projects in separate repos, where a client-app depends on a lib-app, you can check the
unused resources of the library app by running:

  1. android-resources-checker \
  2.   --app /path/to/lib-app \
  3.   --client /path/to/client-app-1 \
  4.   --client /path/to/client-app-2

An example of a run could look like this:

Reports

The default behavior is to generate reports on both the stdout and CSV.

You can specify a single type of report using the --report=(CSV|STDOUT) option.

If using CSV reports, you can specify the directory where to write the reports in the form of CSV files. For that use
the --reports-dir option.

For example:

  1. android-resources-checker \
  2.   --app /path/to/app \ 
  3.   --reports-dir /path/to/reports

Validation

There is also the option to run this as a validation tool. In this case, it will fail with an error if any unused
resources are found.

To specify the validation use the --check flag (the default behavior is to perform no validation).

Automatic Deletion

You can use this tool to also delete the unused resources by using the --delete option.

License

  2. Copyright (c) 2021 Dotanuki Labs, Fabio Carballo
  4. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
  5. documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
  6. rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
  7. persons to whom the Software is furnished to do so, subject to the following conditions:
  9. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
  10. Software.
  12. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  13. WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
  14. COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  15. OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.