chore: fix eslint rules usage (#170)

* chore: fix eslint rules usage

* fix: use unknown instead of any where possible

Author: galargh

scripts/.eslintrc.json

@@ -30,7 +30,7 @@
       "@typescript-eslint/no-inferrable-types": "error",
       "@typescript-eslint/no-misused-new": "error",
       "@typescript-eslint/no-namespace": "error",
-      "@typescript-eslint/no-non-null-assertion": "warn",
+      "@typescript-eslint/no-non-null-assertion": "error",
       "@typescript-eslint/no-unnecessary-qualifier": "error",
       "@typescript-eslint/no-unnecessary-type-assertion": "error",
       "@typescript-eslint/no-useless-constructor": "error",
@@ -46,7 +46,8 @@
       "@typescript-eslint/semi": ["error", "never"],
       "@typescript-eslint/type-annotation-spacing": "error",
       "@typescript-eslint/unbound-method": "error",
-      "filenames/match-regex": ["error", "^([a-z0-9]+)([A-Z][a-z0-9]+)*(\\.test)?$"]
+      "filenames/match-regex": "off",
+      "no-console": "off"
     },
     "env": {
       "node": true,

scripts/__tests__/sync.test.ts

@@ -9,6 +9,7 @@ import {GitHub} from '../src/github'
 import env from '../src/env'
 import {Resource} from '../src/resources/resource'
 import {RepositoryFile} from '../src/resources/repository-file'
+import {StateSchema} from '../src/terraform/schema'
 import {toggleArchivedRepos} from '../src/actions/shared/toggle-archived-repos'
 
 test('sync', async () => {
@@ -37,10 +38,10 @@ test('sync new repository file', async () => {
       }
     }
   }
-  const tfSource = {
+  const tfSource: StateSchema = {
     values: {
       root_module: {
-        resources: [] as any[] // eslint-disable-line @typescript-eslint/no-explicit-any
+        resources: []
       }
     }
   }
@@ -62,19 +63,20 @@ test('sync new repository file', async () => {
 
   const addResourceMock = jest.spyOn(tfConfig, 'addResource')
 
-  addResourceMock.mockImplementation(
-    async (_id: string, resource: Resource) => {
-      tfSource.values.root_module.resources.push({
-        mode: 'managed',
-        type: RepositoryFile.StateType,
-        values: {
-          repository: (resource as RepositoryFile).repository,
-          file: (resource as RepositoryFile).file,
-          ...resource
-        }
-      })
-    }
-  )
+  addResourceMock.mockImplementation(async (id: string, resource: Resource) => {
+    tfSource?.values?.root_module?.resources?.push({
+      mode: 'managed',
+      index: id,
+      address: resource.getStateAddress(),
+      type: RepositoryFile.StateType,
+      values: {
+        repository: (resource as RepositoryFile).repository,
+        file: (resource as RepositoryFile).file,
+        content: (resource as RepositoryFile).content ?? '',
+        ...resource
+      }
+    })
+  })
 
   const expectedYamlConfig = new config.Config(YAML.stringify(yamlSource))
 

scripts/__tests__/terraform/state.test.ts

@@ -47,11 +47,11 @@ test('can ignore resource properties', async () => {
 test('can add and remove resources through sync', async () => {
   const config = await State.New()
 
-  let addResourceSpy = jest.spyOn(config, 'addResource')
-  let removeResourceAtSpy = jest.spyOn(config, 'removeResourceAt')
+  const addResourceSpy = jest.spyOn(config, 'addResource')
+  const removeResourceAtSpy = jest.spyOn(config, 'removeResourceAt')
 
-  let desiredResources: [Id, Resource][] = []
-  let resources = config.getAllResources()
+  const desiredResources: [Id, Resource][] = []
+  const resources = config.getAllResources()
 
   await config.sync(desiredResources)
 

scripts/__tests__/yaml/config.test.ts

@@ -1,17 +1,21 @@
 import 'reflect-metadata'
 
+import * as YAML from 'yaml'
 import {Config} from '../../src/yaml/config'
 import {
   Resource,
   ResourceConstructors,
   resourceToPlain
 } from '../../src/resources/resource'
-import {Member, Role as MemberRole, Role} from '../../src/resources/member'
+import {NodeBase} from 'yaml/dist/nodes/Node'
+import {Member, Role as MemberRole} from '../../src/resources/member'
 import {Repository} from '../../src/resources/repository'
 import {RepositoryFile} from '../../src/resources/repository-file'
 import {randomUUID} from 'crypto'
 import {Team, Privacy as TeamPrivacy} from '../../src/resources/team'
 import {RepositoryBranchProtectionRule} from '../../src/resources/repository-branch-protection-rule'
+import {Collection} from 'yaml/dist/nodes/Collection'
+import assert from 'node:assert'
 import {toggleArchivedRepos} from '../../src/actions/shared/toggle-archived-repos'
 import {State} from '../../src/terraform/state'
 
@@ -167,13 +171,17 @@ test('clears comments on member removal', async () => {
 
   const member = config.getResources(Member)[0]
 
-  ;(config.document.getIn(['members', member.role]) as any).items[0].comment =
-    comment
+  const nodes = config.document.getIn(['members', member.role]) as Collection
+  const node = nodes.items[0] as NodeBase
+  node.comment = comment
 
   config.removeResource(member)
 
-  const updatedMembers = config.document.getIn(['members', member.role]) as any
-  for (const item of updatedMembers.items) {
+  const updatedMembers = config.document.getIn([
+    'members',
+    member.role
+  ]) as Collection
+  for (const item of updatedMembers.items as NodeBase[]) {
     expect(item.comment).not.toEqual(comment)
   }
 })
@@ -193,10 +201,12 @@ test('clears comments on repository property updates', async () => {
   const repositories = config.document.getIn([
     'repositories',
     repository.name
-  ]) as any
-
-  repositories.items.find((i: any) => i.key.value === property)!.value.comment =
-    comment
+  ]) as Collection
+  const nodes = repositories.items as YAML.Pair<YAML.Scalar, NodeBase>[]
+  const node = nodes.find(i => i.key.value === property)
+  assert(node !== undefined)
+  assert(node.value !== null)
+  node.value.comment = comment
 
   repository[property] = description
 
@@ -205,11 +215,15 @@ test('clears comments on repository property updates', async () => {
   const updatedRepositories = config.document.getIn([
     'repositories',
     repository.name
-  ]) as any
-  expect(
-    updatedRepositories.items.find((i: any) => i.key.value === property)!.value
-      .comment
-  ).toBeUndefined()
+  ]) as Collection
+  const updatedNodes = updatedRepositories.items as YAML.Pair<
+    YAML.Scalar,
+    NodeBase
+  >[]
+  const updatedNode = updatedNodes.find(i => i.key.value === property)
+  assert(updatedNode !== undefined)
+  assert(updatedNode.value !== null)
+  expect(updatedNode.value.comment).toBeUndefined()
   expect(config.getResources(Repository)[0][property]).toEqual(description)
 })
 
@@ -220,15 +234,19 @@ test('does not clear comments on same member addition', async () => {
 
   const member = config.getResources(Member)[0]
 
-  const members = config.document.getIn(['members', member.role]) as any
-  members.items[0].comment = comment
+  const nodes = config.document.getIn(['members', member.role]) as Collection
+  const node = nodes.items[0] as NodeBase
+  node.comment = comment
 
   config.addResource(member)
 
-  const updatedMembers = config.document.getIn(['members', member.role]) as any
+  const updatedMembers = config.document.getIn([
+    'members',
+    member.role
+  ]) as Collection
 
   expect(
-    updatedMembers.items.some((i: any) => i.comment === comment)
+    (updatedMembers.items as NodeBase[]).some(i => i.comment === comment)
   ).toBeTruthy()
 })
 
@@ -245,20 +263,27 @@ test('does not clear comments on repository property updates to the same value',
   const repositories = config.document.getIn([
     'repositories',
     repository.name
-  ]) as any
-  repositories.items.find((i: any) => i.key.value === property)!.value.comment =
-    comment
+  ]) as Collection
+  const nodes = repositories.items as YAML.Pair<YAML.Scalar, NodeBase>[]
+  const node = nodes.find(i => i.key.value === property)
+  assert(node !== undefined)
+  assert(node.value !== null)
+  node.value.comment = comment
 
   config.addResource(repository)
 
   const updatedRepositories = config.document.getIn([
     'repositories',
     repository.name
-  ]) as any
-  expect(
-    updatedRepositories.items.find((i: any) => i.key.value === property)!.value
-      .comment
-  ).toEqual(comment)
+  ]) as Collection
+  const updatedNodes = updatedRepositories.items as YAML.Pair<
+    YAML.Scalar,
+    NodeBase
+  >[]
+  const updatedNode = updatedNodes.find(i => i.key.value === property)
+  assert(updatedNode !== undefined)
+  assert(updatedNode.value !== null)
+  expect(updatedNode.value.comment).toEqual(comment)
 })
 
 test('can add a repository followed by a repository branch protection rule', async () => {
@@ -285,15 +310,15 @@ test('does not remove properties when adding a team', async () => {
   const config = Config.FromPath()
 
   const team = config.getResources(Team)[0]
-  const definedValues = Object.values(resourceToPlain(team) as any).filter(
-    v => v !== undefined
-  )
+  const definedValues = Object.values(
+    resourceToPlain(team) as Record<string, unknown>
+  ).filter(v => v !== undefined)
   expect(definedValues).not.toHaveLength(0)
   config.addResource(new Team(team.name), false)
 
   const updatedTeam = config.getResources(Team)[0]
   const updatedDefinedValues = Object.values(
-    resourceToPlain(updatedTeam) as any
+    resourceToPlain(updatedTeam) as Record<string, unknown>
   ).filter(v => v !== undefined)
   expect(updatedDefinedValues).not.toHaveLength(0)
 })
@@ -302,15 +327,15 @@ test('does remove undefined properties when adding a team with delete flag set',
   const config = Config.FromPath()
 
   const team = config.getResources(Team)[0]
-  const definedValues = Object.values(resourceToPlain(team) as any).filter(
-    v => v !== undefined
-  )
+  const definedValues = Object.values(
+    resourceToPlain(team) as Record<string, unknown>
+  ).filter(v => v !== undefined)
   expect(definedValues).not.toHaveLength(0)
   config.addResource(new Team(team.name), true)
 
   const updatedTeam = config.getResources(Team)[0]
   const updatedDefinedValues = Object.values(
-    resourceToPlain(updatedTeam) as any
+    resourceToPlain(updatedTeam) as Record<string, unknown>
   ).filter(v => v !== undefined)
   expect(updatedDefinedValues).toHaveLength(0)
 })
@@ -338,7 +363,8 @@ members:
 
   const undefinedMember = config
     .getResources(Member)
-    .find(m => m.username === 'undefined')!
+    .find(m => m.username === 'undefined')
+  assert(undefinedMember !== undefined)
   config.removeResource(undefinedMember)
   config.format()
   const formatted = config.toString().trim()
@@ -394,10 +420,12 @@ test('clears and re-adds repository fields when archiving/unarchiving', async ()
 
   const archivedRepository = config
     .getResources(Repository)
-    .find(r => r.archived)!
+    .find(r => r.archived)
+  assert(archivedRepository !== undefined)
   const unarchivedRepository = config
     .getResources(Repository)
-    .find(r => !r.archived)!
+    .find(r => !r.archived)
+  assert(unarchivedRepository !== undefined)
 
   expect(archivedRepository.archived).toBe(true)
   expect(archivedRepository.visibility).not.toBeDefined()
@@ -413,9 +441,11 @@ test('clears and re-adds repository fields when archiving/unarchiving', async ()
 
   await toggleArchivedRepos(state, config)
 
-  const previouslyArchivedRepository = config.findResource(archivedRepository)!
+  const previouslyArchivedRepository = config.findResource(archivedRepository)
+  assert(previouslyArchivedRepository !== undefined)
   const previouslyUnarchivedRepository =
-    config.findResource(unarchivedRepository)!
+    config.findResource(unarchivedRepository)
+  assert(previouslyUnarchivedRepository !== undefined)
 
   expect(previouslyArchivedRepository.archived).toBe(false)
   expect(previouslyArchivedRepository.visibility).toBeDefined()

scripts/jest.setup.ts

@@ -21,40 +21,40 @@ jest.mock('./src/env', () => ({
 
 GitHub.github = {
   listMembers: async () => {
-    return [] as any // eslint-disable-line @typescript-eslint/no-explicit-any
+    return [] as any
   },
   listRepositories: async () => {
-    return [] as any // eslint-disable-line @typescript-eslint/no-explicit-any
+    return [] as any
   },
   listTeams: async () => {
-    return [] as any // eslint-disable-line @typescript-eslint/no-explicit-any
+    return [] as any
   },
   listRepositoryCollaborators: async () => {
-    return [] as any // eslint-disable-line @typescript-eslint/no-explicit-any
+    return [] as any
   },
   listRepositoryBranchProtectionRules: async () => {
-    return [] as any // eslint-disable-line @typescript-eslint/no-explicit-any
+    return [] as any
   },
   listTeamRepositories: async () => {
-    return [] as any // eslint-disable-line @typescript-eslint/no-explicit-any
+    return [] as any
   },
   listTeamMembers: async () => {
-    return [] as any // eslint-disable-line @typescript-eslint/no-explicit-any
+    return [] as any
   },
   getRepositoryFile: async (_repository: string, _path: string) => {
     return undefined
   },
   listInvitations: async () => {
-    return [] as any // eslint-disable-line @typescript-eslint/no-explicit-any
+    return [] as any
   },
   listRepositoryInvitations: async () => {
-    return [] as any // eslint-disable-line @typescript-eslint/no-explicit-any
+    return [] as any
   },
   listTeamInvitations: async () => {
-    return [] as any // eslint-disable-line @typescript-eslint/no-explicit-any
+    return [] as any
   },
   listRepositoryLabels: async () => {
-    return [] as any // eslint-disable-line @typescript-eslint/no-explicit-any
+    return [] as any
   }
 } as GitHub