lintaosp 1.0.1

Lint AOSP

lintaosp

Introduction

lintaosp is a lint worker of lintflow on AOSP written in Python.

Prerequisites

• Android lint >= 4.1
• Python >= 3.7

Run

• Local mode

git clone https://github.com/craftslab/lintaosp.git

cd lintaosp
pip install -Ur requirements.txt
python aosp.py --config-file="config.yml" --lint-project="project" --output-file="output.json"

• Service mode

git clone https://github.com/craftslab/lintaosp.git

cd lintaosp
pip install -Ur requirements.txt
python aosp.py --config-file="config.yml" --listen-url="127.0.0.1:9090"

Docker

• Local mode

git clone https://github.com/craftslab/lintaosp.git

cd lintaosp
docker build --no-cache -f Dockerfile -t craftslab/lintaosp:latest .
docker run -it -v /tmp:/tmp craftslab/lintaosp:latest ./lintaosp --config-file="config.yml" --lint-project="/tmp/project" --output-file="/tmp/output.json"

• Service mode

git clone https://github.com/craftslab/lintaosp.git

cd lintaosp
docker build --no-cache -f Dockerfile -t craftslab/lintaosp:latest .
docker run -it -p 9090:9090 craftslab/lintaosp:latest ./lintaosp --config-file="config.yml" --listen-url="127.0.0.1:9090"

Usage

usage: aosp.py [-h] --config-file CONFIG_FILE
               [--lint-project LINT_PROJECT | --listen-url LISTEN_URL]
               [--output-file OUTPUT_FILE] [-v]

Lint AOSP

optional arguments:
  -h, --help            show this help message and exit
  --config-file CONFIG_FILE
                        config file (.yml)
  --lint-project LINT_PROJECT
                        lint project (/path/to/project)
  --listen-url LISTEN_URL
                        listen url (host:port)
  --output-file OUTPUT_FILE
                        output file (.json|.txt|.xlsx)
  -v, --version         show program's version number and exit

Settings

lintaosp parameters can be set in the directory config.

An example of configuration in config.yml:

apiVersion: v1
kind: worker
metadata:
  name: lintaosp
spec:
  aosp:
    sdk:
      - Correctness
      - Correctness:Messages
      - Security
      - Compliance
      - Performance
      - Performance:Application Size
      - Usability:Typography
      - Usability:Icons
      - Usability
      - Productivity
      - Accessibility
      - Internationalization
      - Internationalization:Bidirectional Text

Design

Errorformat

• Error type

E: Error
I: Information
W: Warning

• JSON format

{
  "file": "name",
  "line": 1,
  "type": "Error",
  "details": "text"
}

• Text format

{file}:{line}:{type}:{details}

License

Project License can be found here.

Reference

• Android lint
• errorformat
• gRPC
• protocol-buffers