DE-157: Feature - Prepare repo for analytics and new components (#481)

* add env to git ignore

* add es lint and prettier

* combine prettier and eslint

* fix lint errors

* remove uneeded packa attributes

* only lint source

* remove env from eslint

* lint gh action

* lint gh action v2

* rename gh lint action

* update lint action and engines

* update node version

.eslintrc.json

@@ -0,0 +1,40 @@
+{
+    "parser": "@typescript-eslint/parser",
+    "extends": [
+        "plugin:prettier/recommended",
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended",
+        "prettier"
+    ],
+    "overrides": [],
+    "plugins": [
+        "prettier",
+        "@typescript-eslint"
+    ],
+    "parserOptions": {
+        "ecmaVersion": 2020,
+        "sourceType": "module",
+        "ecmaFeatures": {
+            // Allows for the parsing of JSX
+            "jsx": true
+        }
+    },
+    "ignorePatterns": [
+        "node_modules",
+        "coverage",
+        "build",
+        "dist",
+        ".DS_Store",
+        ".env.local",
+        ".env.development.local",
+        ".env.test.local",
+        ".env.production.local",
+        ".vscode/",
+        "package-lock.json",
+        "yarn.lock",
+        "docusaurus.config.js"
+    ],
+    "rules": {
+        "prettier/prettier": "error"
+    }
+}

.github/workflows/lint.yaml

@@ -0,0 +1,23 @@
+name: Lint
+
+on: push
+
+jobs:
+  lint:
+    name: Run linters
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v3
+
+      - name: Set up node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14
+
+      - name: Install dependencies
+        run: yarn --frozen-lockfile
+
+      - name: Run linters
+        run: yarn lint

.gitignore

@@ -13,3 +13,11 @@ i18n/*
 artifacts/
 cache/
 typechain/
+
+.env
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+package-lock.json

package.json

@@ -9,7 +9,8 @@
     "swizzle": "docusaurus swizzle",
     "deploy": "docusaurus deploy",
     "serve": "docusaurus serve",
-    "clear": "docusaurus clear"
+    "clear": "docusaurus clear",
+    "lint": "yarn eslint src"
   },
   "dependencies": {
     "@algolia/autocomplete-preset-algolia": "^1.1.0",
@@ -45,5 +46,25 @@
       "last 1 firefox version",
       "last 1 safari version"
     ]
+  },
+  "devDependencies": {
+    "@docusaurus/module-type-aliases": "^2.1.0",
+    "@tsconfig/docusaurus": "^1.0.6",
+    "@typescript-eslint/eslint-plugin": "^5.41.0",
+    "@typescript-eslint/parser": "^5.41.0",
+    "eslint": "^8.26.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-config-standard-with-typescript": "^23.0.0",
+    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-n": "^15.0.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "eslint-plugin-promise": "^6.0.0",
+    "prettier": "2.7.1",
+    "typescript": "^4.8.4"
+  },
+  "engines": {
+    "npm": "please-use-yarn",
+    "node": "14",
+    "yarn": ">=1.22"
   }
 }

src/pages/index.js → src/pages/index.tsx

@@ -1,7 +1,6 @@
 import React from 'react'
 import Layout from '@theme/Layout'
 import Link from '@docusaurus/Link'
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext'
 
 import './styles.module.css'
 import styled from '@emotion/styled'

src/theme/NavbarItem.js → src/theme/NavbarItem.tsx

@@ -5,8 +5,8 @@ import { useLocation } from '@docusaurus/router'
 export default function NavbarItem(props) {
   const { pathname } = useLocation()
 
-  let versionDoc = pathname.split('/')
-  let activeNav = null
+  const versionDoc = pathname.split('/')
+  let activeNav: null | string = null
 
   if (versionDoc[2] === 'V2' || versionDoc[2] === '2.0.0') {
     activeNav = 'V2'

tsconfig.json

@@ -0,0 +1,6 @@
+{
+    "extends": "@tsconfig/docusaurus/tsconfig.json",
+    "compilerOptions": {
+        "baseUrl": "."
+    }
+}