Add description field

Author: adamchainz

pre_commit_mirror_maker/all/.pre-commit-hooks.yaml

@@ -1,5 +1,6 @@
 -   id: {id}
     name: {name}
+    description: {description!r}
     entry: {entry}
     language: {language}
     '{match_key}': {match_val}

pre_commit_mirror_maker/main.py

@@ -41,6 +41,9 @@ def main(argv: Sequence[str] | None = None) -> int:
         '--package-name', required=True,
         help='Package name as it appears on the remote package manager.',
     )
+    parser.add_argument(
+        '--description', help='Hook description.', default='',
+    )
 
     mutex = parser.add_mutually_exclusive_group(required=True)
     mutex.add_argument(
@@ -88,6 +91,7 @@ def main(argv: Sequence[str] | None = None) -> int:
     make_repo(
         args.repo_path,
         name=args.package_name,
+        description=args.description,
         language=args.language,
         entry=args.entry or args.package_name,
         id=args.id or args.entry or args.package_name,

tests/main_test.py

@@ -40,7 +40,8 @@ def test_main_passes_args(mock_make_repo):
     ))
     mock_make_repo.assert_called_once_with(
         '.',
-        language='ruby', name='scss-lint', entry='scss-lint-entry',
+        language='ruby', name='scss-lint', description='',
+        entry='scss-lint-entry',
         id='scss-lint-id', match_key='files', match_val=r'\.scss$', args='[]',
         require_serial='false', minimum_pre_commit_version='0',
     )

tests/make_repo_test.py

@@ -65,10 +65,10 @@ def in_git_dir(tmpdir):
 def test_commit_version(in_git_dir):
     _commit_version(
         '.',
-        version='0.24.1', language='ruby', name='scss-lint', entry='scss-lint',
-        id='scss-lint', match_key='files', match_val=r'\.scss$', args='[]',
-        additional_dependencies='[]', require_serial='false',
-        minimum_pre_commit_version='0',
+        version='0.24.1', language='ruby', name='scss-lint', description='',
+        entry='scss-lint', id='scss-lint', match_key='files',
+        match_val=r'\.scss$', args='[]', additional_dependencies='[]',
+        require_serial='false', minimum_pre_commit_version='0',
     )
 
     # Assert that our things got copied over
@@ -86,15 +86,17 @@ def test_commit_version(in_git_dir):
 def test_arguments(in_git_dir):
     _commit_version(
         '.',
-        version='0.6.2', language='python', name='yapf', entry='yapf',
-        id='yapf', match_key='files', match_val=r'\.py$', args='["-i"]',
+        version='0.6.2', language='python', name='yapf',
+        description='Yet another Python formatter.', entry='yapf', id='yapf',
+        match_key='files', match_val=r'\.py$', args='["-i"]',
         additional_dependencies='["scikit-learn"]', require_serial='false',
         minimum_pre_commit_version='0',
     )
     contents = in_git_dir.join('.pre-commit-hooks.yaml').read()
     assert yaml.safe_load(contents) == [{
         'id': 'yapf',
         'name': 'yapf',
+        'description': 'Yet another Python formatter.',
         'entry': 'yapf',
         'language': 'python',
         'files': r'\.py$',
@@ -115,8 +117,8 @@ def fake_versions():
 def test_make_repo_starting_empty(in_git_dir, fake_versions):
     make_repo(
         '.',
-        language='ruby', name='scss-lint', entry='scss-lint', id='scss-lint',
-        match_key='files', match_val=r'\.scss$', args='[]',
+        language='ruby', name='scss-lint', description='', entry='scss-lint',
+        id='scss-lint', match_key='files', match_val=r'\.scss$', args='[]',
         require_serial='false', minimum_pre_commit_version='0',
     )
 
@@ -147,8 +149,8 @@ def test_make_repo_starting_at_version(in_git_dir, fake_versions):
 
     make_repo(
         '.',
-        language='ruby', name='scss-lint', entry='scss-lint', id='scss-lint',
-        match_key='files', match_val=r'\.scss$', args='[]',
+        language='ruby', name='scss-lint', description='', entry='scss-lint',
+        id='scss-lint', match_key='files', match_val=r'\.scss$', args='[]',
         require_serial='false', minimum_pre_commit_version='0',
     )
 
@@ -167,8 +169,8 @@ def test_make_repo_starting_at_version(in_git_dir, fake_versions):
 def test_ruby_integration(in_git_dir):
     make_repo(
         '.',
-        language='ruby', name='scss-lint', entry='scss-lint', id='scss-lint',
-        match_key='files', match_val=r'\.scss$', args='[]',
+        language='ruby', name='scss-lint', description='', entry='scss-lint',
+        id='scss-lint', match_key='files', match_val=r'\.scss$', args='[]',
         require_serial='false', minimum_pre_commit_version='0',
     )
     # Our files should exist
@@ -187,8 +189,8 @@ def test_ruby_integration(in_git_dir):
 def test_node_integration(in_git_dir):
     make_repo(
         '.',
-        language='node', name='jshint', entry='jshint', id='jshint',
-        match_key='files', match_val=r'\.js$', args='[]',
+        language='node', name='jshint', description='', entry='jshint',
+        id='jshint', match_key='files', match_val=r'\.js$', args='[]',
         require_serial='false', minimum_pre_commit_version='0',
     )
     # Our files should exist
@@ -207,8 +209,8 @@ def test_node_integration(in_git_dir):
 def test_python_integration(in_git_dir):
     make_repo(
         '.',
-        language='python', name='flake8', entry='flake8', id='flake8',
-        match_key='files', match_val=r'\.py$', args='[]',
+        language='python', name='flake8', description='', entry='flake8',
+        id='flake8', match_key='files', match_val=r'\.py$', args='[]',
         require_serial='false', minimum_pre_commit_version='0',
     )
     # Our files should exist
@@ -230,9 +232,9 @@ def test_python_integration(in_git_dir):
 def test_rust_integration(in_git_dir):
     make_repo(
         '.',
-        language='rust', name='shellharden', entry='shellharden',
-        id='shellharden', match_key='types', match_val='shell',
-        args='["--replace"]', require_serial='false',
+        language='rust', name='shellharden', description='',
+        entry='shellharden', id='shellharden', match_key='types',
+        match_val='shell', args='["--replace"]', require_serial='false',
         minimum_pre_commit_version='0',
     )
     # Our files should exist