Sync node hooks

Author: mxr

README.md

@@ -30,7 +30,9 @@ $ sync-pre-commit-deps path/to/.pre-commit-config.yaml
 
 ## what it does
 
-Ensures tools which declare `flake8`, `black`, or `mypy` as additional dependencies will have those versions synced with the `flake8`, `black`, or `mypy` versions in the rest of the config. For example, `flake8` under `yesqa` is updated from `5.0.0` to `6.0.0`.
+Hooks like `black`, `yesqa`, and `eslint` reference additional dependencies which are also `pre-commit` hooks. This tool syncs the version in `additional_dependencies` with the version in `rev`.
+
+For example, `flake8` under `yesqa` is updated from `5.0.0` to `6.0.0` because the `flake8` hook uses `6.0.0`:
 
 ```diff
  repos:
@@ -46,3 +48,24 @@ Ensures tools which declare `flake8`, `black`, or `mypy` as additional dependenc
 -        -   flake8==5.0.0
 +        -   flake8==6.0.0
 ```
+
+Another example, the `eslint` version in `additional_dependencies` is updated to match the version in `rev`:
+
+```diff
+ -   repo: https://github.com/pre-commit/mirrors-eslint
+     rev: v4.15.0
+     hooks:
+     -   id: eslint
+         additional_dependencies:
+-        -   eslint@4.14.0
++        -   eslint@4.15.0
+         -   eslint-config-google@0.7.1
+         -   eslint-loader@1.6.1
+         -   eslint-plugin-react@6.10.3
+         -   babel-eslint@6.1.2
+```
+
+## what it doesn't do
+
+- Does not add new additional dependencies. Only updates versions for dependencies that are already specified.
+- Does not sync versions from `package.json`, `requirements.txt`, `pyproject.toml`, etc.

sync_pre_commit_deps.py

@@ -1,12 +1,18 @@
 from __future__ import annotations
 
 import argparse
+import re
 from collections.abc import Sequence
 
 import ruamel.yaml
 
-SUPPORTED = frozenset(('black', 'flake8', 'mypy'))
+SUPPORTED = frozenset({
+    'black', 'flake8', 'mypy', 'eslint',  'csslint', 'fixmyjs', 'jshint',
+    'prettier',
+})
 
+_SEPS = ('==', '@')
+_RE_SEP = re.compile(rf'^(.+)({"|".join(_SEPS)})(.+)$')
 
 _ARGUMENT_HELP_TEMPLATE = (
     'The `{}` argument to the YAML dumper. '
@@ -56,21 +62,23 @@ def main(argv: Sequence[str] | None = None) -> int:
         if repo['repo'] not in ('local', 'meta'):
             for hook in repo['hooks']:
                 if (hid := hook['id']) in SUPPORTED:
-                    # `mirrors-mypy` uses versions with a 'v' prefix, so we
-                    # have to strip it out to get the mypy version.
+                    # `mirrors-mypy` and `eslint` revs have a 'v' prefix, so we
+                    # have to strip that out to get the additional_dependency
+                    # version.
                     cleaned_rev = repo['rev'].removeprefix('v')
                     versions[hid] = cleaned_rev
 
     updated = []
     for repo in loaded['repos']:
         for hook in repo['hooks']:
             for i, dep in enumerate(hook.get('additional_dependencies', ())):
-                name, _, cur_version = dep.partition('==')
-                target_version = versions.get(name, cur_version)
-                if target_version != cur_version:
-                    name_and_version = f'{name}=={target_version}'
-                    hook['additional_dependencies'][i] = name_and_version
-                    updated.append((hook['id'], name))
+                if match := _RE_SEP.match(dep):
+                    name, sep, cur_version = match.groups()
+                    target_version = versions.get(name, cur_version)
+                    if target_version != cur_version:
+                        updated_dep = f'{name}{sep}{target_version}'
+                        hook['additional_dependencies'][i] = updated_dep
+                        updated.append((hook['id'], name))
 
     if updated:
         print(f'Writing updates to {filename}:')

tests/sync_pre_commit_deps_test.py

@@ -22,6 +22,20 @@
             '        -   black==23.3.0\n',
             id='already correct version',
         ),
+        pytest.param(
+            'repos:\n'
+            '-   repo: https://github.com/psf/black\n'
+            '    rev: 23.3.0\n'
+            '    hooks:\n'
+            '    -   id: black\n'
+            '-   repo: https://github.com/adamchainz/blacken-docs\n'
+            '    rev: 1.15.0\n'
+            '    hooks:\n'
+            '    -   id: blacken-docs\n'
+            '        additional_dependencies:\n'
+            '        -   black>=22.3.0\n',
+            id='sep not supported',
+        ),
         pytest.param(
             'repos:\n'
             '-   repo: https://github.com/adamchainz/blacken-docs\n'
@@ -64,6 +78,14 @@
             '        id: black\n',
             id='unicode no-op',
         ),
+        pytest.param(
+            'repos:\n'
+            '-   repo: https://github.com/pre-commit/mirrors-eslint\n'
+            '    rev: v8.39.0\n'
+            '    hooks:\n'
+            '    -   id: eslint\n',
+            id='does not have eslint in additional_dependencies',
+        ),
     ),
 )
 def test_main_noop(tmpdir, s):
@@ -100,6 +122,14 @@ def test_main_writes_all(tmpdir):
         '    rev: v1.13.0\n'
         '    hooks:\n'
         '    -   id: mypy\n'
+        # gives the `eslint` version and also has its
+        # additional_dependencies rewritten
+        '-   repo: https://github.com/pre-commit/mirrors-eslint\n'
+        '    rev: v8.39.0\n'
+        '    hooks:\n'
+        '    -   id: eslint\n'
+        '        additional_dependencies:\n'
+        '        -   eslint@8.38.0\n'
         # all repos below should have their additional_dependencies rewritten
         '-   repo: https://github.com/asottile/yesqa\n'
         '    rev: v1.5.0\n'
@@ -149,6 +179,12 @@ def test_main_writes_all(tmpdir):
         '    rev: v1.13.0\n'
         '    hooks:\n'
         '    -   id: mypy\n'
+        '-   repo: https://github.com/pre-commit/mirrors-eslint\n'
+        '    rev: v8.39.0\n'
+        '    hooks:\n'
+        '    -   id: eslint\n'
+        '        additional_dependencies:\n'
+        '        -   eslint@8.39.0\n'
         '-   repo: https://github.com/asottile/yesqa\n'
         '    rev: v1.5.0\n'
         '    hooks:\n'