pre-commit-localupdate 0.1.0__tar.gz → 0.2.0__tar.gz

pre_commit_localupdate-0.1.0/README.md → pre_commit_localupdate-0.2.0/PKG-INFO

@@ -1,10 +1,25 @@
+Metadata-Version: 2.1
+Name: pre-commit-localupdate
+Version: 0.2.0
+Summary: A CLI tool to automatically update additional dependencies within local Python and Node.js hooks in pre-commit config files.
+Author: M. Farzalipour Tabriz
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Project-URL: source, https://gitlab.mpcdf.mpg.de/tbz/pre-commit-localupdate.git
+Requires-Python: <3.15,>=3.11
+Requires-Dist: requests>=2.32.5
+Requires-Dist: ruamel-yaml>=0.19.1
+Description-Content-Type: text/markdown
+
 # pre-commit-localupdate
 
-A CLI tool to automatically update dependencies in `pre-commit-config.yml` files. It specifically targets `additional_dependencies` within local Python and Node.js hooks to ensure your tooling stays up-to-date. It also adds version to unversioned packages and pins exact version of loosely defined ones.
+A CLI tool to automatically update dependencies in `pre-commit-config.yml` files. It specifically targets `additional_dependencies` within local Python, Julia, and Node.js hooks to ensure your tooling stays up-to-date. It also adds version to unversioned packages and pins exact version of loosely defined ones.
 
 ## Installation
 
-```bash
+```shell
 pip install pre-commit-localupdate
 ```
 
@@ -12,16 +27,28 @@ pip install pre-commit-localupdate
 
 To check and update the `additional_dependencies` in your `.pre-commit-config.yaml` file, simply run:
 
-```bash
+```shell
 pre-commit-localupdate
 ```
 
 By default, the tool looks for `.pre-commit-config.yaml` in the current directory. To specify a custom file path, use the `-c` or `--config` argument:
 
-```bash
+```shell
 pre-commit-localupdate --config path/to/.pre-commit-config.yaml
 ```
 
+To check the dependencies without updating, use the `--dry-run` flag. The command will exit with a non-zero status code if any package needs updating:
+
+```shell
+pre-commit-localupdate --dry-run
+```
+
+To get debug output use `--debug` flag:
+
+```shell
+pre-commit-localupdate --debug
+```
+
 ## Example
 
 Given a `.pre-commit-config.yaml` with the following content:
@@ -30,6 +57,13 @@ Given a `.pre-commit-config.yaml` with the following content:
 # Comments in the file header are preserved
 ---
 repos:
+  # External hooks won't be touched. Use 'pre-commit autoupdate' command to update them
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
   - repo: local
     hooks:
       # Comment about hooks are preserved
@@ -42,7 +76,7 @@ repos:
         require_serial: true
         types_or: [python, pyi]
         additional_dependencies:
-          # Loose version definitions will be pinned to an exact version
+          # Loose version definitions are pinned to an exact version
           - "black>=25.1.0"
 
       - id: mypy
@@ -79,6 +113,13 @@ Running `pre-commit-localupdate` will update the file to (hypothetical latest ve
 # Comments in the file header are preserved
 ---
 repos:
+  # External hooks won't be touched. Use 'pre-commit autoupdate' command to update them
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
   - repo: local
     hooks:
       # Comment about hooks are preserved
@@ -92,7 +133,7 @@ repos:
         require_serial: true
         types_or: [python, pyi]
         additional_dependencies:
-          # Loose version definitions should be pinned
+          # Loose version definitions are pinned to an exact version
           - "black==26.1.0"
 
       - id: mypy

pre_commit_localupdate-0.1.0/PKG-INFO → pre_commit_localupdate-0.2.0/README.md

@@ -1,25 +1,10 @@
-Metadata-Version: 2.1
-Name: pre-commit-localupdate
-Version: 0.1.0
-Summary: A CLI tool to automatically update `additional_dependencies` within local Python hooks in `pre-commit-config.yml` files.
-Author: M. Farzalipour Tabriz
-Classifier: Development Status :: 3 - Alpha
-Classifier: Environment :: Console
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3
-Project-URL: source, https://gitlab.mpcdf.mpg.de/tbz/pre-commit-localupdate.git
-Requires-Python: <3.15,>=3.10
-Requires-Dist: requests>=2.32.5
-Requires-Dist: ruamel-yaml>=0.19.1
-Description-Content-Type: text/markdown
-
 # pre-commit-localupdate
 
-A CLI tool to automatically update dependencies in `pre-commit-config.yml` files. It specifically targets `additional_dependencies` within local Python and Node.js hooks to ensure your tooling stays up-to-date. It also adds version to unversioned packages and pins exact version of loosely defined ones.
+A CLI tool to automatically update dependencies in `pre-commit-config.yml` files. It specifically targets `additional_dependencies` within local Python, Julia, and Node.js hooks to ensure your tooling stays up-to-date. It also adds version to unversioned packages and pins exact version of loosely defined ones.
 
 ## Installation
 
-```bash
+```shell
 pip install pre-commit-localupdate
 ```
 
@@ -27,16 +12,28 @@ pip install pre-commit-localupdate
 
 To check and update the `additional_dependencies` in your `.pre-commit-config.yaml` file, simply run:
 
-```bash
+```shell
 pre-commit-localupdate
 ```
 
 By default, the tool looks for `.pre-commit-config.yaml` in the current directory. To specify a custom file path, use the `-c` or `--config` argument:
 
-```bash
+```shell
 pre-commit-localupdate --config path/to/.pre-commit-config.yaml
 ```
 
+To check the dependencies without updating, use the `--dry-run` flag. The command will exit with a non-zero status code if any package needs updating:
+
+```shell
+pre-commit-localupdate --dry-run
+```
+
+To get debug output use `--debug` flag:
+
+```shell
+pre-commit-localupdate --debug
+```
+
 ## Example
 
 Given a `.pre-commit-config.yaml` with the following content:
@@ -45,6 +42,13 @@ Given a `.pre-commit-config.yaml` with the following content:
 # Comments in the file header are preserved
 ---
 repos:
+  # External hooks won't be touched. Use 'pre-commit autoupdate' command to update them
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
   - repo: local
     hooks:
       # Comment about hooks are preserved
@@ -57,7 +61,7 @@ repos:
         require_serial: true
         types_or: [python, pyi]
         additional_dependencies:
-          # Loose version definitions will be pinned to an exact version
+          # Loose version definitions are pinned to an exact version
           - "black>=25.1.0"
 
       - id: mypy
@@ -94,6 +98,13 @@ Running `pre-commit-localupdate` will update the file to (hypothetical latest ve
 # Comments in the file header are preserved
 ---
 repos:
+  # External hooks won't be touched. Use 'pre-commit autoupdate' command to update them
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
   - repo: local
     hooks:
       # Comment about hooks are preserved
@@ -107,7 +118,7 @@ repos:
         require_serial: true
         types_or: [python, pyi]
         additional_dependencies:
-          # Loose version definitions should be pinned
+          # Loose version definitions are pinned to an exact version
           - "black==26.1.0"
 
       - id: mypy

pre_commit_localupdate-0.2.0/pre_commit_localupdate/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.2.0'

{pre_commit_localupdate-0.1.0 → pre_commit_localupdate-0.2.0}/pre_commit_localupdate/__main__.py

@@ -24,7 +24,7 @@ def main() -> None:
     args = parse_args()
     setup_logging(args.debug)
 
-    if update_additional_dependencies(Path(args.config)):
+    if update_additional_dependencies(Path(args.config), dry_run=args.dry_run):
         logging.info("Done.")
     else:
         logging.info("File content is already up to date.")

{pre_commit_localupdate-0.1.0 → pre_commit_localupdate-0.2.0}/pre_commit_localupdate/cli.py

@@ -2,18 +2,24 @@
 # SPDX-License-Identifier: LGPL-3.0-or-later
 
 import argparse
+from pre_commit_localupdate import __version__
 
 
 def parse_args() -> argparse.Namespace:
     """Parse command line arguments."""
     parser = argparse.ArgumentParser(
-        description="Update Python and Node.js additional_dependencies in .pre-commit-config.yaml"
+        description="Automatically update additional dependencies within local Python and Node.js hooks in pre-commit config files."
     )
     parser.add_argument(
         "--debug",
         action="store_true",
         help="Enable debug logging",
     )
+    parser.add_argument(
+        "--dry-run",
+        action="store_true",
+        help="Dry run mode. Do not update the file and exit with a non-zero code if the configuration files require an update.",
+    )
     parser.add_argument(
         "-c",
         "--config",
@@ -21,5 +27,7 @@ def parse_args() -> argparse.Namespace:
         help="pre-commit config file path",
         default=".pre-commit-config.yaml",
     )
-
+    parser.add_argument(
+        "--version", action="version", version=f"pre-commit-localupdate {__version__}"
+    )
     return parser.parse_args()

pre_commit_localupdate-0.2.0/pre_commit_localupdate/io.py

@@ -0,0 +1,42 @@
+# SPDX-FileCopyrightText: 2026 M. Farzalipour Tabriz, Max Planck Institute for Physics
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
+import logging
+from pathlib import Path
+import sys
+from typing import List, Tuple
+
+
+def load_config_file(file_path: Path) -> Tuple[List[str], str]:
+    logging.debug("Reading configuration file: %s", file_path)
+
+    raw_lines: List[str] = []
+    header_lines: List[str] = []
+    yaml_start_index: int = 0
+
+    try:
+        with file_path.open("r", encoding="utf-8") as f:
+            raw_lines = f.readlines()
+    except FileNotFoundError:
+        logging.exception("File not found: %s", file_path)
+        sys.exit(2)
+    except OSError as exc:
+        logging.exception("IOError while reading file %s: %s", file_path, exc)
+        sys.exit(2)
+
+    logging.debug("Parsing document header...")
+    yaml_start_index = 0
+    for i, line in enumerate(raw_lines):
+        stripped: str = line.strip()
+        if stripped == "---":
+            logging.debug("YAML marker found.")
+            yaml_start_index = i + 1
+            break
+        if stripped and not stripped.startswith("#"):
+            yaml_start_index = i
+            break
+
+    header_lines = raw_lines[:yaml_start_index]
+    yaml_content: str = "".join(raw_lines[yaml_start_index:])
+
+    return header_lines, yaml_content

pre_commit_localupdate-0.2.0/pre_commit_localupdate/julia.py

@@ -0,0 +1,98 @@
+# SPDX-FileCopyrightText: 2026 M. Farzalipour Tabriz, Max Planck Institute for Physics
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
+import logging
+import re
+import tomllib
+import requests
+
+from pre_commit_localupdate.package import PackageBase
+
+# Julia General Registry Source
+JULIA_PKG_API_URL = "https://raw.githubusercontent.com/JuliaRegistries/General/refs/heads/master/{package_name_first_letter}/{package_name}/Versions.toml"
+REQUEST_TIMEOUT = 10
+
+
+class JuliaPackage(PackageBase):
+    """Represents a Julia package."""
+
+    @classmethod
+    def from_specification(package, spec: str) -> "JuliaPackage" | None:
+        """Parse a package specification string into a Package object.
+
+        Handles formats like 'Example@0.4.1', 'Example@0.4', or just 'Example'.
+
+        Args:
+            spec: The package specification string.
+
+        Returns:
+            A Package instance if parsing succeeds, otherwise None.
+
+        """
+        clean_spec = spec.strip().strip('"').strip("'")
+        match = re.match(r"^([a-zA-Z0-9_]+)(?:@([a-zA-Z0-9._+,-]+))?$", clean_spec)
+
+        if not match:
+            logging.warning("Could not parse the package specification: %s", clean_spec)
+            return None
+
+        name = match.group(1)
+        raw_spec = match.group(2)
+        latest_version = package._get_latest_version(name)
+
+        return package(
+            name=name,
+            raw_spec=raw_spec,
+            latest_version=latest_version,
+        )
+
+    @staticmethod
+    def _get_latest_version(package_name: str) -> str | None:
+        """Fetch the latest version of a package from the Julia General Registry.
+
+        Returns:
+            The latest version string if found, otherwise None.
+
+        """
+        logging.debug("Fetching latest version for %s", package_name)
+        try:
+            url = JULIA_PKG_API_URL.format(
+                package_name=package_name, package_name_first_letter=package_name[0]
+            )
+            response = requests.get(url, timeout=REQUEST_TIMEOUT)
+            response.raise_for_status()
+
+            data = tomllib.loads(response.text)
+
+            versions = list(data.keys())
+            if not versions:
+                return None
+
+            versions.sort(reverse=True)
+            latest = versions[0]
+
+            if latest and isinstance(latest, str):
+                return latest
+
+            return None
+        except requests.exceptions.RequestException as exc:
+            logging.warning(
+                "Could not fetch latest version for %s: %s", package_name, exc
+            )
+            return None
+        except (KeyError, ValueError, tomllib.TOMLDecodeError) as exc:
+            logging.warning("Could not parse response for %s: %s", package_name, exc)
+            return None
+
+    def latest_version_specification(package) -> str | None:
+        """Version specification of package pinned to the latest version.
+
+        Returns:
+            The latest version specification string if found, otherwise None.
+            Format: PackageName@version
+
+        """
+        if not package.latest_version:
+            return None
+
+        return f"{package.name}@{package.latest_version}"

{pre_commit_localupdate-0.1.0 → pre_commit_localupdate-0.2.0}/pre_commit_localupdate/pre_commit_config.py

@@ -4,20 +4,24 @@
 import io
 import logging
 from pathlib import Path
+import sys
 
 import ruamel.yaml
 
 from pre_commit_localupdate.node import NodePackage
 from pre_commit_localupdate.package import PackageBase
 from pre_commit_localupdate.python import PyPackage
+from pre_commit_localupdate.julia import JuliaPackage
+from pre_commit_localupdate.io import load_config_file
 
 LANGUAGE_PACKAGE_MAP: dict[str, type[PackageBase]] = {
     "python": PyPackage,
     "node": NodePackage,
+    "julia": JuliaPackage,
 }
 
 
-def update_additional_dependencies(file_path: Path) -> bool:
+def update_additional_dependencies(file_path: Path, *, dry_run: bool = False) -> bool:
     """Reads the configuration file, identifies outdated Python packages in
     local hooks, and updates them directly in the file.
 
@@ -31,38 +35,10 @@ def update_additional_dependencies(file_path: Path) -> bool:
         True if the file was modified and successfully written, False otherwise.
 
     """
-    logging.debug("Reading configuration file: %s", file_path)
 
-    raw_lines = []
-    header_lines = []
-    yaml_start_index = 0
-
-    try:
-        with file_path.open("r", encoding="utf-8") as f:
-            raw_lines = f.readlines()
-    except FileNotFoundError:
-        logging.exception("File not found: %s", file_path)
-        return False
-    except OSError as exc:
-        logging.exception("IOError while reading file %s: %s", file_path, exc)
-        return False
-
-    logging.debug("Parsing document header...")
-    yaml_start_index = 0
-    for i, line in enumerate(raw_lines):
-        stripped = line.strip()
-        if stripped == "---":
-            logging.debug("YAML marker found.")
-            yaml_start_index = i + 1
-            break
-        if stripped and not stripped.startswith("#"):
-            yaml_start_index = i
-            break
-
-    header_lines = raw_lines[:yaml_start_index]
+    header_lines, yaml_content = load_config_file(file_path)
 
     logging.debug("Parsing YAML content...")
-    yaml_content = "".join(raw_lines[yaml_start_index:])
 
     yaml = ruamel.yaml.YAML()
     yaml.preserve_quotes = True
@@ -76,13 +52,13 @@ def update_additional_dependencies(file_path: Path) -> bool:
         config = yaml.load(yaml_content)
     except Exception as exc:
         logging.exception("Failed to parse YAML content from %s: %s", file_path, exc)
-        return False
+        sys.exit(2)
 
     if config is None:
         logging.warning("Configuration file is empty or could not be parsed.")
-        return False
+        sys.exit(2)
 
-    file_modified = False
+    update_required = False
 
     if "repos" in config:
         logging.debug("Scanning repositories for local hooks")
@@ -123,7 +99,7 @@ def update_additional_dependencies(file_path: Path) -> bool:
                         != package.version_specification()
                     ):
                         logging.info(
-                            "Updating %s to %s",
+                            "%s needs updating to %s",
                             package.version_specification(),
                             package.latest_version_specification(),
                         )
@@ -131,7 +107,7 @@ def update_additional_dependencies(file_path: Path) -> bool:
                             i
                         ] = package.latest_version_specification()
 
-                        file_modified = True
+                        update_required = True
                     else:
                         logging.debug(
                             "%s is already correctly defined and up to date (%s).",
@@ -139,20 +115,25 @@ def update_additional_dependencies(file_path: Path) -> bool:
                             package.version_specification(),
                         )
 
-    if file_modified:
-        logging.debug("Writing modified content to disk")
-        try:
-            stream = io.StringIO()
-            yaml.dump(config, stream)
-            modified_body = stream.getvalue()
-            final_content = "".join(header_lines) + modified_body
-
-            with file_path.open("w", encoding="utf-8") as f:
-                f.write(final_content)
-            logging.info("Successfully updated %s", file_path)
-            return True
-        except OSError as exc:
-            logging.exception("IOError while writing to file %s: %s", file_path, exc)
-            return False
+    if update_required:
+        if dry_run:
+            sys.exit(1)
+        else:
+            logging.debug("Writing modified content to disk")
+            try:
+                stream = io.StringIO()
+                yaml.dump(config, stream)
+                modified_body = stream.getvalue()
+                final_content = "".join(header_lines) + modified_body
+
+                with file_path.open("w", encoding="utf-8") as f:
+                    f.write(final_content)
+                logging.info("Successfully updated %s", file_path)
+                return True
+            except OSError as exc:
+                logging.exception(
+                    "IOError while writing to file %s: %s", file_path, exc
+                )
+                return False
 
     return False

{pre_commit_localupdate-0.1.0 → pre_commit_localupdate-0.2.0}/pyproject.toml

@@ -23,11 +23,12 @@ dependencies = [
     "requests>=2.32.5",
     "ruamel-yaml>=0.19.1",
 ]
-description = "A CLI tool to automatically update `additional_dependencies` within local Python hooks in `pre-commit-config.yml` files."
+description = "A CLI tool to automatically update additional dependencies within local Python and Node.js hooks in pre-commit config files."
+dynamic = []
 name = "pre-commit-localupdate"
 readme = "README.md"
-requires-python = "<3.15,>=3.10"
-version = "0.1.0"
+requires-python = "<3.15,>=3.11"
+version = "0.2.0"
 
 [project.scripts]
 pre-commit-localupdate = "pre_commit_localupdate.__main__:main"
@@ -35,6 +36,11 @@ pre-commit-localupdate = "pre_commit_localupdate.__main__:main"
 [project.urls]
 source = "https://gitlab.mpcdf.mpg.de/tbz/pre-commit-localupdate.git"
 
+[tool.pdm.version]
+source = "scm"
+write_template = "__version__ = '{}'"
+write_to = "pre_commit_localupdate/__init__.py"
+
 [tool.tomlsort]
 sort_table_keys = true
 trailing_comma_inline_array = true