feat: Update module to work with any repo.

Signed-off-by: Mateusz Chrominski <[email protected]>

Author: mchromin

README.md

@@ -3,58 +3,67 @@
 
 # MFD Code Quality
 
-## Usage
-
-This module provides set of code quality related methods with corresponding command line commands.
-
-### Available commands
-
-When installing `mfd-code-quality` package all these commands will become available from command line - in the same way as `pip` for example.\
-So you can just type `mfd-help` in your terminal without a need to call it from Python.
-
-
-> `mfd-configure-code-standard`\
-> Prepare code standard configuration files into repository and setup pre commit.
+This module provides a set of code quality methods.\
+Installing this package will also **add the corresponding executable files to your environment**, allowing you to run each code quality check with a simple command-line call.
 
-> `mfd-create-config-files`\
-> Prepare code standard configuration files into repository without setup of pre commit.\
-> Mechanism of creating configs is the same as in 'mfd-configure-code-standard'.
-
-> `mfd-code-standard`\
-Run code standard test using ruff (format, check) or flake8. Depending on what is available. It copies configuration files before code standard check and remove their after check.
-> It's not required to call `mfd-configure-code-standard` or `mfd-create-config-files` before running this command.
-
-> `mfd-import-testing`\
-Run import testing of each Python file to check import problems.
+## Usage
 
-> `mfd-system-tests`\
-Run system tests.
+![](docs/code_quality_demo.gif)
 
-> `mfd-unit-tests`\
-Run unittests, print actual coverage, but don't check its value.
+When installing `mfd-code-quality` package all these commands will become available from command-line - in the same way as `pip` for example.\
+So you can just type i.e. `mfd-help` in your terminal without a need to call it from Python.\
+If command requires configuration, such config will be automatically created and removed after.
 
-> `mfd-unit-tests-with-coverage`\
-Run unittests and check if diff coverage (new code coverage) is reaching the threshold.
+### Available commands
 
-> `mfd-all-checks`\
-Run all available checks.
+| Command                        | Description                                                                                   |
+|--------------------------------|-----------------------------------------------------------------------------------------------|
+| `mfd-help`                     | Log available commands.                                                                       |
+| `mfd-code-standard`            | Check code standard using Ruff (`format`, `check`) or flake8. Depending on what is available. |
+| `mfd-code-format`              | Format code using `ruff check --fix` and `ruff format`.                                       |
+| `mfd-import-tests`             | Try to import each Python file to check import problems.                                      |
+| `mfd-system-tests`             | Run system tests.                                                                             |
+| `mfd-unit-tests`               | Run unit tests.                                                                               |
+| `mfd-unit-tests-with-coverage` | Run unittests and check if diff coverage (new code coverage) is reaching the threshold (**80%**). |
+| `mfd-all-checks`               | Run all available checks.                                                                     |
+
+### Available arguments (for all commands)
+
+* `-p` / `--project-dir` - path to the root directory (default: current working directory)
+
+* `-v` / `--verbose` - enable verbose output
+
+> [!NOTE]
+> All commands are expected to be run from the root directory of the project.\
+> Recommended file structure:
+> ```
+> <project>
+> ├── <package>
+> │   ├── __init__.py
+> │   ├── ...
+> ├── tests
+> │   ├── system
+> │   │   ├── __init__.py
+> │   │   └── ...
+> │   ├── unit
+> │   │   ├── __init__.py
+> │   │   └── ...
+> │   └── __init__.py
+> ├── pyproject.toml
+> ├── README.md
+> └── ...
+> ```
 
-> `mfd-help`\
-Log available commands.
+### Configuration files
 
-> `mfd-format-code`\
-Format code using ruff check --fix and ruff format
+We are using 2 configuration files (created/modified/removed automatically):
 
-All commands can be combined with `--project-dir` parameter, which should point to the root directory of your repository.
-If this parameter is not given current working directory will be assumed to be root directory.
+* `ruff.toml` - for ruff configuration
 
-### Configuration files
-We are using 3 configuration files:
-- `ruff.toml` - for ruff configuration
-- `pyproject.toml` - for project/generic configuration
-- `.pre-commit-config.yaml` - for pre-commit configuration
+* `pyproject.toml` - for project/generic configuration
 
 ### Custom configuration
+
 Some modules have custom configuration files. Files are stored in `mfd_code_quality/code_standard/config_per_module` directory. Configuration files are merged with generic one during configuration process.
 
 ## OS supported:

docs/code_quality_demo.gif

@@ -9,7 +9,7 @@
 from .configure import delete_config_files, create_config_files
 from ..utils import get_root_dir, set_up_logging, set_cwd
 
-logger = logging.getLogger(__name__)
+logger = logging.getLogger("mfd-code-quality.code_standard")
 
 
 def _test_flake8() -> bool:
@@ -29,7 +29,10 @@ def _test_ruff_format() -> bool:
     :return: True if there is nothing to format, False - otherwise.
     """
     logger.info("Checking 'ruff format --check'...")
-    ruff_format_outcome = run((sys.executable, "-m", "ruff", "format", "--check"), cwd=get_root_dir())
+    ruff_format_outcome = run(
+        (sys.executable, "-m", "ruff", "format", "--check"), capture_output=True, text=True, cwd=get_root_dir()
+    )
+    logger.info(f"Output: {ruff_format_outcome.stdout.strip()}")
     return ruff_format_outcome.returncode == 0
 
 
@@ -40,7 +43,8 @@ def _test_ruff_check() -> bool:
     :return: True if ruff check did not find any issues, False - otherwise.
     """
     logger.info("Checking 'ruff check'...")
-    ruff_run_outcome = run((sys.executable, "-m", "ruff", "check"), cwd=get_root_dir())
+    ruff_run_outcome = run((sys.executable, "-m", "ruff", "check"), capture_output=True, text=True, cwd=get_root_dir())
+    logger.info(f"Output: {ruff_run_outcome.stdout.strip()}")
     return ruff_run_outcome.returncode == 0
 
 
@@ -53,7 +57,7 @@ def _get_available_code_standard_module() -> str:
     :return: flake8 or ruff
     :raises Exception: When no code standard module is available
     """
-    code_standard_modules = ["flake8", "ruff"]
+    code_standard_modules = ["ruff", "flake8"]
     pip_list = run((sys.executable, "-m", "pip", "list"), capture_output=True, text=True, cwd=get_root_dir())
     for code_standard_module in code_standard_modules:
         if f"{code_standard_module} " in pip_list.stdout:
@@ -78,7 +82,7 @@ def _run_code_standard_tests(with_configs: bool = True) -> bool:
         code_standard_module = _get_available_code_standard_module()
         if code_standard_module == "ruff":
             if with_configs:
-                logger.info("Prepare configuration files required for checks.")
+                logger.debug("Prepare configuration files required for checks.")
                 create_config_files()
             results.append(_test_ruff_format())
             results.append(_test_ruff_check())
@@ -91,15 +95,15 @@ def _run_code_standard_tests(with_configs: bool = True) -> bool:
         else:
             if code_standard_module == "ruff":
                 logger.info(
-                    "Ruff check was called correctly, however check failed. "
-                    "For fixing code standard call 'mfd-format-code' first."
-                    "\nIf you want to see more details what is wrong, call 'ruff format --diff'.\n"
+                    "Ruff check was called correctly, however check failed.\n"
+                    "For fixing code standard call 'mfd-code-format' first.\n"
+                    "If you want to see more details what is wrong, call 'ruff format --diff'.\n"
                 )
             message = "Code standard check FAILED."
         logger.info(message)
     finally:
         if code_standard_module == "ruff" and with_configs:
-            logger.info("Delete configuration files.")
+            logger.debug("Delete configuration files.")
             delete_config_files()
 
     return return_val