ci(super-linter): switch to super-linter

Author: thomasleplus

.github/workflows/super-linter.yml

@@ -0,0 +1,69 @@
+---
+#################################
+#################################
+## Super Linter GitHub Actions ##
+#################################
+#################################
+name: Lint Code Base
+
+#
+# Documentation:
+# https://help.github.com/en/articles/workflow-syntax-for-github-actions
+#
+
+#############################
+# Start the job on all push #
+#############################
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: "0 0 * * 0"
+  workflow_dispatch:
+
+permissions: {}
+
+###############
+# Set the Job #
+###############
+jobs:
+  lint:
+    # Name the Job
+    name: Lint Code Base
+    # Set the agent to run on
+    runs-on: ubuntu-latest
+
+    ############################################
+    # Grant status permission for MULTI_STATUS #
+    ############################################
+    permissions:
+      contents: read
+      packages: read
+      statuses: write
+
+    ##################
+    # Load all steps #
+    ##################
+    steps:
+      ##########################
+      # Checkout the code base #
+      ##########################
+      - name: Checkout Code
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          # Full git history is needed to get a proper list of changed
+          # files within `super-linter`
+          fetch-depth: 0
+          persist-credentials: false
+
+      ################################
+      # Run Linter against code base #
+      ################################
+      - name: Lint Code Base
+        uses: super-linter/super-linter@ffde3b2b33b745cb612d787f669ef9442b1339a6 # v8.1.0
+        env:
+          VALIDATE_ALL_CODEBASE: true
+          LINTER_RULES_PATH: .
+          DEFAULT_BRANCH: main
+          ENFORCE_COMMITLINT_CONFIGURATION_CHECK: true
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/yamllint.yml

@@ -0,0 +1,3 @@
+{
+  "ignore": ["*.py"]
+}

.jscpd.json

@@ -6,4 +6,5 @@ A place to stash my quantum computing experiments
 
 This is the simplest quantum circuit: a single input quibit goes through an Hadamard gate. The output is a qubit which if measured has a 50/50 chance to be a 0 or 1.
 
-https://en.wikipedia.org/wiki/Hadamard_transform#Quantum_computing_applications
+See [https://en.wikipedia.org/wiki/Hadamard_transform#Quantum_computing_applications](https://en.wikipedia.org/wiki/Hadamard_transform#Quantum_computing_applications)
+for more details.

README.md

@@ -0,0 +1,19 @@
+const Configuration = {
+  /*
+   * Inherit rules from conventional commits.
+   */
+  extends: ["@commitlint/config-conventional"],
+
+  /*
+   * Any rules defined here will override rules from parent.
+   */
+  rules: {
+    "body-leading-blank": [2, "always"], // warning -> error
+    "body-max-line-length": [1, "always", 100], // error -> warning
+    "footer-leading-blank": [2, "always"], // warning -> error
+    "footer-max-length": [1, "always", 100], // error -> warning
+    "header-max-length": [1, "always", 100], // error -> warning
+  },
+};
+
+export default Configuration;

commitlint.config.js

@@ -27,9 +27,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "# pylint: disable=missing-module-docstring\n",
     "# begin with importing essential libraries for IBM Q\n",
-    "from qiskit import IBMQ, BasicAer\n",
-    "from qiskit import ClassicalRegister, QuantumRegister, QuantumCircuit"
+    "from qiskit import IBMQ, BasicAer, ClassicalRegister, QuantumCircuit, QuantumRegister"
    ]
   },
   {
@@ -122,26 +122,27 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "# pylint: disable=missing-function-docstring,redefined-outer-name\n",
     "def answer(result):\n",
     "    for key in result.keys():\n",
     "        state = key\n",
-    "    print('The Quantum 8-ball says:')\n",
-    "    if state == '000':\n",
-    "        print('It is certain.')\n",
-    "    elif state == '001':\n",
-    "        print('Without a doubt.')\n",
-    "    elif state == '010':\n",
-    "        print('Yes - definitely.')\n",
-    "    elif state == '011':\n",
-    "        print('Most likely.')\n",
-    "    elif state == '100':\n",
+    "    print(\"The Quantum 8-ball says:\")\n",
+    "    if state == \"000\":\n",
+    "        print(\"It is certain.\")\n",
+    "    elif state == \"001\":\n",
+    "        print(\"Without a doubt.\")\n",
+    "    elif state == \"010\":\n",
+    "        print(\"Yes - definitely.\")\n",
+    "    elif state == \"011\":\n",
+    "        print(\"Most likely.\")\n",
+    "    elif state == \"100\":\n",
     "        print(\"Don't count on it.\")\n",
-    "    elif state == '101':\n",
-    "        print('My reply is no.')\n",
-    "    elif state == '110':\n",
-    "        print('Very doubtful.')\n",
+    "    elif state == \"101\":\n",
+    "        print(\"My reply is no.\")\n",
+    "    elif state == \"110\":\n",
+    "        print(\"Very doubtful.\")\n",
     "    else:\n",
-    "        print('Concentrate and ask again.')"
+    "        print(\"Concentrate and ask again.\")"
    ]
   },
   {
@@ -175,8 +176,10 @@
     }
    ],
    "source": [
-    "from qiskit import execute\n",
-    "job = execute(qc, backend=BasicAer.get_backend('qasm_simulator'), shots=1)\n",
+    "# pylint: disable=wrong-import-position\n",
+    "from qiskit import execute  # noqa: E402\n",
+    "\n",
+    "job = execute(qc, backend=BasicAer.get_backend(\"qasm_simulator\"), shots=1)\n",
     "result = job.result().get_counts(qc)\n",
     "answer(result)"
    ]
@@ -226,10 +229,12 @@
     }
    ],
    "source": [
+    "# pylint: disable=wrong-import-position\n",
     "# define the least busy device\n",
-    "from qiskit.providers.ibmq import least_busy\n",
+    "from qiskit.providers.ibmq import least_busy  # noqa: E402\n",
+    "\n",
     "backend = least_busy(IBMQ.backends(simulator=False))\n",
-    "print(\"The least busy device:\",backend.name())"
+    "print(\"The least busy device:\", backend.name())"
    ]
   },
   {