feat: add code lint “shellcheck” to github actions and configured cod…

…acy (#9)

Create a complete workflow for the repository:

1. Automation A+B test.
2. `shellcheck` test.
3. Codacy code lint.

.codacy.yml

@@ -0,0 +1,4 @@
+---
+engines:
+  shellcheck:
+    enabled: true

.codacyignore

@@ -0,0 +1,4 @@
+demo/**
+.github/**
+README.md
+README_zh-CN.md

.github/workflows/greetings.yml

@@ -1,4 +1,4 @@
-name: Greetings
+name: Greet new contributors
 
 on: [pull_request_target, issues]
 

.github/workflows/run_demo.yml

@@ -0,0 +1,52 @@
+name: Check A+B Result
+
+on:
+  push:
+    branches:
+      - '*'
+
+jobs:
+  A_plus_B:
+    runs-on:
+      ubuntu-latest
+
+    steps:
+      - name:
+          Checkout code
+        uses:
+          actions/checkout@v3
+
+      - name:
+          try calculate A+B
+        run: |
+          echo "Beep boop! Let's try A plus B!"
+
+          echo "All '*.cpp' files:"
+          find . -name "*.cpp"
+          chmod +x ./make.sh
+
+          (echo "Y"; echo "Y") | ./make.sh ./demo/A_Plus_B.cpp
+        shell: bash
+
+      - name:
+          Check A+B result
+        id:
+          check_result
+        run: |
+          if [[ $(cat ./demo/A_Plus_B.ans) != "2034324" ]]; then
+            echo "Beep boop! We were tricked by CCF!"
+            cat ./demo/A_Plus_B.log
+            exit 1
+          else
+            echo "Beep boop! A+B result is correct!"
+          fi
+        shell: bash
+
+      - name:
+          Collect results
+        if:
+          steps.check_result.outcome == 'success'
+        run:
+          echo "Beep boop! The check passed successfully!"
+          echo "Beep boop! We successfully fk-ed CCF!"
+        shell: bash

.github/workflows/shellcheck.yml

@@ -0,0 +1,31 @@
+name: Shell check
+
+on:
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  shellcheck:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: FKCCF everyday
+        run: |
+          echo "Beep boop! shellcheck was triggered..."
+          echo "I would say, FKCCF!"
+
+      - name: Clone repo
+        uses: actions/checkout@v3
+
+      - name: Show status
+        run: |
+          echo "repo was cloned successfully!"
+
+      - name: shellcheck
+        uses: ludeeus/action-shellcheck@00b27aa7cb85167568cb48a3838b75f4265f2bca
+
+      - name: Finish
+        run: |
+          echo "Beep boop! shellcheck finished!"
+          echo "Beep boop! You are able to request a review now."

make.sh

@@ -35,7 +35,7 @@ tryUsingDefaultTestcase() {
         if [[ "$operation" != [Nn]* ]]; then # Proceed if the user input is not "N" or "n".
             blueOutput "[Info]:${RESET} Using ${filename}.in as the test case."
 
-            ./${filename}.out < "${filename}.in" > "${filename}.ans" # Executes the program with input redirection.
+            "./${filename}.out" < "${filename}.in" > "${filename}.ans" # Executes the program with input redirection.
 
             blueOutput "[Info]:${RESET} Output is shown below and saved as ${filename}.ans.\n"
 
@@ -83,6 +83,16 @@ cleanupEmptyFiles() {
 
 initCleanup
 
+# @brief: New a pipe named fake_tty
+# `/dev/tty` is OK for most of the users. However, GitHub Actions doesn't have it.
+# It will raise an error: `tee: /dev/tty: No such device or address`
+# Given that, we should `tee` outputs to fake_tty, and `cat fake_tty` after
+# compilation. 
+# Don't forget to `rm fake_tty` at last.
+if [[ -e fake_tty ]]; then rm fake_tty; fi
+mkfifo fake_tty
+chmod +x fake_tty
+
 # @brief: Compiles `${filename}.cpp` using `g++` with detailed warnings and debugging flags.
 # --std=c++14 is the require of CCF - China Cheating-money Foundation
 # c++14 for CSP-J/S, NOIp and NOI, etc.
@@ -95,8 +105,20 @@ g++ -g -Wall -Wextra -pedantic --std=c++14 -Og \
     -D_GLIBCXX_DEBUG -D_GLIBCXX_DEBUG_PEDANTIC \
     -fdiagnostics-color=always \
     "$1" -o "${filename}.out" 2>&1 \
-    | tee /dev/tty \
-    | sed "s/\x1B\[[0-9;]*[a-zA-Z]//g" > "${filename}.log"
+    | tee fake_tty &
+
+# @brief: Output `fake_tty` after compilation.
+# The origin compile command was `tee /dev/tty` directly, it didn't work on
+# GitHub Actions.
+# We introduced `fake_tty` to resolve it.
+# `wait` is because `tee fake_tty &` is asynchronous.
+# Now it's time to output and clean it up.
+#
+# By the way, I hate the computer of GitHub Actions. It doesn't have `/dev/tty`.
+./fake_tty >(sed "s/\x1B\[[0-9;]*[a-zA-Z]//g" > "${filename}.log")
+
+wait
+rm fake_tty
 
 # Check if the output file was successfully created and is executable.
 if [[ -x "${filename}.out" ]]; then 
@@ -105,9 +127,9 @@ if [[ -x "${filename}.out" ]]; then
     tryUsingDefaultTestcase
 else
     redOutput "[Error]: Compilation failed.\a"
-    blueOutput "[Info]:${RESET} Check "${filename}.log" for details."
+    blueOutput "[Info]:${RESET} Check '${filename}.log' for details."
 fi
 
 cleanupEmptyFiles
 
-exit
+exit