chore: lint more packages with types (#14516)

jestjs · Sep 13, 2023 · b522b03 · b522b03
1 parent be7e797
commit b522b03
Show file tree

Hide file tree

Showing 13 changed files with 239 additions and 390 deletions.
diff --git a/packages/jest-diff/src/getAlignedDiffs.ts b/packages/jest-diff/src/getAlignedDiffs.ts
@@ -31,8 +31,8 @@ const concatenateRelevantDiffs = (
 // Encapsulate change lines until either a common newline or the end.
 class ChangeBuffer {
   private readonly op: number;
-  private line: Array<Diff>; // incomplete line
-  private lines: Array<Diff>; // complete lines
+  private readonly line: Array<Diff>; // incomplete line
+  private readonly lines: Array<Diff>; // complete lines
   private readonly changeColor: DiffOptionsColor;
 
   constructor(op: number, changeColor: DiffOptionsColor) {

diff --git a/packages/jest-environment-jsdom/src/index.ts b/packages/jest-environment-jsdom/src/index.ts
@@ -38,7 +38,7 @@ export default class JSDOMEnvironment implements JestEnvironment<number> {
   private errorEventListener: ((event: Event & {error: Error}) => void) | null;
   moduleMocker: ModuleMocker | null;
   customExportConditions = ['browser'];
-  private _configuredExportConditions?: Array<string>;
+  private readonly _configuredExportConditions?: Array<string>;
 
   constructor(config: JestEnvironmentConfig, context: EnvironmentContext) {
     const {projectConfig} = config;

diff --git a/packages/jest-environment-node/src/index.ts b/packages/jest-environment-node/src/index.ts
@@ -67,7 +67,7 @@ export default class NodeEnvironment implements JestEnvironment<Timer> {
   global: Global.Global;
   moduleMocker: ModuleMocker | null;
   customExportConditions = ['node', 'node-addons'];
-  private _configuredExportConditions?: Array<string>;
+  private readonly _configuredExportConditions?: Array<string>;
 
   // while `context` is unused, it should always be passed
   constructor(config: JestEnvironmentConfig, _context: EnvironmentContext) {

diff --git a/packages/jest-fake-timers/src/legacyFakeTimers.ts b/packages/jest-fake-timers/src/legacyFakeTimers.ts
@@ -70,7 +70,7 @@ export default class FakeTimers<TimerRef = unknown> {
   private _disposed: boolean;
   private _fakeTimerAPIs!: FakeTimerAPI;
   private _fakingTime = false;
-  private _global: typeof globalThis;
+  private readonly _global: typeof globalThis;
   private _immediates!: Array<Tick>;
   private readonly _maxLoops: number;
   private readonly _moduleMocker: ModuleMocker;

diff --git a/packages/jest-haste-map/src/index.ts b/packages/jest-haste-map/src/index.ts
@@ -215,7 +215,7 @@ class HasteMap extends EventEmitter implements IHasteMap {
   private _changeInterval?: ReturnType<typeof setInterval>;
   private readonly _console: Console;
   private _isWatchmanInstalledPromise: Promise<boolean> | null = null;
-  private _options: InternalOptions;
+  private readonly _options: InternalOptions;
   private _watchers: Array<Watcher> = [];
   private _worker: JestWorkerFarm<HasteWorker> | HasteWorker | null = null;
 

diff --git a/packages/jest-jasmine2/src/jasmine/Env.ts b/packages/jest-jasmine2/src/jasmine/Env.ts
@@ -688,9 +688,9 @@ export default function jasmineEnv(j$: Jasmine) {
           const check = isError(error);
 
           checkIsError = check.isError;
-          message = check.message;
+          message = check.message || undefined;
         }
-        const errorAsErrorObject = checkIsError ? error : new Error(message!);
+        const errorAsErrorObject = checkIsError ? error : new Error(message);
         const runnable = currentRunnable();
 
         if (!runnable) {

diff --git a/packages/jest-reporters/src/NotifyReporter.ts b/packages/jest-reporters/src/NotifyReporter.ts
@@ -21,7 +21,7 @@ const icon = path.resolve(__dirname, '../assets/jest_logo.png');
 export default class NotifyReporter extends BaseReporter {
   private readonly _notifier = loadNotifier();
   private readonly _globalConfig: Config.GlobalConfig;
-  private _context: ReporterContext;
+  private readonly _context: ReporterContext;
 
   static readonly filename = __filename;
 

diff --git a/packages/jest-reporters/src/__tests__/GitHubActionsReporter.test.ts b/packages/jest-reporters/src/__tests__/GitHubActionsReporter.test.ts
@@ -90,7 +90,7 @@ describe('annotations', () => {
 
   describe('logs error annotation', () => {
     test('when an expectation fails to pass', () => {
-      reporter['generateAnnotations'](testMeta, {
+      reporter.generateAnnotations(testMeta, {
         testResults: [
           {
             ...testCaseResult,
@@ -104,7 +104,7 @@ describe('annotations', () => {
     });
 
     test('when a test has reference error', () => {
-      reporter['generateAnnotations'](
+      reporter.generateAnnotations(
         {...testMeta, path: '/user/project/__tests__/example.test.js:25:12'},
         {
           testResults: [
@@ -121,7 +121,7 @@ describe('annotations', () => {
     });
 
     test('when test is wrapped in describe block', () => {
-      reporter['generateAnnotations'](testMeta, {
+      reporter.generateAnnotations(testMeta, {
         testResults: [
           {
             ...testCaseResult,
@@ -137,7 +137,7 @@ describe('annotations', () => {
 
   describe('logs warning annotation before logging errors', () => {
     test('when test result includes retry reasons', () => {
-      reporter['generateAnnotations'](testMeta, {
+      reporter.generateAnnotations(testMeta, {
         testResults: [
           {
             ...testCaseResult,
@@ -198,7 +198,7 @@ describe('logs', () => {
         silent: false,
       });
 
-      const generated = gha['getResultTree'](testResults, '/', suitePerf);
+      const generated = gha.getResultTree(testResults, '/', suitePerf);
 
       expect(mockedStderrWrite).not.toHaveBeenCalled();
       expect(generated).toEqual(expectedResults);
@@ -241,7 +241,7 @@ describe('logs', () => {
         silent: false,
       });
 
-      const generated = gha['getResultTree'](testResults, '/', suitePerf);
+      const generated = gha.getResultTree(testResults, '/', suitePerf);
 
       expect(mockedStderrWrite).not.toHaveBeenCalled();
       expect(generated).toEqual(expectedResults);
@@ -290,7 +290,7 @@ describe('logs', () => {
         silent: false,
       });
 
-      const generated = gha['getResultTree'](testResults, '/', suitePerf);
+      const generated = gha.getResultTree(testResults, '/', suitePerf);
 
       expect(mockedStderrWrite).not.toHaveBeenCalled();
       expect(generated).toEqual(expectedResults);
@@ -339,7 +339,7 @@ describe('logs', () => {
         silent: false,
       });
 
-      const generated = gha['getResultTree'](testResults, '/', suitePerf);
+      const generated = gha.getResultTree(testResults, '/', suitePerf);
 
       expect(mockedStderrWrite).not.toHaveBeenCalled();
       expect(generated).toEqual(expectedResults);
@@ -400,7 +400,7 @@ describe('logs', () => {
         silent: false,
       });
 
-      const generated = gha['getResultTree'](testResults, '/', suitePerf);
+      const generated = gha.getResultTree(testResults, '/', suitePerf);
 
       expect(mockedStderrWrite).not.toHaveBeenCalled();
       expect(generated).toEqual(expectedResults);
@@ -431,7 +431,7 @@ describe('logs', () => {
         silent: false,
       });
 
-      gha['printResultTree'](generatedTree);
+      gha.printResultTree(generatedTree);
 
       expect(mockedStderrWrite.mock.calls).toMatchSnapshot();
     });
@@ -459,7 +459,7 @@ describe('logs', () => {
         silent: false,
       });
 
-      gha['printResultTree'](generatedTree);
+      gha.printResultTree(generatedTree);
 
       expect(mockedStderrWrite.mock.calls).toMatchSnapshot();
     });
@@ -493,7 +493,7 @@ describe('logs', () => {
         silent: false,
       });
 
-      gha['printResultTree'](generatedTree);
+      gha.printResultTree(generatedTree);
 
       expect(mockedStderrWrite.mock.calls).toMatchSnapshot();
     });
@@ -527,7 +527,7 @@ describe('logs', () => {
         silent: false,
       });
 
-      gha['printResultTree'](generatedTree);
+      gha.printResultTree(generatedTree);
 
       expect(mockedStderrWrite.mock.calls).toMatchSnapshot();
     });
@@ -561,7 +561,7 @@ describe('logs', () => {
         silent: false,
       });
 
-      gha['printResultTree'](generatedTree);
+      gha.printResultTree(generatedTree);
 
       expect(mockedStderrWrite.mock.calls).toMatchSnapshot();
     });
@@ -595,7 +595,7 @@ describe('logs', () => {
         silent: false,
       });
 
-      gha['printResultTree'](generatedTree);
+      gha.printResultTree(generatedTree);
 
       expect(mockedStderrWrite.mock.calls).toMatchSnapshot();
     });
@@ -633,7 +633,7 @@ describe('logs', () => {
       const gha = new GitHubActionsReporter({} as Config.GlobalConfig, {
         silent: false,
       });
-      gha['generateAnnotations'] = jest.fn();
+      gha.generateAnnotations = jest.fn();
 
       gha.onTestResult(
         mockTest as Test,
@@ -677,7 +677,7 @@ describe('logs', () => {
       const gha = new GitHubActionsReporter({} as Config.GlobalConfig, {
         silent: false,
       });
-      gha['generateAnnotations'] = jest.fn();
+      gha.generateAnnotations = jest.fn();
 
       gha.onTestResult(
         mockTest as Test,

diff --git a/packages/jest-worker/src/workers/__tests__/ChildProcessWorker.test.ts b/packages/jest-worker/src/workers/__tests__/ChildProcessWorker.test.ts
@@ -159,8 +159,8 @@ it('provides stdout and stderr from the child processes', async () => {
     workerPath: '/tmp/foo',
   } as WorkerOptions);
 
-  const stdout = worker.getStdout() as NodeJS.ReadableStream;
-  const stderr = worker.getStderr() as NodeJS.ReadableStream;
+  const stdout = worker.getStdout()!;
+  const stderr = worker.getStderr()!;
 
   (forkInterface.stdout as PassThrough).end('Hello ', 'utf8');
   (forkInterface.stderr as PassThrough).end('Jest ', 'utf8');

diff --git a/packages/jest-worker/src/workers/__tests__/WorkerEdgeCases.test.ts b/packages/jest-worker/src/workers/__tests__/WorkerEdgeCases.test.ts
@@ -52,7 +52,7 @@ afterAll(async () => {
 test.each(filesToBuild)('%s.js should exist', file => {
   const path = join(writeDestination, `${file}.js`);
 
-  expect(async () => await access(path)).not.toThrow();
+  expect(async () => access(path)).not.toThrow();
 });
 
 async function closeWorkerAfter(
@@ -310,9 +310,9 @@ describe.each([
     });
 
     test('worker stays dead', async () => {
-      await expect(
-        async () => await worker.waitForWorkerReady(),
-      ).rejects.toThrow('Worker state means it will never be ready: shut-down');
+      await expect(async () => worker.waitForWorkerReady()).rejects.toThrow(
+        'Worker state means it will never be ready: shut-down',
+      );
       expect(worker.isWorkerRunning()).toBeFalsy();
     });
 

diff --git a/packages/jest-worker/src/workers/__tests__/threadChild.test.ts b/packages/jest-worker/src/workers/__tests__/threadChild.test.ts
@@ -114,7 +114,7 @@ beforeEach(() => {
   );
 
   messagePort = (require('worker_threads') as typeof import('worker_threads'))
-    .parentPort as MessagePort;
+    .parentPort!;
 
   // Require the child!
   require('../threadChild');

diff --git a/scripts/lintTs.mjs b/scripts/lintTs.mjs
@@ -28,32 +28,46 @@ const fix = process.argv.slice(2).some(arg => arg === '--fix');
 const monorepoRoot = path.resolve(url.fileURLToPath(import.meta.url), '../..');
 
 // TODO: remove this list at some point and run against all packages
-const packagesToTest = [
-  'babel-jest',
-  'babel-plugin-jest-hoist',
-  'diff-sequences',
-  'jest',
-  'jest-changed-files',
-  'jest-console',
-  'jest-docblock',
-  'jest-environment',
-  'jest-globals',
-  'jest-resolve-dependencies',
-  'jest-schemas',
-  'jest-source-map',
-  'jest-test-result',
-  'jest-test-sequencer',
-  'jest-transform',
-  'jest-types',
-  'jest-watcher',
-  'test-globals',
-  'test-utils',
+const packagesNotToTest = [
+  'expect',
+  'expect-utils',
+  'jest-circus',
+  'jest-cli',
+  'jest-config',
+  'jest-core',
+  'jest-create-cache-key-function',
+  'jest-diff',
+  'jest-each',
+  'jest-environment-jsdom',
+  'jest-environment-node',
+  'jest-fake-timers',
+  'jest-get-type',
+  'jest-haste-map',
+  'jest-jasmine2',
+  'jest-leak-detector',
+  'jest-matcher-utils',
+  'jest-message-util',
+  'jest-mock',
+  'jest-phabricator',
+  'jest-regex-util',
+  'jest-repl',
+  'jest-reporters',
+  'jest-resolve',
+  'jest-runner',
+  'jest-runtime',
+  'jest-snapshot',
+  'jest-util',
+  'jest-validate',
+  'jest-worker',
+  'pretty-format',
 ];
 
 const packagesWithTs = getPackagesWithTsConfig()
   .map(({packageDir}) => packageDir)
-  .concat(path.resolve(monorepoRoot, 'e2e'))
-  .filter(packageDir => packagesToTest.some(pkg => packageDir.endsWith(pkg)));
+  .filter(
+    packageDir => !packagesNotToTest.some(pkg => packageDir.endsWith(pkg)),
+  );
+// .concat(path.resolve(monorepoRoot, 'e2e'));
 
 const allLintResults = [];