Add type checking, eslint, and prettier to npm test. (#358)

* Add tsc to npm test

* Enable eslint with TypeScript support

* Enable and run prettier

* Bun test -> bun run test

Signed-off-by: Gavin John <[email protected]>

* Fix rate limit type error

Signed-off-by: Gavin John <[email protected]>

* Missed one!

Signed-off-by: Gavin John <[email protected]>

* Don't use any; reformat

* Bump throttling plugin for better types

* Update lockfile

---------

Signed-off-by: Gavin John <[email protected]>
Co-authored-by: Gavin John <[email protected]>
Co-authored-by: Gavin John <>

Author: SamWilsn

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*.{js,mjs,cjs,ts,json,html,yaml,yml}]
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+charset = utf-8
+trim_trailing_whitespace = true
+
+[*.{yaml,yml}]
+indent_size = 2

.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+/dist

.eslintrc.cjs

@@ -0,0 +1,32 @@
+module.exports = {
+    extends: [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:@typescript-eslint/recommended-requiring-type-checking",
+        "plugin:@typescript-eslint/strict",
+        "prettier",
+    ],
+    rules: {
+        "@typescript-eslint/no-unused-vars": [
+            "warn",
+            { argsIgnorePattern: "^_" },
+        ],
+    },
+    parser: "@typescript-eslint/parser",
+    plugins: ["@typescript-eslint"],
+    root: true,
+    parserOptions: {
+        project: true,
+    },
+
+    overrides: [
+        {
+            files: ["src/__tests__/**", "src/rules/__tests__/**"],
+            rules: {
+                "@typescript-eslint/no-unsafe-assignment": ["off"],
+                "@typescript-eslint/no-unsafe-call": ["off"],
+                "@typescript-eslint/no-unsafe-member-access": ["off"],
+            },
+        },
+    ],
+};

.github/workflows/build.yml

@@ -9,7 +9,7 @@ jobs:
   deploy:
     name: Build and Deploy
     runs-on: ubuntu-latest
-    
+
     steps:
       - name: Checkout
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

.github/workflows/ci.yml

@@ -33,6 +33,6 @@ jobs:
 
       - name: Build
         run: bun run build
-        
+
       - name: Test
-        run: bun test
+        run: bun run test

.github/workflows/codeql-analysis.yml

@@ -20,7 +20,7 @@ on:
     branches:
       - main
   schedule:
-    - cron: '0 0 * * 1'
+    - cron: "0 0 * * 1"
 
 jobs:
   analyze:
@@ -34,41 +34,40 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript' ]
+        language: ["javascript"]
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
         # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      - name: Checkout repository
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@e5f05b81d5b6ff8cfa111c80c22c5fd02a384118 # v3.23.0
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        
-        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-        # queries: security-extended,security-and-quality
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@407ffafae6a767df3e0230c3df91b6443ae8df75 # v2.22.8
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
 
-        
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@e5f05b81d5b6ff8cfa111c80c22c5fd02a384118 # v3.23.0
+          # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+          # queries: security-extended,security-and-quality
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@407ffafae6a767df3e0230c3df91b6443ae8df75 # v2.22.8
 
-    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
-    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 
-    # - run: |
-    #   echo "Run, Build Application using script"
-    #   ./location_of_script_within_repo/buildscript.sh
+      #   If the Autobuild fails above, remove it and uncomment the following three lines.
+      #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@e5f05b81d5b6ff8cfa111c80c22c5fd02a384118 # v3.23.0
+      # - run: |
+      #   echo "Run, Build Application using script"
+      #   ./location_of_script_within_repo/buildscript.sh
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@407ffafae6a767df3e0230c3df91b6443ae8df75 # v2.22.8

.prettierignore

@@ -0,0 +1,2 @@
+/dist
+node_modules

.prettierrc.cjs

@@ -0,0 +1,5 @@
+module.exports = {
+    plugins: ["@trivago/prettier-plugin-sort-imports"],
+    importOrderSeparation: true,
+    importOrderSortSpecifiers: true,
+};

action.yml

@@ -9,11 +9,11 @@ inputs:
   config:
     description: Config file location
     required: false
-    default: ''
+    default: ""
   pr_number:
     description: The PR Number
     required: false
-    default: ''
+    default: ""
 
 runs:
   using: node16