Adds lint workflow

.eslintrc.json

@@ -4,6 +4,20 @@
     "eslint:recommended",
     "plugin:@typescript-eslint/recommended"
   ],
+  "rules": {
+    "array-callback-return": ["error"],
+    "no-await-in-loop": ["error"],
+    "no-constant-binary-expression": ["error"],
+    "no-constructor-return": ["error"],
+    "no-duplicate-imports": ["error"],
+    "no-new-native-nonconstructor": ["error"],
+    "no-self-compare": ["error"],
+    "no-template-curly-in-string": ["error"],
+    "no-unmodified-loop-condition": ["error"],
+    "no-unreachable-loop": ["error"],
+    "no-unused-private-class-members": ["error"],
+    "require-atomic-updates": ["error"]
+  },
   "parser": "@typescript-eslint/parser",
   "plugins": [
     "@typescript-eslint"

.github/workflows/lint.yml

@@ -0,0 +1,17 @@
+name: Lint
+on:
+  workflow_dispatch: {}
+  pull_request: {}
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+jobs:
+  build:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install modules
+        run: npm install
+      - name: Run ESLint
+        run: npm run lint

__test__/auth/AccessTokenService.test.ts

@@ -1,5 +1,4 @@
 import AccessTokenService from "../../src/features/auth/domain/AccessTokenService"
-import { IOAuthToken } from "../../src/features/auth/domain/IOAuthTokenRepository"
 
 test("It reads the access token from the repository", async () => {
   const sut = new AccessTokenService({
@@ -11,9 +10,9 @@ test("It reads the access token from the repository", async () => {
         refreshTokenExpiryDate: new Date(new Date().getTime() + 3600 * 1000)
       }
     },
-    async storeOAuthToken(_token: IOAuthToken) {}
+    async storeOAuthToken() {}
   }, {
-    async refreshAccessToken(_refreshToken: string) {
+    async refreshAccessToken() {
       return {
         accessToken: "foo",
         refreshToken: "bar",
@@ -36,9 +35,9 @@ test("It refreshes an expired access token", async () => {
         refreshTokenExpiryDate: new Date(new Date().getTime() + 3600 * 1000)
       }
     },
-    async storeOAuthToken(_token: IOAuthToken) {}
+    async storeOAuthToken() {}
   }, {
-    async refreshAccessToken(_refreshToken: string) {
+    async refreshAccessToken() {
       return {
         accessToken: "new",
         refreshToken: "bar",
@@ -62,11 +61,11 @@ test("It stores the refreshed access token", async () => {
         refreshTokenExpiryDate: new Date(new Date().getTime() + 3600 * 1000)
       }
     },
-    async storeOAuthToken(_token: IOAuthToken) {
+    async storeOAuthToken() {
       didStoreRefreshedToken = true
     }
   }, {
-    async refreshAccessToken(_refreshToken: string) {
+    async refreshAccessToken() {
       return {
         accessToken: "new",
         refreshToken: "bar",
@@ -89,9 +88,9 @@ test("It errors when the refresh token has expired", async () => {
         refreshTokenExpiryDate: new Date(new Date().getTime() - 3600 * 1000)
       }
     },
-    async storeOAuthToken(_token: IOAuthToken) {}
+    async storeOAuthToken() {}
   }, {
-    async refreshAccessToken(_refreshToken: string) {
+    async refreshAccessToken() {
       return {
         accessToken: "new",
         refreshToken: "bar",

__test__/hooks/ExistingCommentCheckingPullRequestEventHandler.test.ts

@@ -3,13 +3,13 @@ import ExistingCommentCheckingPullRequestEventHandler from "../../src/features/h
 test("It fetches comments from the repository", async () => {
   let didFetchComments = false
   const sut = new ExistingCommentCheckingPullRequestEventHandler({
-    async pullRequestOpened(_event) {}
+    async pullRequestOpened() {}
   }, {
-    async getComments(_operation) {
+    async getComments() {
       didFetchComments = true
       return []
     },
-    async addComment(_operation) {}
+    async addComment() {}
   }, "https://docs.shapetools.io")
   await sut.pullRequestOpened({
     appInstallationId: 42,
@@ -24,14 +24,14 @@ test("It fetches comments from the repository", async () => {
 test("It does calls decorated event handler if a comment does not exist in the repository", async () => {
   let didCallEventHandler = false
   const sut = new ExistingCommentCheckingPullRequestEventHandler({
-    async pullRequestOpened(_event) {
+    async pullRequestOpened() {
       didCallEventHandler = true
     }
   }, {
-    async getComments(_operation) {
+    async getComments() {
       return []
     },
-    async addComment(_operation) {}
+    async addComment() {}
   }, "https://docs.shapetools.io")
   await sut.pullRequestOpened({
     appInstallationId: 42,
@@ -46,17 +46,17 @@ test("It does calls decorated event handler if a comment does not exist in the r
 test("It does not call the event handler if a comment already exists in the repository", async () => {
   let didCallEventHandler = false
   const sut = new ExistingCommentCheckingPullRequestEventHandler({
-    async pullRequestOpened(_event) {
+    async pullRequestOpened() {
       didCallEventHandler = true
     }
   }, {
-    async getComments(_operation) {
+    async getComments() {
       return [{
         body: "The documentation is available on https://docs.shapetools.io",
         isFromBot: true
       }]
     },
-    async addComment(_operation) {}
+    async addComment() {}
   }, "https://docs.shapetools.io")
   await sut.pullRequestOpened({
     appInstallationId: 42,
@@ -71,17 +71,17 @@ test("It does not call the event handler if a comment already exists in the repo
 test("It calls the event handler if a comment exists matching the needle domain but that comment is not from a bot", async () => {
   let didCallEventHandler = false
   const sut = new ExistingCommentCheckingPullRequestEventHandler({
-    async pullRequestOpened(_event) {
+    async pullRequestOpened() {
       didCallEventHandler = true
     }
   }, {
-    async getComments(_operation) {
+    async getComments() {
       return [{
         body: "The documentation is available on https://docs.shapetools.io",
         isFromBot: false
       }]
     },
-    async addComment(_operation) {}
+    async addComment() {}
   }, "https://docs.shapetools.io")
   await sut.pullRequestOpened({
     appInstallationId: 42,
@@ -96,17 +96,17 @@ test("It calls the event handler if a comment exists matching the needle domain
 test("It calls the event handler if the repository contains a comment from a bot but that comment does not contain the needle domain", async () => {
   let didCallEventHandler = false
   const sut = new ExistingCommentCheckingPullRequestEventHandler({
-    async pullRequestOpened(_event) {
+    async pullRequestOpened() {
       didCallEventHandler = true
     }
   }, {
-    async getComments(_operation) {
+    async getComments() {
       return [{
         body: "Hello world!",
         isFromBot: true
       }]
     },
-    async addComment(_operation) {}
+    async addComment() {}
   }, "https://docs.shapetools.io")
   await sut.pullRequestOpened({
     appInstallationId: 42,

__test__/hooks/PostCommentPullRequestEventHandler.test.ts

@@ -3,10 +3,10 @@ import PostCommentPullRequestEventHandler from "../../src/features/hooks/domain/
 test("It adds a comment to the repository", async () => {
   let didAddComment = false
   const sut = new PostCommentPullRequestEventHandler({
-    async getComments(_operation) {
+    async getComments() {
       return []
     },
-    async addComment(_operation) {
+    async addComment() {
       didAddComment = true
     }
   }, "https://docs.shapetools.io")
@@ -23,7 +23,7 @@ test("It adds a comment to the repository", async () => {
 test("It adds a comment containing a link to the documentation", async () => {
   let commentBody: string | undefined
   const sut = new PostCommentPullRequestEventHandler({
-    async getComments(_operation) {
+    async getComments() {
       return []
     },
     async addComment(operation) {
@@ -43,7 +43,7 @@ test("It adds a comment containing a link to the documentation", async () => {
 test("It removes the \"openapi\" suffix of the repository name", async () => {
   let commentBody: string | undefined
   const sut = new PostCommentPullRequestEventHandler({
-    async getComments(_operation) {
+    async getComments() {
       return []
     },
     async addComment(operation) {

__test__/hooks/RepositoryNameCheckingPullRequestEventHandler.test.ts

@@ -3,7 +3,7 @@ import RepositoryNameCheckingPullRequestEventHandler from "../../src/features/ho
 test("It does not call event handler when repository name does not have \"-openapi\" suffix", async () => {
   let didCallEventHandler = false
   const sut = new RepositoryNameCheckingPullRequestEventHandler({
-    async pullRequestOpened(_event) {
+    async pullRequestOpened() {
       didCallEventHandler = true
     }
   }, [], [])
@@ -20,7 +20,7 @@ test("It does not call event handler when repository name does not have \"-opena
 test("It does not call event handler when repository name contains \"-openapi\" but it is not the last part of the repository name", async () => {
   let didCallEventHandler = false
   const sut = new RepositoryNameCheckingPullRequestEventHandler({
-    async pullRequestOpened(_event) {
+    async pullRequestOpened() {
       didCallEventHandler = true
     }
   }, [], [])
@@ -37,7 +37,7 @@ test("It does not call event handler when repository name contains \"-openapi\"
 test("It calls event handler when no repositories have been allowed or disallowed", async () => {
   let didCallEventHandler = false
   const sut = new RepositoryNameCheckingPullRequestEventHandler({
-    async pullRequestOpened(_event) {
+    async pullRequestOpened() {
       didCallEventHandler = true
     }
   }, [], [])
@@ -54,7 +54,7 @@ test("It calls event handler when no repositories have been allowed or disallowe
 test("It does not call event handler for repository that is not on the allowlist", async () => {
   let didCallEventHandler = false
   const sut = new RepositoryNameCheckingPullRequestEventHandler({
-    async pullRequestOpened(_event) {
+    async pullRequestOpened() {
       didCallEventHandler = true
     }
   }, ["example-openapi"], [])
@@ -71,7 +71,7 @@ test("It does not call event handler for repository that is not on the allowlist
 test("It does not call event handler for repository that is on the disallowlist", async () => {
   let didCallEventHandler = false
   const sut = new RepositoryNameCheckingPullRequestEventHandler({
-    async pullRequestOpened(_event) {
+    async pullRequestOpened() {
       didCallEventHandler = true
     }
   }, [], ["example-openapi"])
@@ -88,7 +88,7 @@ test("It does not call event handler for repository that is on the disallowlist"
 test("It lets the disallowlist takes precedence over the allowlist", async () => {
   let didCallEventHandler = false
   const sut = new RepositoryNameCheckingPullRequestEventHandler({
-    async pullRequestOpened(_event) {
+    async pullRequestOpened() {
       didCallEventHandler = true
     }
   }, ["example-openapi"], ["example-openapi"])

src/app/api/github/blob/[owner]/[repository]/[...path]/route.ts

@@ -21,6 +21,6 @@ export async function GET(req: NextRequest, { params }: { params: GetBlobParams
     path: fullPath,
     ref: ref || undefined
   })
-  let item = response.data as GitHubContentItem
+  const item = response.data as GitHubContentItem
   return NextResponse.redirect(new URL(item.download_url))
 }

src/app/api/hooks/github/route.ts

@@ -28,7 +28,7 @@ const commentRepository = new GitHubPullRequestCommentRepository({
   appId: GITHUB_APP_ID,
   privateKey: privateKey,
   clientId: GITHUB_CLIENT_ID,
-  clientSecret: GITHUB_WEBHOOK_SECRET
+  clientSecret: GITHUB_CLIENT_SECRET
 })
 const hookHandler = new GitHubHookHandler({
   secret: GITHUB_WEBHOOK_SECRET,

src/app/api/user/projects/route.ts

@@ -1,7 +1,7 @@
-import { NextRequest, NextResponse } from "next/server"
+import { NextResponse } from "next/server"
 import { projectRepository } from "@/common/startup"
 
-export async function GET(_req: NextRequest) {
+export async function GET() {
   const projects = await projectRepository.getProjects()
   return NextResponse.json({projects})
 }

src/common/client/ThemeRegistry.tsx

@@ -1,19 +1,22 @@
 "use client"
 
-import { useState } from "react"
-import createCache from "@emotion/cache"
+import { ReactNode, useState } from "react"
+import createCache, { Options } from "@emotion/cache"
 import { useServerInsertedHTML } from "next/navigation"
 import { CacheProvider } from "@emotion/react"
 import { ThemeProvider } from "@mui/material/styles"
 import CssBaseline from "@mui/material/CssBaseline"
 import theme from "./theme"
-import useMediaQuery from "@mui/material/useMediaQuery"
+
+type ThemeRegistryProps = {
+  options: Options
+  children: ReactNode
+}
 
 // This implementation is from emotion-js
 // https://github.com/emotion-js/emotion/issues/2928#issuecomment-1319747902
-export default function ThemeRegistry(props: any) {
+export default function ThemeRegistry(props: ThemeRegistryProps) {
   const { options, children } = props;
-  const prefersDarkMode = useMediaQuery('(prefers-color-scheme: dark)');
   const [{ cache, flush }] = useState(() => {
     const cache = createCache(options);
     cache.compat = true;
@@ -56,7 +59,7 @@ export default function ThemeRegistry(props: any) {
 
   return (
     <CacheProvider value={cache}>
-      <ThemeProvider theme={theme(prefersDarkMode)}>
+      <ThemeProvider theme={theme()}>
         <CssBaseline />
         {children}
       </ThemeProvider>

src/common/client/theme.ts

@@ -1,7 +1,7 @@
 import { createTheme } from "@mui/material/styles"
 import { blue } from "@mui/material/colors"
 
-const theme = (_prefersDarkMode: boolean) => createTheme({
+const theme = () => createTheme({
   palette: {
     mode: "light",
     primary: {

src/common/events/utils.ts

@@ -1,18 +1,18 @@
 import BaseEvent, { Events } from "./BaseEvent"
 
-function subscribe(eventName: Events, listener: (event: CustomEvent<any>) => void) {
-  document.addEventListener(eventName, listener as () => void);
+function subscribe(eventName: Events, listener: () => void) {
+  document.addEventListener(eventName, listener)
 }
 
-function unsubscribe(eventName: Events, listener: (event: CustomEvent<any>) => void) {
-  document.removeEventListener(eventName, listener as () => void);
+function unsubscribe(eventName: Events, listener: () => void) {
+  document.removeEventListener(eventName, listener)
 }
 
 function publish<T>(event: BaseEvent<T>) {
   const customEvent = new CustomEvent(event.name, {
     detail: event.data
-  });
-  document.dispatchEvent(customEvent);
+  })
+  document.dispatchEvent(customEvent)
 }
 
-export { publish, subscribe, unsubscribe };
+export { publish, subscribe, unsubscribe }

src/common/fetcher.ts

@@ -1,4 +1,5 @@
-export default async function fetcher<JSON = any>(
+ /* eslint-disable  @typescript-eslint/no-explicit-any */
+ export default async function fetcher<JSON = any>(
   input: RequestInfo,
   init?: RequestInit
 ): Promise<JSON> {