feat: initial version of keyphrase-checker action (#1)

* feat: initial version of keyphrase-checker action

* chore: update CI and linter workflows for improved consistency

Author: FidelusAleksander

.env.example

@@ -3,13 +3,26 @@
 # Do not commit your actual .env file to Git! This may contain secrets or other
 # private information.
 
+
+# ACTION INPUTS
+
+# Provide text or text file
+# INPUT_TEXT-FILE="README.txt"
+INPUT_TEXT="Hello @ProfessortoCat, how is life at GitHub?"
+
+# Keyphrase to search for in text or file
+INPUT_KEYPHRASE="@professortocat"
+
+# Should the search be case-sensitive?
+INPUT_CASE-SENSITIVE=false
+
+# Minimum number of occurrences for the action to be successful
+INPUT_MINIMUM-OCCURRENCES=1
+
 # Enable/disable step debug logging (default: `false`). For local debugging, it
 # may be useful to set it to `true`.
 ACTIONS_STEP_DEBUG=true
 
-# GitHub Actions inputs should follow `INPUT_<name>` format (case-sensitive).
-# Hyphens should not be converted to underscores!
-INPUT_MILLISECONDS=2400
 
 # GitHub Actions default environment variables. These are set for every run of a
 # workflow and can be used in your actions. Setting the value here will override

.github/workflows/ci.yml

@@ -44,21 +44,70 @@ jobs:
         id: npm-ci-test
         run: npm run ci-test
 
-  test-action:
-    name: GitHub Actions Test
+  positive-tests:
+    name: Positive Action Tests
     runs-on: ubuntu-latest
-
     steps:
       - name: Checkout
-        id: checkout
         uses: actions/checkout@v4
 
-      - name: Test Local Action
-        id: test-action
+      - name: Test direct text (not case-sensitive)
+        id: test-direct-text
+        uses: ./
+        with:
+          text: "Hey @PrOfEssortocat, I'm finished with my task"
+          keyphrase: '@professortocat'
+
+      - name: Test text file (not case-sensitive)
+        id: test-text-file
+        uses: ./
+        with:
+          text-file: ./__tests__/test-mixed-case.md
+          keyphrase: 'github'
+          minimum-occurrences: '3'
+
+  negative-tests:
+    name: Negative Action Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Test direct text (case-sensitive)
+        id: test-direct-text
+        continue-on-error: true
+        uses: ./
+        with:
+          text: "Hey @PrOfEssortocat, I'm finished with my task"
+          keyphrase: '@professortocat'
+          case-sensitive: true
+
+      - name: Check output for direct text test
+        run: |
+          if [[ "${{ steps.test-direct-text.outcome }}" != "failure" ]]; then
+            echo "Expected the test to fail but it passed"
+            exit 1
+          fi
+          if [[ "${{ steps.test-direct-text.outputs.occurrences }}" != "0" ]]; then
+            echo "Expected 0 occurrences but found ${{ steps.test-direct-text.outputs.occurrences }}"
+            exit 1
+          fi
+
+      - name: Test text file (case-sensitive)
+        id: test-text-file
+        continue-on-error: true
         uses: ./
         with:
-          milliseconds: 2000
+          text-file: ./__tests__/test-mixed-case.md
+          keyphrase: 'github'
+          minimum-occurrences: 3
+          case-sensitive: true
 
-      - name: Print Output
-        id: output
-        run: echo "${{ steps.test-action.outputs.time }}"
+      - name: Check output for text file test
+        run: |
+          if [[ "${{ steps.test-text-file.outcome }}" != "failure" ]]; then
+            echo "Expected the test to fail but it passed"
+            exit 1
+          fi
+          if [[ "${{ steps.test-text-file.outputs.occurrences }}" != "1" ]]; then
+            echo "Expected 1 occurrences but found ${{ steps.test-text-file.outputs.occurrences }}"
+            exit 1
+          fi

.github/workflows/linter.yml

@@ -51,3 +51,5 @@ jobs:
           VALIDATE_TYPESCRIPT_ES: false
           VALIDATE_JSON: false
           VALIDATE_TYPESCRIPT_STANDARD: false
+          VALIDATE_NATURAL_LANGUAGE: false
+          VALIDATE_ENV: false