Commit e875b651 authored by Adrian DC's avatar Adrian DC
Browse files

feat(profiles, cli, setup): initial 'aa', 'an' and 'ap' Git aliases

Issue: #1
---

Signed-off-by: default avatarAdrian DC <radian.dc@gmail.com>
parent e1182a29
Loading
Loading
Loading
Loading
Loading
+3
Changes for .gitignore: 3 added lines, 0 removed lines.
Original line number Diff line number Diff line
# Assets intermediates
src/assets/*.gitconfig

# Build intermediates
/build

+2
Changes for profiles/gitconfig/alias/add/aa.alias: 2 added lines, 0 removed lines.
Original line number Diff line number Diff line
# Add files verbosely
add -Av
+2
Changes for profiles/gitconfig/alias/add/an.alias: 2 added lines, 0 removed lines.
Original line number Diff line number Diff line
# Add files as dry-run only
add -An
+2
Changes for profiles/gitconfig/alias/add/ap.alias: 2 added lines, 0 removed lines.
Original line number Diff line number Diff line
# Add files in interactive patch mode
add -p
+65
Changes for setup.py: 65 added lines, 0 removed lines.
Original line number Diff line number Diff line
#!/usr/bin/env python3

# Standard libraries
from glob import glob
from os import walk
from os.path import basename, join, splitext
from pathlib import Path
from typing import List

# Modules libraries
from setuptools import find_packages, setup
from setuptools.command.install import install as InstallCommand

# Requirements
requirements: List[str] = []
@@ -31,6 +36,57 @@ PROJECT_SCRIPTS = [
]
PROJECT_URL = f'https://gitlab.com/{PROJECT_NAMESPACE}/{PROJECT_NAME}'

# Setup install
class SetupInstall(InstallCommand):

    # Assets constants
    GIT_CONFIGURATION_ALIAS: str = 'alias.gitconfig'
    GIT_CONFIGURATION_SEPARATOR: str = '\n'
    PROFILES: Path = Path('profiles')
    SOURCES_ASSETS: Path = Path('src') / 'assets'

    # Git alias configuration
    @staticmethod
    def git_configuration_alias() -> None:

        # Prepare profiles sources
        profiles: Path = Path.cwd() / SetupInstall.SOURCES_ASSETS
        profiles.mkdir(parents=True, exist_ok=True)

        # Write configuration file
        with open(profiles / SetupInstall.GIT_CONFIGURATION_ALIAS, encoding='utf8',
                  mode='w') as asset:

            # Configuration file header
            asset.write('[alias]\n')

            # Iterate through profiles files
            for root, _, _ in walk(SetupInstall.PROFILES):
                for alias_file in glob(join(root, '*.alias')):

                    # Parse profile file
                    alias_name = splitext(basename(alias_file))[0]
                    with open(alias_file, encoding='utf8', mode='r') as profile_file:
                        lines = profile_file.readlines()
                        if len(lines) >= 2:
                            comment = lines[0].strip().lstrip('# ')
                            command = lines[1].strip()

                            # Inject alias configuration
                            asset.writelines([
                                f'{line}{SetupInstall.GIT_CONFIGURATION_SEPARATOR}'
                                for line in [
                                    '',
                                    f'\t# {comment}',
                                    f'\t{alias_name} = {command}',
                                ]
                            ])

    # Install entrypoint
    def run(self) -> None:
        SetupInstall.git_configuration_alias()
        InstallCommand.run(self) # type: ignore[no-untyped-call]

# Setup configurations
setup(
    name=PROJECT_PACKAGE,
@@ -57,6 +113,12 @@ setup(
            exclude=['tests'],
        )
    ],
    package_data={
        f'{PROJECT_MODULE}.assets': [
            '.*',
            '*',
        ],
    },
    package_dir={
        PROJECT_MODULE: 'src',
    },
@@ -88,6 +150,9 @@ setup(
        '!=3.6.*',
        '!=3.7.*',
    ]),
    cmdclass={
        'install': SetupInstall,
    },
    entry_points={
        'console_scripts': PROJECT_SCRIPTS,
    },
Loading