ref(eslint): Set @typescript-eslint/no-unsafe-member-access rule to error (#892)

---------

Co-authored-by: Lukas Stracke <[email protected]>

Author: andreiborza

.eslintrc.js

@@ -58,7 +58,7 @@ module.exports = {
     '@typescript-eslint/ban-ts-comment': 'error',
     '@typescript-eslint/no-unsafe-call': 'error',
     '@typescript-eslint/restrict-template-expressions': 'error',
-    '@typescript-eslint/no-unsafe-member-access': 'warn',
+    '@typescript-eslint/no-unsafe-member-access': 'error',
     '@typescript-eslint/no-unsafe-assignment': 'warn',
     '@typescript-eslint/no-unsafe-argument': 'warn',
     '@typescript-eslint/no-unsafe-return': 'error',

lib/Helper/Package.ts

@@ -2,11 +2,13 @@ import { satisfies, subset, valid, validRange } from 'semver';
 
 import { green, red } from './Logging';
 
+type PackageDotJson = {
+  dependencies?: Record<string, string>;
+  devDependencies?: Record<string, string>;
+};
+
 export function checkPackageVersion(
-  appPackage: {
-    dependencies?: Record<string, string>;
-    devDependencies?: Record<string, string>;
-  },
+  appPackage: PackageDotJson,
   packageName: string,
   acceptableVersions: string,
   canBeLatest: boolean,
@@ -71,10 +73,10 @@ function fulfillsVersionRange(
  * @returns `true` if the package is installed, `false` otherwise
  */
 export function hasPackageInstalled(
-  appPackage: Record<string, any>,
+  appPackage: PackageDotJson,
   packageName: string,
 ): boolean {
-  const depsVersion = appPackage.dependencies[packageName];
-  const devDepsVersion = appPackage.devDependencies[packageName];
+  const depsVersion = appPackage.dependencies?.[packageName];
+  const devDepsVersion = appPackage.devDependencies?.[packageName];
   return !!depsVersion || !!devDepsVersion;
 }

lib/Helper/SentryCli.ts

@@ -5,33 +5,42 @@ import * as path from 'node:path';
 import type { Args } from '../Constants';
 import { addToGitignore } from './Git';
 import { green, l, nl, red } from './Logging';
+import { Config } from '../Types';
 
 const SENTRYCLIRC_FILENAME = '.sentryclirc';
 const GITIGNORE_FILENAME = '.gitignore';
 const PROPERTIES_FILENAME = 'sentry.properties';
 
 export interface SentryCliProps {
-  [s: string]: string;
+  'defaults/url': string;
+  'defaults/org': string | null;
+  'defaults/project': string | null;
+  'auth/token': string | null;
+  'cli/executable'?: string;
 }
 
-type SentryCliConfig = Record<string, SentryCliProps>;
+type SentryCliConfig = Record<string, Partial<SentryCliProps>>;
+type RequireResolve = typeof require.resolve;
 
 export class SentryCli {
-  // eslint-disable-next-line @typescript-eslint/typedef
-  private _resolve = require.resolve;
+  private _resolve: RequireResolve = require.resolve;
 
   public constructor(protected _argv: Args) {}
 
-  public setResolveFunction(resolve: (path: string) => string): void {
-    this._resolve = resolve as any;
+  public setResolveFunction(resolve: RequireResolve): void {
+    this._resolve = resolve;
   }
 
-  public convertAnswersToProperties(answers: Answers): SentryCliProps {
-    const props: SentryCliProps = {};
-    props['defaults/url'] = this._argv.url;
-    props['defaults/org'] = answers.config?.organization?.slug ?? null;
-    props['defaults/project'] = answers.config?.project?.slug ?? null;
-    props['auth/token'] = answers.config?.auth?.token ?? null;
+  public convertAnswersToProperties(
+    answers: Answers & { config?: Config },
+  ): SentryCliProps {
+    const props: SentryCliProps = {
+      'defaults/url': this._argv.url,
+      'defaults/org': answers.config?.organization?.slug ?? null,
+      'defaults/project': answers.config?.project?.slug ?? null,
+      'auth/token': answers.config?.auth?.token ?? null,
+    };
+
     try {
       const cliPath = this._resolve('@sentry/cli/bin/sentry-cli', {
         paths: [process.cwd()],
@@ -45,11 +54,26 @@ export class SentryCli {
     return props;
   }
 
-  /** Create the contents of a `sentry.properties` file */
-  public dumpProperties(props: SentryCliProps): string {
-    const rv = [];
-    for (const [key, value] of Object.entries(props)) {
-      const normalizedKey = key.replace(/\//g, '.');
+  /**
+   * Create the contents of a `sentry.properties` file
+   * @param props the properties to write to the file
+   * @param format the format of the file, either `rc`
+   *  (.sentryclirc) or `properties` (sentry.properties)
+   */
+  public dumpProperties(
+    props: Partial<SentryCliProps>,
+    format: 'rc' | 'properties' = 'properties',
+  ): string {
+    const propEntries = Object.entries(props) as [
+      keyof SentryCliProps,
+      SentryCliProps[keyof SentryCliProps],
+    ][];
+    const rv: string[] = [];
+    for (const [key, value] of propEntries) {
+      const normalizedKey =
+        format === 'properties'
+          ? key.replace(/\//g, '.')
+          : key.split('/').at(1) ?? '';
       if (value === undefined || value === null) {
         // comment that property out since it has no value
         rv.push(`#${normalizedKey}=`);
@@ -61,10 +85,10 @@ export class SentryCli {
     return rv.join('\n') + '\n';
   }
 
-  public dumpConfig(config: SentryCliConfig): string {
+  public dumpConfig(config: Partial<SentryCliConfig>): string {
     const dumpedSections: string[] = [];
-    for (const [sectionName, val] of Object.entries(config)) {
-      const props = this.dumpProperties(val);
+    for (const [sectionName, values] of Object.entries(config)) {
+      const props = values ? this.dumpProperties(values, 'rc') : '';
       const section = `[${sectionName}]\n${props}`;
       dumpedSections.push(section);
     }
@@ -94,7 +118,7 @@ export class SentryCli {
       try {
         await fs.promises.appendFile(
           SENTRYCLIRC_FILENAME,
-          this.dumpConfig({ auth: { token: authToken } }),
+          this.dumpConfig({ auth: { 'auth/token': authToken } }),
         );
         green(`✓ Successfully added the auth token to ${SENTRYCLIRC_FILENAME}`);
       } catch {

lib/Helper/Wizard.ts

@@ -51,11 +51,11 @@ export async function startWizard<M extends IStep>(
         const answers = await step.emit(prevAnswer);
         return { ...prevAnswer, ...answers };
       }, Promise.resolve({}));
-  } catch (e) {
+  } catch (e: unknown) {
     BottomBar.hide();
     nl();
     red('Sentry Wizard failed with:');
-    red(argv.debug ? e : e.message);
+    red(argv.debug && e instanceof Error ? e.message : String(e));
     nl();
     red('Protip: Add --debug to see whats going on');
     red('OR use --help to see your options');

lib/Helper/__tests__/SentryCli.ts

@@ -5,6 +5,8 @@ import type { Args } from '../../Constants';
 import { Integration, Platform } from '../../Constants';
 import { SentryCli } from '../SentryCli';
 
+type RequireResolve = typeof require.resolve;
+
 const args: Args = {
   debug: false,
   integration: Integration.reactNative,
@@ -32,8 +34,10 @@ const demoAnswers: Answers = {
 };
 
 describe('SentryCli', () => {
+  const resolveFunc = jest
+    .fn()
+    .mockReturnValue('node_modules/sentry/cli') as unknown as RequireResolve;
   test('convertAnswersToProperties', () => {
-    const resolveFunc = jest.fn().mockReturnValue('node_modules/sentry/cli');
     const sentry = new SentryCli(args);
     sentry.setResolveFunction(resolveFunc);
     const props = sentry.convertAnswersToProperties(demoAnswers);
@@ -45,7 +49,6 @@ describe('SentryCli', () => {
   });
 
   test('dump properties', () => {
-    const resolveFunc = jest.fn().mockReturnValue('node_modules/sentry/cli');
     const sentry = new SentryCli(args);
     sentry.setResolveFunction(resolveFunc);
     const props = sentry.convertAnswersToProperties(demoAnswers);
@@ -58,8 +61,25 @@ cli.executable=node_modules/sentry/cli
 `);
   });
 
+  test('dump config', () => {
+    const sentry = new SentryCli(args);
+    sentry.setResolveFunction(resolveFunc);
+    const props = {
+      auth: { 'auth/token': 'myToken' },
+    };
+    expect(sentry.dumpConfig(props)).toMatchInlineSnapshot(`
+      "[auth]
+      token=myToken
+      "
+    `);
+  });
+
   test('convertAnswersToProperties windows', () => {
-    const resolveFunc = jest.fn().mockReturnValue('node_modules\\sentry\\cli');
+    const resolveFunc = jest
+      .fn()
+      .mockReturnValue(
+        'node_modules\\sentry\\cli',
+      ) as unknown as RequireResolve;
     const sentry = new SentryCli(args);
     sentry.setResolveFunction(resolveFunc);
     const props = sentry.convertAnswersToProperties(demoAnswers);
@@ -71,7 +91,11 @@ cli.executable=node_modules/sentry/cli
   });
 
   test('dump properties windows', () => {
-    const resolveFunc = jest.fn().mockReturnValue('node_modules\\sentry\\cli');
+    const resolveFunc = jest
+      .fn()
+      .mockReturnValue(
+        'node_modules\\sentry\\cli',
+      ) as unknown as RequireResolve;
     const sentry = new SentryCli(args);
     sentry.setResolveFunction(resolveFunc);
     const props = sentry.convertAnswersToProperties(demoAnswers);

lib/Setup.ts

@@ -1,4 +1,6 @@
+import { Answers } from 'inquirer';
 import { enableDebugLogs } from '../src/utils/debug';
+import { Args } from './Constants';
 
 import { readEnvironment } from './Helper/Env';
 import { startWizard } from './Helper/Wizard';
@@ -10,7 +12,7 @@ import * as Step from './Steps';
  * Therefor, do not call this function anymore.
  * Use `run` from {@link ../src/run.ts} instead.
  */
-export async function run(argv: any): Promise<any> {
+export async function run(argv: Args): Promise<Answers> {
   const args = { ...argv, ...readEnvironment() };
 
   if (argv.debug) {

lib/Steps/Integrations/Electron.ts

@@ -7,6 +7,7 @@ import type { Args } from '../../Constants';
 import { dim, green, l, nl, red } from '../../Helper/Logging';
 import { SentryCli } from '../../Helper/SentryCli';
 import { BaseIntegration } from './BaseIntegration';
+import { Config } from '../../Types';
 
 const MIN_ELECTRON_VERSION_STRING = '23.0.0';
 const MIN_ELECTRON_VERSION = parseInt(
@@ -63,8 +64,8 @@ export class Electron extends BaseIntegration {
   }
 
   // eslint-disable-next-line @typescript-eslint/require-await
-  public async emit(answers: Answers): Promise<Answers> {
-    const dsn = answers.config?.dsn?.public ?? null;
+  public async emit(answers: Answers & { config?: Config }): Promise<Answers> {
+    const dsn = answers.config?.dsn?.public ?? 'DSN NOT FOUND';
     nl();
 
     const sentryCliProps = this._sentryCli.convertAnswersToProperties(answers);

lib/Steps/PromptForParameters.ts

@@ -4,13 +4,7 @@ import { prompt } from 'inquirer';
 import { dim } from '../Helper/Logging';
 import { getCurrentIntegration } from '../Helper/Wizard';
 import { BaseStep } from './BaseStep';
-
-type Config = {
-  organization?: { slug?: string };
-  project?: { slug?: string };
-  dsn?: { public?: string };
-  auth?: { token?: string };
-};
+import { Config } from '../Types';
 
 export class PromptForParameters extends BaseStep {
   public async emit(

lib/Types.ts

@@ -0,0 +1,6 @@
+export type Config = {
+  organization?: { slug?: string };
+  project?: { slug?: string };
+  dsn?: { public?: string };
+  auth?: { token?: string };
+};

src/nuxt/utils.ts

@@ -22,6 +22,8 @@ export async function isNuxtV4(
   // major yet. We must read the `compatibilityVersion`
   // from the nuxt config.
   try {
+    // Magicast is hard to type correctly so we disable these rules
+    /* eslint-disable @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-assignment */
     const mod = await loadFile(nuxtConfig);
     const config =
       mod.exports.default.$type === 'function-call'
@@ -31,6 +33,7 @@ export async function isNuxtV4(
     if (config && config.future && config.future.compatibilityVersion === 4) {
       return true;
     }
+    /* eslint-enable @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-assignment */
   } catch {
     // If we cannot parse their config, just ask.
     return await abortIfCancelled(