Prettier formatter (microsoft#2018)

* Formatted with Prettier * Added package-lock.json * Removed the .idea folder * Removed version * Added .prettierignore with tests/data/* * Added npm updates * Updated prettier * Update style.yaml Co-authored-by: Adam J. Stewart <[email protected]> * Updated linters section * Added Prettier hook * Added Prettier hook * Added exclude regex * Update .prettierignore Co-authored-by: Adam J. Stewart <[email protected]> * Added package.json and package-lock.json * Added npm ci flag * Formatted with Prettier * Updated .gitignore * Reverted changes in data folder * Added .idea to ignored entries * Delete package-lock.json from root * Added cache dependency path * Formatted with Prettier * Updated tests.yaml * Updated regex * Updated actions/checkout to v4.1.4 * Updated SECURITY and dependabot * Removed .idea and requirements/node_modules * Updated package files * Changed .yaml files format * Added EOL * Updated contributing.rst * Updated style.yaml * Updated style CI * Added node_modules to ignored entries * Updated npm install command * Added *.json root files to ignored entries * Updated prettier version range * Updated prettier install command * Relocated # Node stuff --------- Co-authored-by: Adam J. Stewart <[email protected]>
adamjstewart · May 3, 2024 · bd9c757 · bd9c757
1 parent 7596e75
commit bd9c757
Show file tree

Hide file tree

Showing 52 changed files with 760 additions and 511 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -38,7 +38,7 @@
         "python.editor.codeActionsOnSave": {
           "source.organizeImports": true
         },
-        "python.diffEditor.wordWrap": "off",
+        "python.diffEditor.wordWrap": "off"
       }
     }
   }

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -2,12 +2,12 @@
 
 TorchGeo is an open-source project built by contributors like you from around the world. If you find a bug or would like to add a new feature, please open a pull request. For further information on how to contribute, including topics like:
 
-* using git,
-* licensing requirements,
-* writing and running unit tests,
-* running linters,
-* building the documentation, and
-* adding new datasets,
+- using git,
+- licensing requirements,
+- writing and running unit tests,
+- running linters,
+- building the documentation, and
+- adding new datasets,
 
 please see our [Contributing Guide](https://torchgeo.readthedocs.io/en/stable/user/contributing.html).
 

diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -3,56 +3,56 @@ description: Create a report to help us reproduce and fix a bug
 labels: [bug]
 
 body:
-- type: textarea
-  attributes:
-    label: Description
-    description: >
-      Please provide a clear and concise description of the bug.
-  validations:
-    required: true
-- type: textarea
-  attributes:
-    label: Steps to reproduce
-    description: >
-      We can't solve your issue if we can't reproduce it. Please provide a
-      [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example)
-      that shows how to reproduce the bug. If the bug requires any additional files to
-      reproduce, please upload those or provide a download link. Your code should be
-      runnable and include all relevant imports.
-    placeholder: |
-      1. Download any Landsat 8 scene from https://earthexplorer.usgs.gov/
-      2. Run the following code to reproduce the error
+  - type: textarea
+    attributes:
+      label: Description
+      description: >
+        Please provide a clear and concise description of the bug.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Steps to reproduce
+      description: >
+        We can't solve your issue if we can't reproduce it. Please provide a
+        [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example)
+        that shows how to reproduce the bug. If the bug requires any additional files to
+        reproduce, please upload those or provide a download link. Your code should be
+        runnable and include all relevant imports.
+      placeholder: |
+        1. Download any Landsat 8 scene from https://earthexplorer.usgs.gov/
+        2. Run the following code to reproduce the error
 
-      ```python
-      from torchgeo.datasets import Landsat8
+        ```python
+        from torchgeo.datasets import Landsat8
 
-      ds = Landsat8("/path/to/downloads/directory")
-      ...
-      ```
-  validations:
-    required: true
-- type: input
-  attributes:
-    label: Version
-    description: |
-      What version of TorchGeo are you using? This can be found using the following code.
-      ```console
-      $ python
-      >>> import torchgeo
-      >>> torchgeo.__version__
-      X.Y.Z
-      ```
-      If you are using a development release (ends with ".dev0") please also include the specific git commit.
+        ds = Landsat8("/path/to/downloads/directory")
+        ...
+        ```
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Version
+      description: |
+        What version of TorchGeo are you using? This can be found using the following code.
+        ```console
+        $ python
+        >>> import torchgeo
+        >>> torchgeo.__version__
+        X.Y.Z
+        ```
+        If you are using a development release (ends with ".dev0") please also include the specific git commit.
 
-      Whenever possible, try to reproduce your issue with the latest commit from `main`. You never know, someone may have already fixed your bug!
-    placeholder: |
-      1.2.3.dev0 (e1285e6cc6b65080e82bdbf7de9dea3f647d8b3b)
-  validations:
-    required: true
-- type: markdown
-  attributes:
-    value: >
-      Thanks for taking the time to report this bug! TorchGeo is an open-source project
-      maintained by its users. If you're Python savvy and want to contribute a pull
-      request to fix this bug, we'll be happy to review it. If not, we'll try to fix it
-      as long as we can reproduce it.
+        Whenever possible, try to reproduce your issue with the latest commit from `main`. You never know, someone may have already fixed your bug!
+      placeholder: |
+        1.2.3.dev0 (e1285e6cc6b65080e82bdbf7de9dea3f647d8b3b)
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: >
+        Thanks for taking the time to report this bug! TorchGeo is an open-source project
+        maintained by its users. If you're Python savvy and want to contribute a pull
+        request to fix this bug, we'll be happy to review it. If not, we'll try to fix it
+        as long as we can reproduce it.
diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml
@@ -3,23 +3,23 @@ description: Issues or suggestions related to documentation
 labels: [documentation]
 
 body:
-- type: textarea
-  attributes:
-    label: Issue
-    description: >
-      A clear and concise description of what is wrong with or missing from the
-      documentation.
-  validations:
-    required: true
-- type: textarea
-  attributes:
-    label: Fix
-    description: >
-      Tell us how we could improve the documentation!
-- type: markdown
-  attributes:
-    value: >
-      Thanks for taking the time to improve the documentation! TorchGeo is an
-      open-source project maintained by its users. If you're rST savvy and want
-      to contribute a pull request to improve the docs, we'll be happy to review
-      it. If not, we'll try to fix it when a get a chance.
+  - type: textarea
+    attributes:
+      label: Issue
+      description: >
+        A clear and concise description of what is wrong with or missing from the
+        documentation.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Fix
+      description: >
+        Tell us how we could improve the documentation!
+  - type: markdown
+    attributes:
+      value: >
+        Thanks for taking the time to improve the documentation! TorchGeo is an
+        open-source project maintained by its users. If you're rST savvy and want
+        to contribute a pull request to improve the docs, we'll be happy to review
+        it. If not, we'll try to fix it when a get a chance.
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml
@@ -3,45 +3,45 @@ description: Submit a proposal/request for a new TorchGeo feature
 labels: [feature]
 
 body:
-- type: markdown
-  attributes:
-    value: >
-      TorchGeo is a PyTorch domain library for _geospatial_ data. If the feature you
-      are suggesting is not specific to working with geospatial data or multispectral
-      satellite imagery and may be of interest to the broader computer vision
-      community, consider contributing it to
-      [torchvision](https://github.com/pytorch/vision) or
-      [kornia](https://github.com/kornia/kornia) instead.
-- type: textarea
-  attributes:
-    label: Summary
-    description: >
-      A clear and concise summary of your suggestion.
-- type: textarea
-  attributes:
-    label: Rationale
-    description: >
-      Why is this feature important? Is it related to a problem you are experiencing?
-- type: textarea
-  attributes:
-    label: Implementation
-    description: >
-      If you've thought about how to implement this feature, describe your proposed
-      solution.
-- type: textarea
-  attributes:
-    label: Alternatives
-    description: >
-      Are there any alternatives to the solution you've proposed?
-- type: textarea
-  attributes:
-    label: Additional information
-    description: >
-      Any additional information that might be relevant to the proposed feature.
-- type: markdown
-  attributes:
-    value: >
-      Thanks for suggesting this awesome new feature! TorchGeo is an open-source project
-      maintained by its users. If you're Python savvy and want to contribute a pull
-      request to implement this feature, we'll be happy to review it. If not, we'll try
-      to implement your feature when we get a chance.
+  - type: markdown
+    attributes:
+      value: >
+        TorchGeo is a PyTorch domain library for _geospatial_ data. If the feature you
+        are suggesting is not specific to working with geospatial data or multispectral
+        satellite imagery and may be of interest to the broader computer vision
+        community, consider contributing it to
+        [torchvision](https://github.com/pytorch/vision) or
+        [kornia](https://github.com/kornia/kornia) instead.
+  - type: textarea
+    attributes:
+      label: Summary
+      description: >
+        A clear and concise summary of your suggestion.
+  - type: textarea
+    attributes:
+      label: Rationale
+      description: >
+        Why is this feature important? Is it related to a problem you are experiencing?
+  - type: textarea
+    attributes:
+      label: Implementation
+      description: >
+        If you've thought about how to implement this feature, describe your proposed
+        solution.
+  - type: textarea
+    attributes:
+      label: Alternatives
+      description: >
+        Are there any alternatives to the solution you've proposed?
+  - type: textarea
+    attributes:
+      label: Additional information
+      description: >
+        Any additional information that might be relevant to the proposed feature.
+  - type: markdown
+    attributes:
+      value: >
+        Thanks for suggesting this awesome new feature! TorchGeo is an open-source project
+        maintained by its users. If you're Python savvy and want to contribute a pull
+        request to implement this feature, we'll be happy to review it. If not, we'll try
+        to implement your feature when we get a chance.
diff --git a/.github/SECURITY.md b/.github/SECURITY.md
@@ -4,27 +4,27 @@
 
 Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
 
-If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below.
+If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383%28v=technet.10%29), please report it to us as described below.
 
 ## Reporting Security Issues
 
 **Please do not report security vulnerabilities through public GitHub issues.**
 
 Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
 
-If you prefer to submit without logging in, send email to [[email protected]](mailto:[email protected]).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
+If you prefer to submit without logging in, send email to [[email protected]](mailto:[email protected]). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
 
-You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). 
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
 
 Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
 
-  * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
-  * Full paths of source file(s) related to the manifestation of the issue
-  * The location of the affected source code (tag/branch/commit or direct URL)
-  * Any special configuration required to reproduce the issue
-  * Step-by-step instructions to reproduce the issue
-  * Proof-of-concept or exploit code (if possible)
-  * Impact of the issue, including how an attacker might exploit the issue
+- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+- Full paths of source file(s) related to the manifestation of the issue
+- The location of the affected source code (tag/branch/commit or direct URL)
+- Any special configuration required to reproduce the issue
+- Step-by-step instructions to reproduce the issue
+- Proof-of-concept or exploit code (if possible)
+- Impact of the issue, including how an attacker might exploit the issue
 
 This information will help us triage your report more quickly.
 

diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md
@@ -1,13 +1,13 @@
-# Support
-
-## How to file issues and get help
-
-This project uses GitHub Issues to track bugs and feature requests. Please search the existing
-issues before filing new issues to avoid duplicates.  For new issues, file your bug or
-feature request as a new Issue.
-
-For help and questions about using this project, please open an Issue.
-
-## Microsoft Support Policy
-
-Support for TorchGeo is limited to the resources listed above.
+# Support
+
+## How to file issues and get help
+
+This project uses GitHub Issues to track bugs and feature requests. Please search the existing
+issues before filing new issues to avoid duplicates. For new issues, file your bug or
+feature request as a new Issue.
+
+For help and questions about using this project, please open an Issue.
+
+## Microsoft Support Policy
+
+Support for TorchGeo is limited to the resources listed above.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -29,3 +29,7 @@ updates:
         versions: ">=6"
       # segmentation-models-pytorch pins timm, must update in unison
       - dependency-name: "timm"
+  - package-ecosystem: "npm"
+    directory: "/requirements"
+    schedule:
+      interval: "weekly"