feat: add eslint, document it, add it to ci

.eslintrc

@@ -0,0 +1,29 @@
+{
+    // From: https://github.com/airbnb/javascript/issues/451 - we want airbnb, but not it's react rules (because we don't use react)
+    "extends": "airbnb-base",
+    "overrides": [
+        {
+            "files": [
+                "./**/*.ts"
+            ],
+            "rules": {
+                "no-console": [
+                    "error",
+                    {
+                        "allow": [
+                            "info",
+                            "warn",
+                            "trace",
+                            "error"
+                        ]
+                    }
+                ]
+            }
+        }
+    ],
+    "rules": {
+        "no-return-await": [
+            "error"
+        ]
+    }
+}

.github/workflows/ci.yaml

@@ -22,3 +22,5 @@ jobs:
       - run: npm install
 
       - run: npm run typecheck
+
+      - run: npm run lint

README.md

@@ -17,13 +17,11 @@ npm i
 # Run application in development mode
 npm run dev
 
-# Typechecking
+# Typechecking (via TypeScript / tsc)
 npm run typecheck
-```
-
-
-
 
+# Linting (via eslint)
+```
 
 ### Coding Setup
 

index.ts

@@ -1,14 +1,14 @@
 const main = async () => {
- console.log('GM MakerDao')
-}
+  console.info('GM MakerDao');
+};
 
 main().catch((err) => {
-  console.error("Shutting down...")
+  console.error('Shutting down...');
   if (err instanceof Error) {
-    console.error(err)
+    console.error(err);
   } else {
-    console.error("An unknown error has occurred. Please open an issue on github with the below:")
-    console.log(err)
+    console.error('An unknown error has occurred. Please open an issue on github (https://github.com/makerdao-ses/switchboard-boilerplate/issues/new) with the below context:');
+    console.info(err);
   }
-  process.exit(1)
-})
+  process.exit(1);
+});