tools/fmt-diff.py

#!/usr/bin/env python3
# Copyright (c) 2020, the R8 project authors. Please see the AUTHORS file
# for details. All rights reserved. Use of this source code is governed by a
# BSD-style license that can be found in the LICENSE file.

import argparse
import os
import subprocess
import sys

import utils

from subprocess import Popen, PIPE

GOOGLE_JAVA_FORMAT_DIFF = os.path.join(utils.TOOLS_DIR,
                                       'google-java-format-diff.py')

GOOGLE_JAVA_FORMAT_JAR = os.path.join(utils.THIRD_PARTY, 'google',
                                      'google-java-format', '1.24.0',
                                      'google-java-format-1.24.0-all-deps.jar')

GOOGLE_KOTLIN_FORMAT_DIFF = os.path.join(
    utils.THIRD_PARTY, 'google', 'google-kotlin-format', '0.54',
    'ktfmt-0.54-jar-with-dependencies.jar')

GOOGLE_YAPF = os.path.join(utils.THIRD_PARTY, 'google/yapf/20231013')

JDK21_JAVA = os.path.join(utils.THIRD_PARTY, 'openjdk/jdk-21/linux/bin/java')

NODE_BIN = os.path.join(utils.THIRD_PARTY, 'node', '24.16.0', 'linux', 'bin',
                        'node')
PRETTIER_BIN = os.path.join(utils.THIRD_PARTY, 'prettier', '3.8.3',
                            'node_modules', 'prettier', 'bin', 'prettier.cjs')


def ParseOptions():
    result = argparse.ArgumentParser()
    result.add_argument('--no-java',
                        help='Do not run google-java-format.',
                        action='store_true',
                        default=False)
    result.add_argument('--no-kotlin',
                        help='Do not run google-kotlin-format.',
                        action='store_true',
                        default=False)
    result.add_argument('--python',
                        help='Run YAPF.',
                        action='store_true',
                        default=False)
    result.add_argument('--web',
                        help='Run Prettier.',
                        action='store_true',
                        default=False)
    return result.parse_known_args()


def FormatJava(upstream):
    git_diff_process = Popen(['git', 'diff', '-U0', upstream], stdout=PIPE)
    fmt_process = Popen([
        sys.executable, GOOGLE_JAVA_FORMAT_DIFF, '--google-java-format-jar',
        GOOGLE_JAVA_FORMAT_JAR, '-p1', '-i'
    ],
                        stdin=git_diff_process.stdout)
    git_diff_process.stdout.close()
    fmt_process.communicate()


def FormatKotlin(upstream):
    changed_files_cmd = [
        'git', 'diff', '--name-only', upstream, '*.kt', '*.kts'
    ]
    changed_files = subprocess.check_output(changed_files_cmd).decode(
        'utf-8').splitlines()
    if not changed_files:
        return
    format_cmd = [
        JDK21_JAVA, '-jar', GOOGLE_KOTLIN_FORMAT_DIFF, '--google-style'
    ]
    format_cmd.extend(changed_files)
    subprocess.check_call(format_cmd)


def FormatPython(upstream):
    changed_files_cmd = ['git', 'diff', '--name-only', upstream, '*.py']
    changed_files = subprocess.check_output(changed_files_cmd).decode(
        'utf-8').splitlines()
    if not changed_files:
        return
    format_cmd = [
        sys.executable,
        os.path.join(GOOGLE_YAPF, 'yapf'), '--in-place', '--style', 'google'
    ]
    format_cmd.extend(changed_files)
    yapf_python_path = [GOOGLE_YAPF, os.path.join(GOOGLE_YAPF, 'third_party')]
    try:
        subprocess.check_call(format_cmd,
                              env={'PYTHONPATH': ':'.join(yapf_python_path)})
    except subprocess.CalledProcessError as e:
        print(
            "Error during formatting. Make sure that `platformdirs` is installed:"
        )
        print("$ python3 -m venv .venv")
        print("$ source .venv/bin/activate")
        print("$ pip3 install platformdirs")
        raise e


def FormatWeb(upstream):
    changed_files_cmd = ['git', 'diff', '--name-only', upstream]
    all_changed_files = subprocess.check_output(changed_files_cmd).decode(
        'utf-8').splitlines()
    extensions = ('.js', '.html', '.css')
    changed_files = [
        f for f in all_changed_files
        if f.endswith(extensions) and os.path.exists(f)
    ]
    if not changed_files:
        return
    format_cmd = [NODE_BIN, PRETTIER_BIN, '--write']
    format_cmd.extend(changed_files)
    subprocess.check_call(format_cmd)


def main():
    (options, args) = ParseOptions()
    upstream = subprocess.check_output(['git', 'cl',
                                        'upstream']).decode('utf-8').strip()
    if not options.no_java:
        FormatJava(upstream)
    if not options.no_kotlin:
        FormatKotlin(upstream)
    if options.python:
        FormatPython(upstream)
    if options.web:
        FormatWeb(upstream)


if __name__ == '__main__':
    sys.exit(main())