chore: lint files applying the updated rules

risantos · risantos · commit 7fb7fa98a95d · 2025-09-23T21:34:25.000+01:00
- Replace outdate rule names
- Replace `any` types
- Pre-pend `_` to unused variables
diff --git a/packages/zcli-apps/src/commands/apps/clean.ts b/packages/zcli-apps/src/commands/apps/clean.ts
@@ -25,7 +25,7 @@ export default class Clean extends Command {
     try {
       await cleanDirectory(tmpDirectoryPath)
       this.log(chalk.green(`Successfully removed ${tmpDirectoryPath} directory.`))
-    } catch (error) {
+    } catch (_error) {
       this.error(chalk.red(`Failed to remove ${tmpDirectoryPath} directory.`))
     }
   }
diff --git a/packages/zcli-apps/src/commands/apps/create.ts b/packages/zcli-apps/src/commands/apps/create.ts
@@ -44,7 +44,7 @@ export default class Create extends Command {
       const { job_id } = await deployApp('POST', 'api/apps.json', upload_id, manifest.name)
 
       try {
-        const { app_id }: any = await getUploadJobStatus(job_id, appPath)
+        const { app_id }: { app_id: string } = await getUploadJobStatus(job_id, appPath)
         CliUx.ux.action.stop('Deployed')
 
         const allConfigs = getAllConfigs(appPath)
diff --git a/packages/zcli-apps/src/commands/apps/update.ts b/packages/zcli-apps/src/commands/apps/update.ts
@@ -30,7 +30,7 @@ export default class Update extends Command {
     const { job_id } = await deployApp('PUT', `api/v2/apps/${appID}`, uploadId)
 
     try {
-      const { app_id }: any = await getUploadJobStatus(job_id, appPath)
+      const { app_id }: { app_id: string } = await getUploadJobStatus(job_id, appPath)
       CliUx.ux.action.stop('Deployed')
       if (!manifest.requirementsOnly && manifest.location) {
         Object.keys(manifest.location).forEach(async product => {
diff --git a/packages/zcli-apps/src/lib/buildAppJSON.test.ts b/packages/zcli-apps/src/lib/buildAppJSON.test.ts
@@ -276,7 +276,7 @@ describe('buildAppJSON', () => {
   const mockId = '1'
 
   test
-    .stub(appPath, 'validateAppPath', () => {}) // eslint-disable-line @typescript-eslint/no-empty-function
+    .stub(appPath, 'validateAppPath', () => {})
     .stub(manifest, 'getManifestFile', () => manifestOutput)
     .stub(appConfig, 'getAllConfigs', () => ({
       app_id: '234',
@@ -328,7 +328,7 @@ describe('buildAppJSON', () => {
 
   describe('for non private apps', () => {
     test
-      .stub(appPath, 'validateAppPath', () => {}) // eslint-disable-line @typescript-eslint/no-empty-function
+      .stub(appPath, 'validateAppPath', () => {})
       .stub(manifest, 'getManifestFile', () => manifestOutputNoParams)
       .stub(uuid, 'uuidV4', () => mockId)
       .stub(buildAppJSON, 'getLocationIcons', () => { return multiProductLocationIcons })
@@ -370,7 +370,7 @@ describe('buildAppJSON', () => {
 
   describe('with no params attribute on manifest file', () => {
     test
-      .stub(appPath, 'validateAppPath', () => {}) // eslint-disable-line @typescript-eslint/no-empty-function
+      .stub(appPath, 'validateAppPath', () => {})
       .stub(manifest, 'getManifestFile', () => manifestOutputNoParams)
       .stub(appConfig, 'getAllConfigs', () => ({
         app_id: '234',
diff --git a/packages/zcli-apps/src/lib/buildAppJSON.ts b/packages/zcli-apps/src/lib/buildAppJSON.ts
@@ -49,7 +49,7 @@ export const getLocationIcons = (appPath: string, manifestLocations: Location =
     }, {})
 }
 
-export const getInstallation = (appId: string, app: App, configFileContents: ZcliConfigFileContent, appSettings: Array<Record<string, any>>): Installation => {
+export const getInstallation = (appId: string, app: App, configFileContents: ZcliConfigFileContent, appSettings: Array<Record<string, unknown>>): Installation => {
   const installationId = configFileContents.installation_id || uuidV4()
 
   return {
@@ -73,20 +73,21 @@ const mergeLocationAndIcons = (locations: Location, locationIcons: LocationIcons
     for (const locationName in locationIcons[product]) {
       if (typeof (locations[product][locationName]) === 'string') {
         locations[product][locationName] = {
-          url: locations[product][locationName]
+          url: locations[product][locationName] as string
         }
       }
+
       if (locationIcons[product][locationName].svg) {
-        locations[product][locationName].svg = locationIcons[product][locationName].svg
+        (locations[product][locationName] as { svg: string }).svg = locationIcons[product][locationName].svg
       }
       if (locationIcons[product][locationName].active) {
-        locations[product][locationName].active = locationIcons[product][locationName].active
+        (locations[product][locationName] as { active: string }).active = locationIcons[product][locationName].active
       }
       if (locationIcons[product][locationName].inactive) {
-        locations[product][locationName].inactive = locationIcons[product][locationName].inactive
+        (locations[product][locationName] as { inactive: string }).inactive = locationIcons[product][locationName].inactive
       }
       if (locationIcons[product][locationName].hover) {
-        locations[product][locationName].hover = locationIcons[product][locationName].hover
+        (locations[product][locationName] as { hover: string }).hover = locationIcons[product][locationName].hover
       }
     }
   }
@@ -95,7 +96,7 @@ const mergeLocationAndIcons = (locations: Location, locationIcons: LocationIcons
     for (const locationName in locations[product]) {
       if (typeof (locations[product][locationName]) === 'string') {
         locations[product][locationName] = {
-          url: locations[product][locationName]
+          url: locations[product][locationName] as string
         }
       }
     }
@@ -122,8 +123,8 @@ export const getAppPayloadFromManifest = (appManifest: Manifest, port: number, a
   return appPayload
 }
 
-const getSettingsArr = (appSettings: any) => {
-  const s: any[] = []
+const getSettingsArr = (appSettings: Record<string, string>) => {
+  const s: Record<string, string>[] = []
   Object.keys(appSettings).forEach((settingName: string) => {
     const setting: Record<string, string> = {}
     setting[settingName] = appSettings[settingName]
diff --git a/packages/zcli-apps/src/lib/package.test.ts b/packages/zcli-apps/src/lib/package.test.ts
@@ -20,8 +20,8 @@ describe('package', () => {
       .it('should throw if package has validation errors', async () => {
         try {
           await validatePkg('./app-path')
-        } catch (error: any) {
-          expect(error.message).to.equal('invalid location')
+        } catch (error: unknown) {
+          expect((error as Error).message).to.equal('invalid location')
         }
       })
 
@@ -31,8 +31,8 @@ describe('package', () => {
       .it('should throw if app path is invalid', async () => {
         try {
           await validatePkg('./bad-path')
-        } catch (error: any) {
-          expect(error.message).to.equal('Package not found at ./bad-path')
+        } catch (error: unknown) {
+          expect((error as Error).message).to.equal('Package not found at ./bad-path')
         }
       })
   })
diff --git a/packages/zcli-apps/src/types.ts b/packages/zcli-apps/src/types.ts
@@ -16,7 +16,13 @@ export type Dictionary<T> = {
 
 // Begin AppJSON definitions
 export interface AppLocation {
-  [appLocation: string]: any;
+  [appLocation: string]: string | {
+    active?: string;
+    hover?: string;
+    inactive?: string;
+    svg?: string;
+    url: string;
+  };
 }
 
 export interface IconLocationAllowlist {
@@ -107,8 +113,8 @@ export interface Installation {
     enabled: boolean;
     id: string;
     plan?: string;
-    requirements: Array<Record<string, any>>;
-    settings: Array<Record<string, any>>;
+    requirements: Array<Record<string, unknown>>;
+    settings: Array<Record<string, unknown>>;
     updated_at: string;
 }
 
diff --git a/packages/zcli-apps/src/utils/appConfig.ts b/packages/zcli-apps/src/utils/appConfig.ts
@@ -13,7 +13,7 @@ export const getAllConfigs = (appPath: string, configFileName: string = DEFAULT_
     const zcliConfigFile = fs.readFileSync(configFilePath, 'utf8')
     try {
       return JSON.parse(zcliConfigFile)
-    } catch (error) {
+    } catch (_error) {
       throw new CLIError(chalk.red(`zcli configuration file was malformed at path: ${configFilePath}`))
     }
   }
diff --git a/packages/zcli-apps/src/utils/createApp.ts b/packages/zcli-apps/src/utils/createApp.ts
@@ -11,7 +11,7 @@ export const getManifestAppName = (appPath: string): string | undefined => {
   return getManifestFile(appPath).name
 }
 
-export const uploadAppPkg = async (pkgPath: string): Promise<any> => {
+export const uploadAppPkg = async (pkgPath: string): Promise<{ id: number }> => {
   const pkgBuffer = await fs.readFile(pkgPath)
 
   const formData = new FormData()
@@ -63,7 +63,7 @@ export const deployApp = async (method: string, url: string, upload_id: number,
   return installationResponse.data
 }
 
-export const createProductInstallation = async (settings: any, manifest: Manifest, app_id: string, product: string): Promise<boolean> => {
+export const createProductInstallation = async (settings: Record<string, unknown>, manifest: Manifest, app_id: string, product: string): Promise<boolean> => {
   const installResponse = await request.requestAPI(`api/${product}/apps/installations.json`, {
     method: 'POST',
     data: JSON.stringify({ app_id: `${app_id}`, settings: { name: manifest.name, ...settings } }),
diff --git a/packages/zcli-apps/src/utils/uploadApp.ts b/packages/zcli-apps/src/utils/uploadApp.ts
@@ -3,7 +3,7 @@ import { request } from '@zendesk/zcli-core'
 import { getAppSettings } from './getAppSettings'
 import { Manifest, Installations, ZcliConfigFileContent } from '../types'
 
-export const getUploadJobStatus = async (job_id: string, appPath: string, pollAfter = 1000) => new Promise((resolve, reject) => {
+export const getUploadJobStatus = async (job_id: string, appPath: string, pollAfter = 1000) => new Promise<{ status: string, message: string, app_id: string }>((resolve, reject) => {
   const polling = setInterval(async () => {
     const res = await request.requestAPI(`api/v2/apps/job_statuses/${job_id}`, { method: 'GET' })
     const { status, message, app_id } = await res.data
diff --git a/packages/zcli-apps/tests/functional/server.test.ts b/packages/zcli-apps/tests/functional/server.test.ts
@@ -6,7 +6,7 @@ import * as fs from 'fs'
 import { omit } from 'lodash'
 import ServerCommand from '../../src/commands/apps/server'
 import { AppJSONPayload, Manifest } from '../../src/types'
-const appJSONSnapshot = require('./mocks/snapshot_app') // eslint-disable-line @typescript-eslint/no-var-requires
+const appJSONSnapshot = require('./mocks/snapshot_app') // eslint-disable-line @typescript-eslint/no-require-imports
 
 describe('apps server', function () {
   const singleProductApp = path.join(__dirname, 'mocks/single_product_app')
diff --git a/packages/zcli-core/src/lib/env.ts b/packages/zcli-core/src/lib/env.ts
@@ -8,4 +8,4 @@ export const EnvVars = {
   APP_ID: 'ZENDESK_APP_ID'
 }
 
-export const varExists = (...args: any[]) => !args.filter(envVar => !process.env[envVar]).length
+export const varExists = (...args: string[]) => !args.filter(envVar => !process.env[envVar]).length
diff --git a/packages/zcli-core/src/lib/request.ts b/packages/zcli-core/src/lib/request.ts
@@ -48,7 +48,7 @@ export const createRequestConfig = async (url: string, options: any = {}) => {
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export const requestAPI = async (url: string, options: any = {}, json = false) => {
+export const requestAPI = async (url: string, options: any = {}, _json = false) => {
   const requestConfig = await createRequestConfig(url, options)
   return axios.request({
     ...requestConfig,
diff --git a/packages/zcli-core/src/lib/secretType.ts b/packages/zcli-core/src/lib/secretType.ts
@@ -1,4 +1,4 @@
 export enum SecretType {
-  // eslint-disable-next-line no-unused-vars
-  TOKEN = 'token', PASSWORD = 'password'
+  PASSWORD = 'password',
+  TOKEN = 'token'
 }
diff --git a/packages/zcli-core/src/lib/secureStore.ts b/packages/zcli-core/src/lib/secureStore.ts
@@ -3,7 +3,7 @@ import * as path from 'path'
 import { homedir } from 'os'
 import { KeyTar } from '../types'
 
-// eslint-disable-next-line @typescript-eslint/no-var-requires
+// eslint-disable-next-line @typescript-eslint/no-require-imports
 const packageJson = require('../../package.json')
 
 export default class SecureStore {
@@ -21,22 +21,22 @@ export default class SecureStore {
     try {
       await plugins.createPJSON()
       await plugins.yarn.exec(['add', '--force', packageTag], { cwd: this.pluginsPath, verbose: false })
-    } catch (error) {
+    } catch (_error) {
       // TODO: add telemetry so we know when this fails
     }
   }
 
   async loadKeytar () {
     try {
-      // eslint-disable-next-line @typescript-eslint/no-var-requires
+      // eslint-disable-next-line @typescript-eslint/no-require-imports
       this.keytar = require(this.keytarPath) as KeyTar
-    } catch (error) {
+    } catch (_error) {
       await this.installKeytar()
 
       try {
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        // eslint-disable-next-line @typescript-eslint/no-require-imports
         this.keytar = require(this.keytarPath) as KeyTar
-      } catch (error) {
+      } catch (_error) {
         // TODO: add telemetry so we know when this fails
       }
     }
diff --git a/packages/zcli-themes/src/lib/getAssets.test.ts b/packages/zcli-themes/src/lib/getAssets.test.ts
@@ -23,7 +23,7 @@ describe('getAssets', () => {
       .withArgs('theme/path/assets')
       .returns(true)
 
-    readdirSyncStub.returns(['.gitkeep', 'foo.png', 'bar.png'] as any)
+    readdirSyncStub.returns(['.gitkeep', 'foo.png', 'bar.png'] as unknown as fs.Dirent[])
 
     const assets = getAssets('theme/path', flags)
 
@@ -47,7 +47,7 @@ describe('getAssets', () => {
       .withArgs('theme/path/assets')
       .returns(true)
 
-    readdirSyncStub.returns(['unsuported file name.png'] as any)
+    readdirSyncStub.returns(['unsuported file name.png'] as unknown as fs.Dirent[])
 
     expect(() => {
       getAssets('theme/path', flags)
diff --git a/packages/zcli-themes/src/lib/getManifest.ts b/packages/zcli-themes/src/lib/getManifest.ts
@@ -10,7 +10,7 @@ export default function getManifest (themePath: string): Manifest {
     const manifestFile = fs.readFileSync(manifestFilePath, 'utf8')
     try {
       return JSON.parse(manifestFile)
-    } catch (error) {
+    } catch (_error) {
       throw new CLIError(chalk.red(`manifest.json file was malformed at path: "${manifestFilePath}"`))
     }
   } else {
diff --git a/packages/zcli-themes/src/lib/getVariables.test.ts b/packages/zcli-themes/src/lib/getVariables.test.ts
@@ -31,7 +31,7 @@ describe('getVariables', () => {
       .withArgs('theme/path/settings')
       .returns(true)
 
-    readdirSyncStub.returns(['logo.png', 'favicon.png'] as any)
+    readdirSyncStub.returns(['logo.png', 'favicon.png'] as unknown as fs.Dirent[])
 
     expect(getVariables('theme/path', settings, flags)).to.deep.equal([
       { identifier: 'color', type: 'color', value: '#999' },
@@ -48,7 +48,7 @@ describe('getVariables', () => {
       .withArgs('theme/path/settings')
       .returns(true)
 
-    readdirSyncStub.returns(['logo.png'] as any)
+    readdirSyncStub.returns(['logo.png'] as unknown as fs.Dirent[])
 
     expect(() => {
       getVariables('theme/path', settings, flags)
diff --git a/packages/zcli-themes/src/lib/zass.ts b/packages/zcli-themes/src/lib/zass.ts
@@ -58,7 +58,7 @@ export default function zass (source: string, variables: Variable[], assets: [pa
       const value = compiled.substring(prefix.length, compiled.length - suffix.length)
 
       return value
-    } catch (e) {
+    } catch (_error) {
       // Do no exit but signal the error to the user while maintaining the source string
       error(`Could not process ${chalk.red(match)} in style.css`, { exit: false })
       return match
diff --git a/packages/zcli-themes/tests/functional/update.test.ts b/packages/zcli-themes/tests/functional/update.test.ts
@@ -149,7 +149,7 @@ describe('themes:update', function () {
           text: () => Promise.resolve('')
         })
       })
-      .it('should report validation errors', async (ctx) => {
+      .it('should report validation errors', async (_ctx) => {
         try {
           await UpdateCommand.run([baseThemePath, '--themeId', '1111'])
         } catch (error) {

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ export default class Clean extends Command {`
`25`	`25`	`try {`
`26`	`26`	`await cleanDirectory(tmpDirectoryPath)`
`27`	`27`	this.log(chalk.green(`Successfully removed ${tmpDirectoryPath} directory.`))
`28`		`- } catch (error) {`
	`28`	`+ } catch (_error) {`
`29`	`29`	this.error(chalk.red(`Failed to remove ${tmpDirectoryPath} directory.`))
`30`	`30`	`}`
`31`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ export const getLocationIcons = (appPath: string, manifestLocations: Location =`
`49`	`49`	`}, {})`
`50`	`50`	`}`
`51`	`51`
`52`		`-export const getInstallation = (appId: string, app: App, configFileContents: ZcliConfigFileContent, appSettings: Array<Record<string, any>>): Installation => {`
	`52`	`+export const getInstallation = (appId: string, app: App, configFileContents: ZcliConfigFileContent, appSettings: Array<Record<string, unknown>>): Installation => {`
`53`	`53`	`const installationId = configFileContents.installation_id \|\| uuidV4()`
`54`	`54`
`55`	`55`	`return {`
`@@ -73,20 +73,21 @@ const mergeLocationAndIcons = (locations: Location, locationIcons: LocationIcons`
`73`	`73`	`for (const locationName in locationIcons[product]) {`
`74`	`74`	`if (typeof (locations[product][locationName]) === 'string') {`
`75`	`75`	`locations[product][locationName] = {`
`76`		`- url: locations[product][locationName]`
	`76`	`+ url: locations[product][locationName] as string`
`77`	`77`	`}`
`78`	`78`	`}`
	`79`	`+`
`79`	`80`	`if (locationIcons[product][locationName].svg) {`
`80`		`- locations[product][locationName].svg = locationIcons[product][locationName].svg`
	`81`	`+ (locations[product][locationName] as { svg: string }).svg = locationIcons[product][locationName].svg`
`81`	`82`	`}`
`82`	`83`	`if (locationIcons[product][locationName].active) {`
`83`		`- locations[product][locationName].active = locationIcons[product][locationName].active`
	`84`	`+ (locations[product][locationName] as { active: string }).active = locationIcons[product][locationName].active`
`84`	`85`	`}`
`85`	`86`	`if (locationIcons[product][locationName].inactive) {`
`86`		`- locations[product][locationName].inactive = locationIcons[product][locationName].inactive`
	`87`	`+ (locations[product][locationName] as { inactive: string }).inactive = locationIcons[product][locationName].inactive`
`87`	`88`	`}`
`88`	`89`	`if (locationIcons[product][locationName].hover) {`
`89`		`- locations[product][locationName].hover = locationIcons[product][locationName].hover`
	`90`	`+ (locations[product][locationName] as { hover: string }).hover = locationIcons[product][locationName].hover`
`90`	`91`	`}`
`91`	`92`	`}`
`92`	`93`	`}`
`@@ -95,7 +96,7 @@ const mergeLocationAndIcons = (locations: Location, locationIcons: LocationIcons`
`95`	`96`	`for (const locationName in locations[product]) {`
`96`	`97`	`if (typeof (locations[product][locationName]) === 'string') {`
`97`	`98`	`locations[product][locationName] = {`
`98`		`- url: locations[product][locationName]`
	`99`	`+ url: locations[product][locationName] as string`
`99`	`100`	`}`
`100`	`101`	`}`
`101`	`102`	`}`
`@@ -122,8 +123,8 @@ export const getAppPayloadFromManifest = (appManifest: Manifest, port: number, a`
`122`	`123`	`return appPayload`
`123`	`124`	`}`
`124`	`125`
`125`		`-const getSettingsArr = (appSettings: any) => {`
`126`		`- const s: any[] = []`
	`126`	`+const getSettingsArr = (appSettings: Record<string, string>) => {`
	`127`	`+ const s: Record<string, string>[] = []`
`127`	`128`	`Object.keys(appSettings).forEach((settingName: string) => {`
`128`	`129`	`const setting: Record<string, string> = {}`
`129`	`130`	`setting[settingName] = appSettings[settingName]`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ export const getAllConfigs = (appPath: string, configFileName: string = DEFAULT_`
`13`	`13`	`const zcliConfigFile = fs.readFileSync(configFilePath, 'utf8')`
`14`	`14`	`try {`
`15`	`15`	`return JSON.parse(zcliConfigFile)`
`16`		`- } catch (error) {`
	`16`	`+ } catch (_error) {`
`17`	`17`	throw new CLIError(chalk.red(`zcli configuration file was malformed at path: ${configFilePath}`))
`18`	`18`	`}`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ export const getManifestAppName = (appPath: string): string \| undefined => {`
`11`	`11`	`return getManifestFile(appPath).name`
`12`	`12`	`}`
`13`	`13`
`14`		`-export const uploadAppPkg = async (pkgPath: string): Promise<any> => {`
	`14`	`+export const uploadAppPkg = async (pkgPath: string): Promise<{ id: number }> => {`
`15`	`15`	`const pkgBuffer = await fs.readFile(pkgPath)`
`16`	`16`
`17`	`17`	`const formData = new FormData()`
`@@ -63,7 +63,7 @@ export const deployApp = async (method: string, url: string, upload_id: number,`
`63`	`63`	`return installationResponse.data`
`64`	`64`	`}`
`65`	`65`
`66`		`-export const createProductInstallation = async (settings: any, manifest: Manifest, app_id: string, product: string): Promise<boolean> => {`
	`66`	`+export const createProductInstallation = async (settings: Record<string, unknown>, manifest: Manifest, app_id: string, product: string): Promise<boolean> => {`
`67`	`67`	const installResponse = await request.requestAPI(`api/${product}/apps/installations.json`, {
`68`	`68`	`method: 'POST',`
`69`	`69`	data: JSON.stringify({ app_id: `${app_id}`, settings: { name: manifest.name, ...settings } }),