[PTP-939] chore: add linting policy (#359)

* chore: add linting policy

* fix: ci

* fix: no unused vars rule

* fix: eslint errors

Author: cdias900

.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.eslintrc

@@ -7,14 +7,12 @@
     "no-wildcard-postmessage",
     "react"
   ],
-  "parser": "babel-eslint",
+  "parser": "@typescript-eslint/parser",
   "extends": [
-    "standard",
-    "standard-react",
     "plugin:prettier/recommended",
-    "prettier/standard",
-    "prettier/react",
-    "plugin:security/recommended"
+    "plugin:security/recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:import/typescript"
   ],
   "env" : {
     "browser" : true,
@@ -36,7 +34,16 @@
     "space-before-function-paren": 0,
 
     "import/export": 0,
-    "indent": ["error", 4, { "ignoredNodes": ["ConditionalExpression"] }],
+    "@typescript-eslint/no-var-requires": "off",
+    "@typescript-eslint/ban-ts-comment": "off",
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        "argsIgnorePattern": "^_",
+        "varsIgnorePattern": "^_"
+      }
+    ],
+    "@typescript-eslint/no-explicit-any": "warn",
     /** ScanJS rules **/
     "scanjs-rules/accidental_assignment": 1,
     "scanjs-rules/assign_to_hostname" : 1,

.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+on:
+  push:
+  pull_request:
+jobs:
+  ci:
+    if: ${{ contains(github.event.head_commit.message, '[run ci]') || github.event_name == 'pull_request' }}
+    runs-on: ubuntu-latest
+
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Saving cache
+        uses: actions/cache@v2
+        with:
+          path: '**/node_modules'
+          key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}
+
+      - name: Set up Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: 18
+          registry-url: 'https://npm.pkg.github.com'
+
+      - name: Install dependencies
+        run: |
+          npm install
+
+      - name: Check linting
+        run: npm run lint:eslint
+
+      - name: Check TS
+        run: npm run check-ts
+
+      # - name: Check tests
+      #   run: |
+      #     npm run test

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged && npm run check-ts

.prettierrc

@@ -0,0 +1,9 @@
+{
+  "bracketSameLine": true,
+  "bracketSpacing": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "arrowParens": "avoid",
+  "semi": true,
+  "printWidth": 100
+}

karma-variables.js

@@ -1,9 +1,10 @@
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 const process = {
-    env: {
-        APP_ID: 'IDmESP4jtv5BH15NTPdz8SGk',
-        BUILD_ENV: 'dev',
-        ENV: "partner",
-        STAGE: "stage",
-        TARGET_MODE: "targetMode",
-    }
+  env: {
+    APP_ID: 'IDmESP4jtv5BH15NTPdz8SGk',
+    BUILD_ENV: 'dev',
+    ENV: 'partner',
+    STAGE: 'stage',
+    TARGET_MODE: 'targetMode',
+  },
 };

karma.conf.js

@@ -1,4 +1,3 @@
-/* eslint-disable import/no-extraneous-dependencies */
 const { createDefaultConfig } = require('@open-wc/testing-karma');
 const merge = require('deepmerge');
 
@@ -16,8 +15,8 @@ module.exports = config => {
         reporters: [
           { type: 'html', subdir: 'report-html' },
           { type: 'text', subdir: '.' },
-          { type: 'lcov', subdir: '.' }
-        ]
+          { type: 'lcov', subdir: '.' },
+        ],
       },
       plugins: [
         // load plugin
@@ -41,9 +40,8 @@ module.exports = config => {
         statements: 50,
         branches: 30,
         functions: 50,
-        lines: 50
-      }
-
+        lines: 50,
+      },
     }),
   );
   return config;