lint

quiltdata · Dec 5, 2024 · 041cf6d · 041cf6d
1 parent 7924f2a
commit 041cf6d
Show file tree

Hide file tree

Showing 8 changed files with 181 additions and 174 deletions.
diff --git a/.github/workflows/mega-linter.yml b/.github/workflows/mega-linter.yml
@@ -17,7 +17,7 @@ env: # Comment env block if you do not want to apply fixes
   #APPLY_FIXES_MODE: pull_request # If APPLY_FIXES is used, defines if the fixes are directly committed (commit) or posted in a PR (pull_request)
   DISABLE_LINTERS: SPELL_CSPELL,COPYPASTE_JSCPD,REPOSITORY_GITLEAKS,GROOVY_NPM_GROOVY_LINT
   FILTER_REGEX_EXCLUDE: .*/.*gradle
- 
+
 concurrency:
   group: ${{ github.ref }}-${{ github.workflow }}
   cancel-in-progress: true
@@ -31,7 +31,7 @@ jobs:
       - name: Checkout Code
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
         with:
-          token: ${{ secrets.GITHUB_TOKEN }} # secrets.PAT || 
+          token: ${{ secrets.GITHUB_TOKEN }} # secrets.PAT ||
           fetch-depth: 0 # If you use VALIDATE_ALL_CODEBASE = true, you can remove this line to improve performances
 
       # MegaLinter

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -25,49 +25,48 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
-    # Git Checkout
-    - name: Checkout Code
-      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
-      with:
-        token: ${{ secrets.GITHUB_TOKEN }}
-        fetch-depth: 0
+      # Git Checkout
+      - name: Checkout Code
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          fetch-depth: 0
 
-    - name: Configure AWS Credentials
-      uses: aws-actions/configure-aws-credentials@v4
-      with:
-        role-to-assume: arn:aws:iam::712023778557:role/github/GitHub-Testing-NF-Quilt
-        aws-region: us-east-1
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          role-to-assume: arn:aws:iam::712023778557:role/github/GitHub-Testing-NF-Quilt
+          aws-region: us-east-1
 
-    - name: Setup Java ${{matrix.java_version}}
-      uses: actions/setup-java@v4
-      with:
-        java-version: ${{matrix.java_version}}
-        distribution: 'temurin'
-        architecture: x64
-        cache: gradle
-
-    - name: Setup Gradle
-      uses: gradle/actions/setup-gradle@v4
+      - name: Setup Java ${{matrix.java_version}}
+        uses: actions/setup-java@v4
+        with:
+          java-version: ${{matrix.java_version}}
+          distribution: "temurin"
+          architecture: x64
+          cache: gradle
 
-    - name: Run Gradle Tests
-      run: make test
-      env:
-        LOG4J_DEBUG: true
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
 
-    - name: Archive production artifacts (Windows only)
-      uses: actions/upload-artifact@v4
-      if: ${{ always() && matrix.os  == 'windows-latest' }}
-      with:
-        name: nf-quilt-test-reports-${{ matrix.os }}-${{ matrix.java_version }}
-        path: |
+      - name: Run Gradle Tests
+        run: make test
+        env:
+          LOG4J_DEBUG: true
+
+      - name: Archive production artifacts (Windows only)
+        uses: actions/upload-artifact@v4
+        if: ${{ always() && matrix.os  == 'windows-latest' }}
+        with:
+          name: nf-quilt-test-reports-${{ matrix.os }}-${{ matrix.java_version }}
+          path: |
             D:\a\nf-quilt\nf-quilt\plugins\nf-quilt\build\reports\
-        overwrite: true
-    - name: Archive production artifacts (Linux and MacOS)
-      uses: actions/upload-artifact@v4
-      if: ${{ always() && matrix.os != 'windows-latest' }} 
-      with:
-        name: nf-quilt-test-reports-${{ matrix.os }}-${{ matrix.java_version }}
-        path: |
+          overwrite: true
+      - name: Archive production artifacts (Linux and MacOS)
+        uses: actions/upload-artifact@v4
+        if: ${{ always() && matrix.os != 'windows-latest' }}
+        with:
+          name: nf-quilt-test-reports-${{ matrix.os }}-${{ matrix.java_version }}
+          path: |
             ${{ github.workspace }}/plugins/nf-quilt/build/reports/
-        overwrite: true
-
+          overwrite: true
diff --git a/.gitignore b/.gitignore
@@ -34,3 +34,4 @@ params.yaml
 null
 # quilt+*
 # nextflow
+.aider*
diff --git a/.groovylintrc.json b/.groovylintrc.json
@@ -1,92 +1,92 @@
 {
-    "extends": "recommended",
-    "rules": {
-        "CatchException": {
-            "enabled": false
-        },
-        "CatchThrowable": {
-            "enabled": false
-        },
-        "ClassJavadoc": {
-            "enabled": false
-        },
-        "ClosureAsLastMethodParameter": {
-            "enabled": false
-        },
-        "DuplicateNumberLiteral": {
-            "enabled": false
-        },
-        "DuplicateStringLiteral": {
-            "enabled": false
-        },
-        "FieldTypeRequired": {
-            "enabled": false
-        },
-        "ImplicitClosureParameter": {
-            "enabled": false
-        },
-        "JUnitPublicNonTestMethod": {
-            "enabled": false
-        },
-        "JUnitTestMethodWithoutAssert": {
-            "enabled": false
-        },
-        "JavaIoPackageAccess": {
-            "enabled": false
-        },
-        "JavadocEmptyFirstLine": {
-            "enabled": false
-        },
-        "JavadocEmptyReturnTag": {
-            "enabled": false
-        },
-        "JavadocMissingParamDescription": {
-            "enabled": false
-        },
-        "JavadocMissingThrowsDescription": {
-            "enabled": false
-        },
-        "MethodCount": {
-            "enabled": false
-        },
-        "MethodParameterTypeRequired": {
-            "enabled": false
-        },
-        "MethodSize": {
-            "enabled": false
-        },
-        "NoDef": {
-            "enabled": false
-        },
-        "PrintStackTrace": {
-            "enabled": false
-        },
-        "PropertyName": {
-            "enabled": false
-        },
-        "SpaceAroundMapEntryColon": {
-            "enabled": false
-        },
-        "SpaceAroundOperator": {
-            "enabled": false
-        },
-        "SystemExit": {
-            "enabled": false
-        },
-        "UnnecessaryGetter": {
-            "enabled": false
-        },
-        "UnnecessaryObjectReferences": {
-            "enabled": false
-        },
-        "UnnecessarySetter": {
-            "enabled": false
-        },
-        "VariableName": {
-            "enabled": false
-        },
-        "VariableTypeRequired": {
-            "enabled": false
-        }
+  "extends": "recommended",
+  "rules": {
+    "CatchException": {
+      "enabled": false
+    },
+    "CatchThrowable": {
+      "enabled": false
+    },
+    "ClassJavadoc": {
+      "enabled": false
+    },
+    "ClosureAsLastMethodParameter": {
+      "enabled": false
+    },
+    "DuplicateNumberLiteral": {
+      "enabled": false
+    },
+    "DuplicateStringLiteral": {
+      "enabled": false
+    },
+    "FieldTypeRequired": {
+      "enabled": false
+    },
+    "ImplicitClosureParameter": {
+      "enabled": false
+    },
+    "JUnitPublicNonTestMethod": {
+      "enabled": false
+    },
+    "JUnitTestMethodWithoutAssert": {
+      "enabled": false
+    },
+    "JavaIoPackageAccess": {
+      "enabled": false
+    },
+    "JavadocEmptyFirstLine": {
+      "enabled": false
+    },
+    "JavadocEmptyReturnTag": {
+      "enabled": false
+    },
+    "JavadocMissingParamDescription": {
+      "enabled": false
+    },
+    "JavadocMissingThrowsDescription": {
+      "enabled": false
+    },
+    "MethodCount": {
+      "enabled": false
+    },
+    "MethodParameterTypeRequired": {
+      "enabled": false
+    },
+    "MethodSize": {
+      "enabled": false
+    },
+    "NoDef": {
+      "enabled": false
+    },
+    "PrintStackTrace": {
+      "enabled": false
+    },
+    "PropertyName": {
+      "enabled": false
+    },
+    "SpaceAroundMapEntryColon": {
+      "enabled": false
+    },
+    "SpaceAroundOperator": {
+      "enabled": false
+    },
+    "SystemExit": {
+      "enabled": false
+    },
+    "UnnecessaryGetter": {
+      "enabled": false
+    },
+    "UnnecessaryObjectReferences": {
+      "enabled": false
+    },
+    "UnnecessarySetter": {
+      "enabled": false
+    },
+    "VariableName": {
+      "enabled": false
+    },
+    "VariableTypeRequired": {
+      "enabled": false
     }
-}
+  }
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,4 +1,4 @@
 {
-    "java.compile.nullAnalysis.mode": "disabled",
-    "java.configuration.updateBuildConfiguration": "disabled"
-}
+  "java.compile.nullAnalysis.mode": "disabled",
+  "java.configuration.updateBuildConfiguration": "disabled"
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,7 +17,7 @@
 
 ## [0.8.11] 2024-11-5 UNPUBLISHED
 
-- Catch *all* toJson errors
+- Catch _all_ toJson errors
 
 ## [0.8.10] 2024-11-4 UNPUBLISHED
 
@@ -34,8 +34,8 @@
 
 ## [0.8.7] 2024-10-23 UNPUBLISHED
 
-- Use package cache instead of `params` to find output URIs
-  (in order to support dynamic URIs set by, e.g. `main.nf`)
+- Use package cache instead of `params` to find output URIs (in order to support
+  dynamic URIs set by, e.g. `main.nf`)
 - Allow setting metadata from inside the workflow
 
 ## [0.8.6] 2024-09-11
@@ -59,7 +59,8 @@
 
 ## [0.8.2] 2024-09-07
 
-- Use copyFile rather than writeString for overlay files [requires NextFlow 23 or later]
+- Use copyFile rather than writeString for overlay files [requires NextFlow 23
+  or later]
 - Restore README and quilt_summarize to output
 
 ## [0.8.1] 2024-09-05
@@ -205,7 +206,8 @@ Beta release (not yet on nextflow-io/plugins)
 
 - Use `msg` fragment parameter as commit message when writing packages
 - Removed Benchling support (will add back in a future release)
-- Don't crash when writing to Quilt+ URIs with `&path=` fragments (by ignoring that part)
+- Don't crash when writing to Quilt+ URIs with `&path=` fragments (by ignoring
+  that part)
 
 ## [0.3.5] 2023-04-05
 
@@ -226,5 +228,6 @@ Beta release (not yet on nextflow-io/plugins)
 
 ## [0.3.2] 2023-02-24
 
-- First official release on [nextflow-io/plugins](https://github.com/nextflow-io/plugins/commits/main/plugins.json)
+- First official release on
+  [nextflow-io/plugins](https://github.com/nextflow-io/plugins/commits/main/plugins.json)
 - Read and write from Quilt+ URIs
diff --git a/README-DEV.md b/README-DEV.md
@@ -2,10 +2,14 @@
 
 ## Using Pre-Release Versions
 
-Occasionally we will release beta versions of the plugin that are not yet available in the Nextflow plugin registry. You can help test these versions as follows:
+Occasionally we will release beta versions of the plugin that are not yet
+available in the Nextflow plugin registry. You can help test these versions as
+follows:
 
-- Set the `NXF_PLUGINS_TEST_REPOSITORY` environment variable to the URL of the plugin's metadata file
-- Specify the plugin version in the `plugins` section of your `nextflow.config` file
+- Set the `NXF_PLUGINS_TEST_REPOSITORY` environment variable to the URL of the
+  plugin's metadata file
+- Specify the plugin version in the `plugins` section of your `nextflow.config`
+  file
 
 From the command-line, do, e.g.:
 
@@ -51,7 +55,7 @@ To quickly run `nf-quilt` from this GitHub repository:
 # install and compiles dependencies, then test
 make test-all 
 # create "test/hurdat" package on s3://$WRITE_BUCKET
-make pkg-test WRITE_BUCKET=your-writeablebucket 
+make pkg-test WRITE_BUCKET=your-writeablebucket
 ```
 
 This ensures you have properly installed Nextflow and configured your local
@@ -77,7 +81,7 @@ file (be sure to rename the `outdir` parameter if you use different convention).
 For example:
 
 ```bash
-   ./launch.sh run ./main.nf -profile standard -plugins $(PROJECT) --outdir "quilt+s3://bucket#package=test/hurdat"
+./launch.sh run ./main.nf -profile standard -plugins $(PROJECT) --outdir "quilt+s3://bucket#package=test/hurdat"
 ```
 
 ### Unit Testing
-Original file line number
+Diff line change
@@ Expand Up / @@ -34,3 +34,4 @@ params.yaml @@
     null
     # quilt+*
     # nextflow
+    .aider*