Merge pull request nsidc#609 from nsidc/more-basic-checks

More pre-commit checks from official repo
Sherwin-14 · Jul 6, 2024 · 30ddd87 · 30ddd87
2 parents 2df1da9 + a8956e1
commit 30ddd87
Show file tree

Hide file tree

Showing 13 changed files with 20 additions and 18 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,3 +1,3 @@
 notebooks/** linguist-documentation
 docs/** linguist-documentation
-tests/unit/fixtures/vcr_cassettes/** linguist-documentation
+tests/unit/fixtures/vcr_cassettes/** linguist-documentation
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -7,10 +7,25 @@ repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.6.0
     hooks:
+      # Validate format
       - id: check-yaml
-      - id: trailing-whitespace
       - id: check-toml
       - id: check-json
+      # Check for common mistakes
+      - id: check-added-large-files
+      - id: check-case-conflict
+      # - id: check-illegal-windows-names # TODO: Enable in next release
+      - id: check-merge-conflict
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+      - id: check-symlinks
+      - id: check-vcs-permalinks
+      - id: destroyed-symlinks
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: no-commit-to-branch # protects `main` by default
+      - id: trailing-whitespace
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.5.0

diff --git a/binder/postBuild b/binder/postBuild
@@ -4,4 +4,3 @@ set -ex
 
 poetry config virtualenvs.create false
 poetry install --no-dev
-
diff --git a/docs/howto/access-data.md b/docs/howto/access-data.md
@@ -41,5 +41,3 @@ And that's it in just one line of code! This same piece of code will also work f
 
 
 > More examples coming soon!
-
-
diff --git a/docs/howto/cloud.md b/docs/howto/cloud.md
@@ -1,3 +1,3 @@
 # Direct S3 access for cloud-based datasets
 
-Coming soon
+Coming soon
diff --git a/docs/howto/search-collections.md b/docs/howto/search-collections.md
@@ -1,3 +1,3 @@
 # how to search for data collections using spatial, temporal,  keyword filters
 
-Coming soon
+Coming soon
diff --git a/docs/howto/search-granules.md b/docs/howto/search-granules.md
@@ -32,5 +32,3 @@ results = earthaccess.search_data(
 ```
 
 Now that we have our results we can do multiple things: We can iterate over them to get HTTP (or S3) links, we can download the files to a local folder, or we can open these files and stream their content directly to other libraries e.g. xarray.
-
-
diff --git a/docs/howto/storage-location.md b/docs/howto/storage-location.md
@@ -1,3 +1,3 @@
 # Determine if a data set is on-prem or in the cloud
 
-Coming soon
+Coming soon
diff --git a/docs/resources.md b/docs/resources.md
@@ -5,5 +5,3 @@
 * [earthaccess @ AGU poster](https://docs.google.com/presentation/d/1OOSZzbHv6Ck4lzOE01FQdI4kX0VCfcVBS4pWCc7dtBo/edit?usp=sharing)
 
 * [NSIDC Cloud Data Access Guide](https://nsidc.org/data/user-resources/help-center/nasa-earthdata-cloud-data-access-guide)
-
-
diff --git a/docs/user-reference/collections/collections-query.md b/docs/user-reference/collections/collections-query.md
@@ -7,4 +7,3 @@
         show_source: false
         inherited_members: true
     show_source: false
-
diff --git a/docs/user-reference/collections/collections.md b/docs/user-reference/collections/collections.md
@@ -5,4 +5,3 @@
       inherited_members: true
     show_root_heading: true
     show_source: false
-
diff --git a/docs/user-reference/granules/granules-query.md b/docs/user-reference/granules/granules-query.md
@@ -8,4 +8,3 @@
       inherited_members: true
     show_root_heading: true
     show_source: false
-
diff --git a/docs/user-reference/granules/granules.md b/docs/user-reference/granules/granules.md
@@ -5,6 +5,3 @@
       inherited_members: true
     show_root_heading: true
     show_source: false
-
-
-
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,4 +4,3 @@ set -ex

		poetry config virtualenvs.create false
		poetry install --no-dev
Original file line number	Diff line number	Diff line change
Expand Up		@@ -41,5 +41,3 @@ And that's it in just one line of code! This same piece of code will also work f


		> More examples coming soon!
Original file line number	Diff line number	Diff line change
Expand Up		@@ -32,5 +32,3 @@ results = earthaccess.search_data(
		```

		Now that we have our results we can do multiple things: We can iterate over them to get HTTP (or S3) links, we can download the files to a local folder, or we can open these files and stream their content directly to other libraries e.g. xarray.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,5 +5,3 @@
		* [earthaccess @ AGU poster](https://docs.google.com/presentation/d/1OOSZzbHv6Ck4lzOE01FQdI4kX0VCfcVBS4pWCc7dtBo/edit?usp=sharing)

		* [NSIDC Cloud Data Access Guide](https://nsidc.org/data/user-resources/help-center/nasa-earthdata-cloud-data-access-guide)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,4 +7,3 @@
		show_source: false
		inherited_members: true
		show_source: false
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,4 +5,3 @@
		inherited_members: true
		show_root_heading: true
		show_source: false
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,3 @@
		inherited_members: true
		show_root_heading: true
		show_source: false
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,6 +5,3 @@
		inherited_members: true
		show_root_heading: true
		show_source: false