Add metadata for check-symlinks

README.md

@@ -35,6 +35,7 @@ Add this to your `.pre-commit-config.yaml`
   the docstring.
 - `check-json` - Attempts to load all json files to verify syntax.
 - `check-merge-conflict` - Check for files that contain merge conflict strings.
+- `check-symlinks` - Checks for symlinks which do not point to anything.
 - `check-xml` - Attempts to load all xml files to verify syntax.
 - `check-yaml` - Attempts to load all yaml files to verify syntax.
 - `debug-statements` - Check for pdb / ipdb / pudb statements in code.

hooks.yaml

@@ -50,6 +50,13 @@
     language: python
     # Match all files
     files: ''
+-   id: check-symlinks
+    name: Check for broken symlinks
+    description: Checks for symlinks which do not point to anything.
+    entry: check-symlinks
+    language: python
+    # Match all files
+    files: ''
 -   id: check-xml
     name: Check Xml
     description: This hook checks xml files for parseable syntax.

setup.py

@@ -43,6 +43,7 @@ setup(
             'check-docstring-first = pre_commit_hooks.check_docstring_first:main',
             'check-json = pre_commit_hooks.check_json:check_json',
             'check-merge-conflict = pre_commit_hooks.check_merge_conflict:detect_merge_conflict',
+            'check-symlinks = pre_commit_hooks.check_symlinks:check_symlinks',
             'check-xml = pre_commit_hooks.check_xml:check_xml',
             'check-yaml = pre_commit_hooks.check_yaml:check_yaml',
             'debug-statement-hook = pre_commit_hooks.debug_statement_hook:debug_statement_hook',