feat: add pre-commit hooks

.pre-commit-hooks.yaml

@@ -0,0 +1,7 @@
+- id: dargs-check
+  name: dargs-check
+  description: "Run 'dargs check' to check JSON files."
+  entry: dargs check
+  language: python
+  types_or: [json]
+  minimum_pre_commit_version: "2.9.2"

README.md

@@ -28,6 +28,7 @@ Please refer to test files for detailed usage.
 ## Additional features
 
 - [PEP 484](https://peps.python.org/pep-0484/) type annotations
+- Check JSON files using [pre-commit](https://github.com/pre-commit/pre-commit)
 - Native integration with [Sphinx](https://github.com/sphinx-doc/sphinx), [DP-GUI](https://github.com/deepmodeling/dpgui), and [Jupyter Notebook](https://jupyter.org/)
 - JSON encoder for `Argument` and `Variant` classes
 - Generate [JSON schema](https://json-schema.org/) from an `Argument`, which can be further integrated with JSON editors such as [Visual Studio Code](https://code.visualstudio.com/)

dargs/cli.py

@@ -90,7 +90,7 @@
     dict
         normalized data
     """
-    module_name, attr_name = func.rsplit(".", 1)
+    module_name, attr_name = func.strip().rsplit(".", 1)
     try:
         mod = __import__(module_name, globals(), locals(), [attr_name])
     except ImportError as e:

docs/index.rst

@@ -12,6 +12,7 @@ Welcome to dargs's documentation!
 
    intro
    cli
+   pre-commit
    sphinx
    dpgui
    nb

docs/pre-commit.md

@@ -0,0 +1,16 @@
+# Pre-commit hooks
+
+To check JSON files (available as of dargs v0.4.8) via [pre-commit](https://github.com/pre-commit/pre-commit), add the following to your `.pre-commit-config.yaml`:
+
+```yaml
+-   repo: https://github.com/deepmodeling/dargs
+    rev: v0.4.8
+    hooks:
+    -   id: dargs-check
+        # Specify the function to return arguments
+        args: ["-f dargs._test.test_arguments"]
+        # Pattern of JSON files to check
+        files: "tests/test_arguments.json"
+        # Add additional Python dependencies for arguments
+        additional_dependencies: []
+```