chore(eslint): configure ESLint

Author: Mike Nikles

.eslintrc.js

@@ -0,0 +1,21 @@
+module.exports = {
+  env: {
+    node: true,
+  },
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+  ],
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  root: true,
+  rules: {
+    "@typescript-eslint/ban-ts-comment": [
+      "error",
+      {
+        "ts-ignore": "allow-with-description",
+      },
+    ],
+  },
+};

.gitpod.yml

@@ -1,3 +1,4 @@
+---
 # Learn more about this file at https://www.gitpod.io/docs/references/gitpod-yml
 image:
   file: .gitpod/Dockerfile
@@ -37,7 +38,7 @@ tasks:
       cd webstone
       gp await-port 3000
       pnpm test:e2e
-      
+
 ports:
   - port: 3000
     visibility: public
@@ -49,4 +50,5 @@ ports:
 vscode:
   extensions:
     - svelte.svelte-vscode
-    - yzhang.markdown-all-in-one
+    - yzhang.markdown-all-in-one
+    - dbaeumer.vscode-eslint

package.json

@@ -7,22 +7,28 @@
     "@changesets/cli": "^2.14.1",
     "@types/fs-extra": "^9.0.13",
     "@types/sinon": "^10.0.4",
+    "@typescript-eslint/eslint-plugin": "^5.3.0",
+    "@typescript-eslint/parser": "^5.3.0",
     "c8": "^7.10.0",
     "commitizen": "^4.2.3",
     "cypress": "^8.6.0",
     "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^8.1.0",
+    "eslint-config-prettier": "^8.3.0",
     "husky": "^6.0.0",
     "lint-staged": "^10.5.4",
     "prettier": "^2.2.1",
     "sinon": "^11.1.2",
     "tsm": "^2.1.2",
+    "typescript": "^3.6.3",
     "uvu": "^0.5.2"
   },
   "scripts": {
     "build": "pnpm --recursive --parallel build",
     "changeset": "changeset && pnpm install",
     "clean": "rm -fr ./node_modules && pnpm --recursive --parallel clean",
     "dev": "pnpm --recursive --parallel dev",
+    "lint": "eslint . --fix --ignore-path .gitignore --max-warnings 0",
     "preinstall": "npx only-allow pnpm",
     "prepare": "husky install",
     "release": "changeset publish",
@@ -48,7 +54,7 @@
     }
   },
   "lint-staged": {
-    "*.{js,ts}": "pnpm test --filter \"...[origin/main]\"",
+    "*.{js,ts}": ["pnpm lint", "pnpm test --filter \"...[origin/main]\""],
     "*.{css,js,md,ts}": "prettier --write"
   }
 }

packages/cli/package.json

@@ -15,7 +15,6 @@
     "dev": "pnpm clean && pnpm copy-templates && pnpm dev:watch-src & pnpm dev:watch-templates",
     "dev:watch-src": "tsc -w",
     "dev:watch-templates": "npm-watch copy-templates",
-    "lint": "tslint -p .",
     "prepublishOnly": "pnpm build",
     "test": "pnpm test:unit",
     "test:unit": "c8 --all --include=src --reporter=html pnpm test:unit:only",
@@ -37,9 +36,6 @@
     "@types/node": "^12.7.11",
     "npm-watch": "^0.11.0",
     "ts-node": "^8.4.1",
-    "tslint": "^5.12.0",
-    "tslint-config-prettier": "^1.17.0",
-    "tslint-config-standard": "^8.0.1",
     "typescript": "^3.6.3"
   }
 }

packages/cli/src/commands/deploy/web.ts

@@ -28,9 +28,9 @@ const command: GluegunCommand = {
     } else {
       const installedAdapter = web.configure.deployment.getInstalledAdapter();
       print.highlight(
-        `Your web service is ready to be deployed. Please follow the instructions at https://github.com/WebstoneHQ/webstone/tree/main/docs/deployment#${installedAdapter!.identifier.substring(
+        `Your web service is ready to be deployed. Please follow the instructions at https://github.com/WebstoneHQ/webstone/tree/main/docs/deployment#${installedAdapter.identifier.substring(
           "adapter-".length
-        )} to deploy to ${installedAdapter!.name}`
+        )} to deploy to ${installedAdapter.name}`
       );
     }
   },

packages/cli/src/extensions/web/types.d.ts

@@ -5,7 +5,7 @@ export interface WebToolbox {
     configure: {
       deployment: {
         availableAdapters: Adapter[];
-        getInstalledAdapter: () => Adapter | undefined;
+        getInstalledAdapter: () => Adapter;
         installAdapter: (adapter: Adapter) => Promise<void>;
         isAnyAdapterInstalled: () => boolean;
         removeAdapter: (adapter: Adapter) => Promise<void>;

packages/cli/src/toolbox/web/configure/deployment/get-installed-adapter.ts

@@ -1,5 +1,6 @@
 import { filesystem } from "gluegun";
 import { availableAdapters } from "./adapters";
+import { Adapter } from "./types";
 
 export default () => {
   const webPackageJson = filesystem.read("./services/web/package.json", "json");
@@ -14,5 +15,5 @@ export default () => {
 
   return availableAdapters.find(
     (adapter) => adapter.npmPackage === installedAdapterNpmPackage
-  );
+  ) as Adapter;
 };

packages/create-webstone-app/scripts/esbuild.js

@@ -1,3 +1,5 @@
+/* eslint @typescript-eslint/no-var-requires: "off" */
+
 const config = {
   shared: {
     banner: {

packages/create-webstone-app/src/index.ts

@@ -1,3 +1,6 @@
+// FIXME: Does anyone know how to properly type the `pipe` function?
+/* eslint @typescript-eslint/no-explicit-any: "off" */
+
 import {
   createAppDir,
   copyTemplate,

packages/create-webstone-app/tests/helpers/create-app-dir.ts

@@ -63,7 +63,7 @@ test("app dir does not exist", async () => {
   assert.equal(fakeFsMkdirSync.firstCall.lastArg, { recursive: true });
 });
 
-test("app dir exists and is empty", async (context) => {
+test("app dir exists and is empty", async () => {
   const fakeFsExistsSync = sinon.fake.returns(true);
   sinon.replace(fs, "existsSync", fakeFsExistsSync);
 
@@ -80,7 +80,7 @@ test("app dir exists and is empty", async (context) => {
   assert.equal(fakeFsMkdirSync.firstCall.lastArg, { recursive: true });
 });
 
-test("app dir exists and is not empty, overwrite it", async (context) => {
+test("app dir exists and is not empty, overwrite it", async () => {
   const fakeFsExistsSync = sinon.fake.returns(true);
   sinon.replace(fs, "existsSync", fakeFsExistsSync);
 
@@ -107,7 +107,7 @@ test("app dir exists and is not empty, overwrite it", async (context) => {
   assert.equal(fakeFsMkdirSync.firstCall.lastArg, { recursive: true });
 });
 
-test("app dir exists and is not empty, do not overwrite it", async (context) => {
+test("app dir exists and is not empty, do not overwrite it", async () => {
   const fakeFsExistsSync = sinon.fake.returns(true);
   sinon.replace(fs, "existsSync", fakeFsExistsSync);