Added basic pre-commit

asdf-format · Feb 17, 2022 · 089be85 · 089be85
1 parent f02034b
commit 089be85
Show file tree

Hide file tree

Showing 15 changed files with 29 additions and 16 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,14 @@
+repos:
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.1.0
+  hooks:
+  - id: check-added-large-files
+  - id: check-case-conflict
+  - id: check-yaml
+    args: ["--unsafe"]
+  - id: debug-statements
+  - id: end-of-file-fixer
+    exclude: ".*fits"
+  - id: trailing-whitespace
+    exclude: ".*fits"
diff --git a/asdf/tags/core/tests/data/datatype-1.0.0.yaml b/asdf/tags/core/tests/data/datatype-1.0.0.yaml
@@ -24,4 +24,4 @@ properties:
         datatype: int16
       - name: b
         datatype: ['ascii', 16]
-    exact_datatype: true
+    exact_datatype: true
diff --git a/asdf/tags/core/tests/data/ndim-1.0.0.yaml b/asdf/tags/core/tests/data/ndim-1.0.0.yaml
@@ -8,4 +8,4 @@ properties:
     ndim: 2
 
   b:
-    max_ndim: 2
+    max_ndim: 2
diff --git a/asdf/tests/data/complex-42.0.0.yaml b/asdf/tests/data/complex-42.0.0.yaml
@@ -2,4 +2,4 @@
 ---
 $schema: "http://stsci.edu/schemas/yaml-schema/draft-01"
 id: "http://stsci.edu/schemas/asdf/core/custom-42.0.0"
-type: string
+type: string
diff --git a/asdf/tests/data/custom-1.0.0.yaml b/asdf/tests/data/custom-1.0.0.yaml
@@ -3,4 +3,4 @@
 $schema: "http://stsci.edu/schemas/yaml-schema/draft-01"
 id: "http://nowhere.org/schemas/custom/custom-1.0.0"
 type: integer
-default: 42
+default: 42
diff --git a/asdf/tests/data/custom_flow-1.0.0.yaml b/asdf/tests/data/custom_flow-1.0.0.yaml
@@ -8,4 +8,4 @@ properties:
     type: number
   b:
     type: number
-flowStyle: block
+flowStyle: block
diff --git a/asdf/tests/data/missing-1.1.0.yaml b/asdf/tests/data/missing-1.1.0.yaml
@@ -2,4 +2,4 @@
 ---
 $schema: "http://stsci.edu/schemas/yaml-schema/draft-01"
 id: "http://nowhere.org/schemas/custom/missing-1.1.0"
-type: object
+type: object
diff --git a/asdf/tests/data/self_referencing-1.0.0.yaml b/asdf/tests/data/self_referencing-1.0.0.yaml
@@ -5,4 +5,4 @@ id: "http://nowhere.org/schemas/custom/self_referencing-1.0.0"
 anyOf:
   - type: object
   - $ref: "#/anyOf/0"
-...
+...
diff --git a/compatibility_tests/README.md b/compatibility_tests/README.md
@@ -7,4 +7,4 @@ into a virtualenv, so an internet connection is required to run them.
 
 The tests in this directory are excluded from the normal test suite, but
 can be run (from the repo root directory) with
-`pytest compatibility_tests/ --remote-data`.
+`pytest compatibility_tests/ --remote-data`.
diff --git a/docs/_templates/autosummary/base.rst b/docs/_templates/autosummary/base.rst
@@ -1,2 +1,2 @@
 {% extends "autosummary_core/base.rst" %}
-{# The template this is inherited from is in astropy/sphinx/ext/templates/autosummary_core. If you want to modify this template, it is strongly recommended that you still inherit from the astropy template. #}
+{# The template this is inherited from is in astropy/sphinx/ext/templates/autosummary_core. If you want to modify this template, it is strongly recommended that you still inherit from the astropy template. #}
diff --git a/docs/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst
@@ -1,2 +1,2 @@
 {% extends "autosummary_core/class.rst" %}
-{# The template this is inherited from is in astropy/sphinx/ext/templates/autosummary_core. If you want to modify this template, it is strongly recommended that you still inherit from the astropy template. #}
+{# The template this is inherited from is in astropy/sphinx/ext/templates/autosummary_core. If you want to modify this template, it is strongly recommended that you still inherit from the astropy template. #}
diff --git a/docs/_templates/autosummary/module.rst b/docs/_templates/autosummary/module.rst
@@ -1,2 +1,2 @@
 {% extends "autosummary_core/module.rst" %}
-{# The template this is inherited from is in astropy/sphinx/ext/templates/autosummary_core. If you want to modify this template, it is strongly recommended that you still inherit from the astropy template. #}
+{# The template this is inherited from is in astropy/sphinx/ext/templates/autosummary_core. If you want to modify this template, it is strongly recommended that you still inherit from the astropy template. #}
diff --git a/docs/asdf/developer_overview.rst b/docs/asdf/developer_overview.rst
@@ -711,4 +711,3 @@ and keeping necessary state, which means that the ``AsdfFile`` can go
 unmodified.  The ``SerializationContext`` will be relatively lightweight and
 creating it will not incur as much of a performance penalty as creating an
 ``AsdfFile``.
-
diff --git a/docs/asdf/extending/schemas.rst b/docs/asdf/extending/schemas.rst
@@ -243,4 +243,4 @@ an error if not.
 
 .. _JSON Schema Draft 4: https://json-schema.org/specification-links.html#draft-4
 .. _Understanding JSON Schema: https://json-schema.org/understanding-json-schema/
-.. _quantity schema: https://asdf-standard.readthedocs.io/en/latest/generated/stsci.edu/asdf/unit/quantity-1.1.0.html
+.. _quantity schema: https://asdf-standard.readthedocs.io/en/latest/generated/stsci.edu/asdf/unit/quantity-1.1.0.html
diff --git a/docs/asdf/features.rst b/docs/asdf/features.rst
@@ -533,10 +533,10 @@ The `AsdfFile.info` method behaves similarly to `asdf.info`, rendering
 the tree of the associated `AsdfFile`.
 
 Normally `asdf.info` will not show the contents of asdf nodes turned
-into Python custom objects, but if that object supports a special 
-method, you may see the contents of such objects. 
+into Python custom objects, but if that object supports a special
+method, you may see the contents of such objects.
 See :ref:`exposing_extension_object_internals` for how
-to implement such support for `asdf.info` and `asdf.search`. 
+to implement such support for `asdf.info` and `asdf.search`.
 
 Searching the ASDF tree
 =======================
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,4 +8,4 @@ properties: @@
         ndim: 2
       b:
-        max_ndim: 2
+        max_ndim: 2
Original file line number	Diff line number	Diff line change
Expand Up		@@ -711,4 +711,3 @@ and keeping necessary state, which means that the ``AsdfFile`` can go
		unmodified. The ``SerializationContext`` will be relatively lightweight and
		creating it will not incur as much of a performance penalty as creating an
		``AsdfFile``.