style: satisfy the new lint workflows

Renames LICENSE.md to LICENSE.txt so copyrights-action has a punch
line to look for, adds SPDX headers to the rest, bumps the outdated
actions and quiets shellcheck in clean.yml for actionlint, gives
CHANGELOG.md a title and descriptive link texts to README.md for
markdownlint-cli2, renames j2eoVesion and teaches typos about the
inex abbreviation, normalizes YAML for yamllint, and rewords the bare
TODO comments that pdd rejects as untracked puzzles.

Author: yegor256

.github/typos.toml

@@ -1,7 +1,5 @@
 # SPDX-FileCopyrightText: Copyright (c) 2022 Polystat
 # SPDX-License-Identifier: MIT
 
-[files]
-extend-exclude = [
-
-]
+[default.extend-words]
+inex = "inex"

.github/workflows/ci.yml

@@ -1,13 +1,17 @@
+# SPDX-FileCopyrightText: Copyright (c) 2022 Polystat
+# SPDX-License-Identifier: MIT
 # This file was automatically generated by sbt-github-actions using the
 # githubWorkflowGenerate task. You should add and commit this file to
 # your git repository. It goes without saying that you shouldn't edit
 # this file by hand! Instead, if you wish to make changes, you should
 # change your sbt build configuration to revise the workflow description
 # to meet your needs, then regenerate this file.
+# yamllint disable rule:line-length
+---
 
 name: ci
 
-on:
+'on':
   pull_request:
     branches: ['**']
   push:
@@ -27,19 +31,19 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout current branch (full)
-        uses: actions/checkout@v2
+        uses: actions/checkout@v7
         with:
           fetch-depth: 0
 
       - name: Setup Java (temurin@11)
         if: matrix.java == 'temurin@11'
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v5
         with:
           distribution: temurin
           java-version: 11
 
       - name: Cache sbt
-        uses: actions/cache@v2
+        uses: actions/cache@v6
         with:
           path: |
             ~/.sbt
@@ -60,7 +64,7 @@ jobs:
         run: tar cf targets.tar target project/target
 
       - name: Upload target directories
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v7
         with:
           name: target-${{ matrix.os }}-${{ matrix.scala }}-${{ matrix.java }}
           path: targets.tar
@@ -75,17 +79,17 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout current branch (fast)
-        uses: actions/checkout@v2
+        uses: actions/checkout@v7
 
       - name: Setup Java (temurin@11)
         if: matrix.java == 'temurin@11'
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v5
         with:
           distribution: temurin
           java-version: 11
 
       - name: Cache sbt
-        uses: actions/cache@v2
+        uses: actions/cache@v6
         with:
           path: |
             ~/.sbt

.github/workflows/clean.yml

@@ -1,13 +1,17 @@
+# SPDX-FileCopyrightText: Copyright (c) 2022 Polystat
+# SPDX-License-Identifier: MIT
 # This file was automatically generated by sbt-github-actions using the
 # githubWorkflowGenerate task. You should add and commit this file to
 # your git repository. It goes without saying that you shouldn't edit
 # this file by hand! Instead, if you wish to make changes, you should
 # change your sbt build configuration to revise the workflow description
 # to meet your needs, then regenerate this file.
+# yamllint disable rule:line-length
+---
 
 name: clean
 
-on: push
+'on': push
 
 jobs:
   delete-artifacts:
@@ -22,7 +26,7 @@ jobs:
           REPO=${GITHUB_API_URL}/repos/${{ github.repository }}
 
           # A shortcut to call GitHub API.
-          ghapi() { curl --silent --location --user _:$GITHUB_TOKEN "$@"; }
+          ghapi() { curl --silent --location --user "_:$GITHUB_TOKEN" "$@"; }
 
           # A temporary file which receives HTTP response headers.
           TMPFILE=/tmp/tmp.$$
@@ -42,18 +46,18 @@ jobs:
             rm -f $TMPFILE
 
             # Number of artifacts on this page:
-            COUNT=$(( $(jq <<<$JSON -r '.artifacts | length') ))
+            COUNT=$(( $(jq <<<"$JSON" -r '.artifacts | length') ))
 
             # Loop on all artifacts on this page.
-            for ((i=0; $i < $COUNT; i++)); do
+            for ((i=0; i < COUNT; i++)); do
 
               # Get name of artifact and count instances of this name.
-              name=$(jq <<<$JSON -r ".artifacts[$i].name?")
+              name=$(jq <<<"$JSON" -r ".artifacts[$i].name?")
               ARTCOUNT[$name]=$(( $(( ${ARTCOUNT[$name]} )) + 1))
 
-              id=$(jq <<<$JSON -r ".artifacts[$i].id?")
-              size=$(( $(jq <<<$JSON -r ".artifacts[$i].size_in_bytes?") ))
-              printf "Deleting '%s' #%d, %'d bytes\n" $name ${ARTCOUNT[$name]} $size
-              ghapi -X DELETE $REPO/actions/artifacts/$id
+              id=$(jq <<<"$JSON" -r ".artifacts[$i].id?")
+              size=$(( $(jq <<<"$JSON" -r ".artifacts[$i].size_in_bytes?") ))
+              printf "Deleting '%s' #%d, %'d bytes\n" "$name" "${ARTCOUNT[$name]}" "$size"
+              ghapi -X DELETE "$REPO/actions/artifacts/$id"
             done
           done

.github/workflows/copyrights.yml

@@ -18,6 +18,11 @@ jobs:
       - uses: actions/checkout@v7
       - uses: yegor256/copyrights-action@0.0.12
         with:
+          ignore: >-
+            target/**
+            node_modules/**
+            .git/**
+            **/src/test/resources/**
           globs: >-
             **/LICENSE.txt
             **/*.sh

.github/workflows/release.yml

@@ -1,6 +1,10 @@
+# SPDX-FileCopyrightText: Copyright (c) 2022 Polystat
+# SPDX-License-Identifier: MIT
+# yamllint disable rule:line-length
+---
 name: release
 
-on:
+'on':
   workflow_dispatch:
     inputs:
       release_version:
@@ -15,11 +19,11 @@ jobs:
       release-tag: ${{ steps.latest-tag.outputs.tag }}
     steps:
       - name: Check out repository code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v7
         with:
           token: ${{ secrets.GIT_TOKEN }}
       - name: Setup JDK
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v5
         with:
           distribution: 'temurin'
           java-version: '11'
@@ -48,7 +52,7 @@ jobs:
         id: latest-tag
       - name: Github Release
         id: gh_release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         with:
           tag_name: ${{ steps.latest-tag.outputs.tag }}
           body_path: CHANGELOG.md
@@ -70,7 +74,7 @@ jobs:
   #           local_path: polystat.exe
   #   steps:
   #     - name: Check out repository code
-  #       uses: actions/checkout@v2
+  #       uses: actions/checkout@v7
   #       with:
   #         token: ${{ secrets.GIT_TOKEN }}
   #     - name: Configure local git
@@ -97,7 +101,7 @@ jobs:
   #         echo $PATH
   #         sbt "nativeImageCopy ${{ matrix.uploaded_filename }}" nativeImageRun
   #     - name: Upload release
-  #       uses: softprops/action-gh-release@v1
+  #       uses: softprops/action-gh-release@v2
   #       with:
   #         tag_name: ${{ needs.pre-release.outputs.release-tag }}
   #         files: ${{ matrix.uploaded_filename }}
@@ -106,15 +110,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out repository code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v7
         with:
           token: ${{ secrets.GIT_TOKEN }}
       - name: Configure local git
         run: |
           git config user.name "${{ secrets.GIT_USERNAME }}"
           git config user.email "${{ secrets.GIT_USER_EMAIL }}"
       - name: setup JDK
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v5
         with:
           distribution: 'temurin'
           java-version: '11'

.gitignore

@@ -16,4 +16,4 @@ out/
 hadoop_tmp
 **.jar
 !native-image-configs/*.json
-**.sarif
+**.sarif

CHANGELOG.md

@@ -1,8 +1,10 @@
-## Polystat v0.2.0
+# Polystat v0.2.0
 
 This release introduced the following changes:
 
-* The `--to console` cli argument was removed. Instead, the results of the analysis are printed to console by default. To disable printing the results to console, use the new `--quiet` flag (`-q` for short).
+* The `--to console` cli argument was removed. Instead, the results of the
+  analysis are printed to console by default. To disable printing the results to
+  console, use the new `--quiet` flag (`-q` for short).
 * Added a decent-looking pretty-printer of the analysis results to console.
 * `j2eo` was updated to 0.6.0
 * `py2eo` was updated to 0.23.0

LICENSE.md LICENSE.txtLICENSE.md renamed to LICENSE.txt

@@ -360,8 +360,9 @@ And then simply run it like:
 polystat <args>
 ```
 
-More about the arguments you can pass can be found [here](#basic-usage) and
-[here](#full-usage-specification).
+More about the arguments you can pass is written in
+[basic usage](#basic-usage) and
+[full usage specification](#full-usage-specification).
 
 ## Basic usage
 
@@ -566,7 +567,7 @@ polystat list [--config | -c]
   be found via `polystat list` command.
 - `--j2eo` (available only when running `polystat java`) option allows users to
   specify the path to the j2eo executable jar. If it's not specified, it looks
-  for one in the current working diretory. If it's not present in the current
+  for one in the current working directory. If it's not present in the current
   working directory, download one from Maven Central (for now, the version is
   hardcoded to be 0.4.0).
 - `--j2eo-version` (available only when running `polystat java`) option allows
@@ -637,7 +638,7 @@ can be printed to console by running:
 polystat list --config
 ```
 
-The example of the working config file can be found [here](.polystat.conf).
+See an example of the working [config file](.polystat.conf).
 
 - `polystat.lang` - the type of input files which will be analyzed. This key
   must be present. Possible values:

README.md

@@ -1,11 +1,11 @@
 {
-    "polystat": {
-        "repositories": [
-            "ivy2Local",
-            "central"
-        ],
-        "dependencies": [
-            "org.polystat:polystat-cli_3:0.2.0"
-        ]
-    }
+  "polystat": {
+    "dependencies": [
+      "org.polystat:polystat-cli_3:0.2.0"
+    ],
+    "repositories": [
+      "ivy2Local",
+      "central"
+    ]
+  }
 }