diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..52382c9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,241 @@ +### PyCharm template +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# AWS User-specific +.idea/**/aws.xml + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml +.idea/**/libraries + +# Gradle and Maven with auto-import +# When using Gradle or Maven with auto-import, you should exclude module files, +# since they will be recreated, and may cause churn. Uncomment if using +# auto-import. +# .idea/artifacts +# .idea/compiler.xml +# .idea/jarRepositories.xml +# .idea/modules.xml +# .idea/*.iml +# .idea/modules +# *.iml +# *.ipr + +# CMake +cmake-build-*/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# SonarLint plugin +.idea/sonarlint/ + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Editor-based Rest Client +.idea/httpRequests + +# Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser + +### Python template +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + diff --git a/README.md b/README.md new file mode 100644 index 0000000..995300d --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# Git Message Splitter +A small program that checks if the line doesn't exceed 73 symbols and wraps to the next line if it does. A pattern that requires this condition to the git message taken from the [Tim Pope's blog](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). Made the program for myself. \ No newline at end of file diff --git a/main.py b/main.py new file mode 100644 index 0000000..bcef1eb --- /dev/null +++ b/main.py @@ -0,0 +1,102 @@ +from sys import exit +from pathlib import Path + + +class Main: + + def __init__(self, text_path: Path) -> None: + self.__text_path = text_path + + def __ensure_file(self) -> None: + self.__text_path.open("w", encoding="utf-8").close() + + def __get_text(self) -> str: + try: + with self.__text_path.open(encoding="utf-8") as text_file: + text = text_file.read() + except OSError: + not_found_text = (f"{self.__text_path.name} not found. Please, " + "restart the program.") + print(not_found_text) + input("Press enter to close the program...\n") + exit(1) + if not text: + empty_text = ( + f"{self.__text_path.name} is empty. Please, restart the " + f"program and put your message into the " + f"{self.__text_path.name} file." + ) + print(empty_text) + input("Press enter to close the program...\n") + exit(1) + return text + + @staticmethod + def __format_text(text: str) -> str: + chars = list(text) + reset_chars = ( + "\n", + "\r", + "\r\n", + "\v", + "\f", + "\x1c", + "\x1d", + "\x1e", + "\x85", + "\u2028", + "\u2029", + ) + + limit = 72 + count = 0 + last_space_index = None + for index, char in enumerate(chars): + if char in reset_chars: + last_space_index = None + count = 0 + continue + count += len(char) + if char == " ": + last_space_index = index + if count > limit: + if last_space_index is None: + chars[index] = char + "\n" + else: + chars[last_space_index] = "\n" + count = index - last_space_index + + formatted_text = "".join(chars) + + return formatted_text + + def __write_text_to_file(self, text: str) -> None: + with self.__text_path.open("w", encoding="utf-8") as text_file: + text_file.write(text) + message_formatted_text = ( + "Message successfully formatted and written to" + f" {self.__text_path.name}" + ) + print(message_formatted_text) + + def start(self) -> None: + self.__ensure_file() + + put_text = ( + "Put your Git message into the message.txt file.\n" + "When you're ready, press enter.\n" + ) + input(put_text) + + message = self.__get_text() + formatted_message = self.__format_text(message) + self.__write_text_to_file(formatted_message) + + print("Done!") + input("Press enter to close the program...\n") + + +if __name__ == "__main__": + text_path = Path("message.txt") + main = Main(text_path) + main.start()