refactor: cosmetics and formatting

Author: Xunnamius

.all-contributorsrc

@@ -229,4 +229,3 @@
   ],
   "commitConvention": "angular"
 }
-

.remarkrc.mjs

@@ -5,7 +5,7 @@
  */
 
 /**
- * Remark configuration loaded when `NODE_ENV == 'lint'`. The goal here is to
+ * Remark configuration loaded when `NODE_ENV === 'lint'`. The goal here is to
  * check for things that will not be corrected by prettier or remark during a
  * formatting pass (see below).
  *
@@ -54,7 +54,7 @@ const lintConfig = {
 };
 
 /**
- * Remark configuration loaded when `NODE_ENV == 'format'`. The goal here is to
+ * Remark configuration loaded when `NODE_ENV === 'format'`. The goal here is to
  * correct things that will not be taken care of by prettier.
  *
  * @type {Config}
@@ -89,9 +89,9 @@ export default {
     rule: '-',
     strong: '*',
     tightDefinitions: true,
-    ...(process.env.NODE_ENV == 'lint' ? lintConfig.settings : formatConfig.settings)
+    ...(process.env.NODE_ENV === 'lint' ? lintConfig.settings : formatConfig.settings)
   },
   plugins: [
-    ...(process.env.NODE_ENV == 'lint' ? lintConfig.plugins : formatConfig.plugins)
+    ...(process.env.NODE_ENV === 'lint' ? lintConfig.plugins : formatConfig.plugins)
   ]
 };

babel.config.js

@@ -28,7 +28,7 @@ module.exports = {
         'explicit-exports-references'
       ]
     },
-    // * Used when NODE_ENV == production (usually for generating types w/ tsc)
+    // * Used when NODE_ENV === production (usually for generating types w/ tsc)
     production: {
       presets: [
         [

jest.config.js

@@ -14,9 +14,9 @@ module.exports = {
     60 *
     (process.env.VSCODE_INSPECTOR_OPTIONS
       ? 60 * 24
-      : process.platform == 'win32'
-      ? 5
-      : 1),
+      : process.platform === 'win32'
+        ? 5
+        : 1),
   // ? Minimum of 2 concurrent tests executed at once; maximum of cpu cores - 1
   maxConcurrency: Math.max(require('node:os').cpus().length - 1, 2),
   verbose: false,

src/errors.ts

@@ -80,7 +80,7 @@ export const ErrorMessage = {
       | Pick<PluginTesterTestFixtureConfig, typeof $type | 'fixtureOutputBasename'>
   ) => {
     return `actual output does not match ${
-      testConfig[$type] == 'fixture-object'
+      testConfig[$type] === 'fixture-object'
         ? testConfig.fixtureOutputBasename
         : 'expected output'
     }`;
@@ -103,29 +103,29 @@ export const ErrorMessage = {
   InvalidHasThrowsAndOutput: (
     testConfig: Pick<MaybePluginTesterTestConfig, typeof $type>
   ) => {
-    return testConfig[$type] == 'test-object'
+    return testConfig[$type] === 'test-object'
       ? 'neither `output` nor `outputFixture` can be provided with `throws` or `error`'
       : 'a fixture cannot be provided with `throws` or `error` and also contain an output file';
   },
   InvalidHasThrowsAndExec: (
     testConfig: Pick<MaybePluginTesterTestConfig, typeof $type>
   ) => {
-    return testConfig[$type] == 'test-object'
+    return testConfig[$type] === 'test-object'
       ? 'neither `exec` nor `execFixture` can be provided with `throws` or `error`'
       : 'a fixture cannot be provided with `throws` or `error` and also contain an exec file';
   },
   InvalidMissingCodeOrExec: (
     testConfig: Pick<MaybePluginTesterTestConfig, typeof $type>
   ) => {
     /* istanbul ignore next */
-    return testConfig[$type] == 'test-object'
+    return testConfig[$type] === 'test-object'
       ? 'a string or object with a `code`, `codeFixture`, `fixture`, `exec`, or `execFixture` must be provided'
       : 'a fixture must contain either a code file or an exec file';
   },
   InvalidHasExecAndCodeOrOutput: (
     testConfig: Pick<MaybePluginTesterTestConfig, typeof $type>
   ) => {
-    return testConfig[$type] == 'test-object'
+    return testConfig[$type] === 'test-object'
       ? 'neither `code`, `codeFixture`, `fixture`, `output`, nor `outputFixture` can be provided with `exec` or `execFixture`'
       : 'a fixture cannot contain both an exec file and a code or output file';
   },

src/index.ts

@@ -13,7 +13,7 @@ import type { PluginTesterOptions } from './types';
 
 const debug = debugFactory('babel-plugin-tester:index');
 
-if ('expect' in globalThis && typeof expect?.addSnapshotSerializer == 'function') {
+if ('expect' in globalThis && typeof expect?.addSnapshotSerializer === 'function') {
   debug(
     'added unstring snapshot serializer globally; all snapshots after this point will be affected'
   );

src/plugin-tester.ts

@@ -115,16 +115,16 @@ function restartTestTitleNumbering() {
 function pluginTester(options: PluginTesterOptions = {}) {
   debug1('executing main babel-plugin-tester function');
 
-  const globalContextHasExpectFn = 'expect' in globalThis && typeof expect == 'function';
-  const globalContextHasTestFn = 'it' in globalThis && typeof it == 'function';
+  const globalContextHasExpectFn = 'expect' in globalThis && typeof expect === 'function';
+  const globalContextHasTestFn = 'it' in globalThis && typeof it === 'function';
 
   const globalContextHasDescribeFn =
-    'describe' in globalThis && typeof describe == 'function';
+    'describe' in globalThis && typeof describe === 'function';
 
   const globalContextExpectFnHasToMatchSnapshot = (() => {
     try {
       return globalContextHasExpectFn
-        ? typeof expect(undefined)?.toMatchSnapshot == 'function'
+        ? typeof expect(undefined)?.toMatchSnapshot === 'function'
         : false;
     } catch {
       /* istanbul ignore next */
@@ -133,11 +133,11 @@ function pluginTester(options: PluginTesterOptions = {}) {
   })();
 
   const globalContextTestFnHasSkip = globalContextHasTestFn
-    ? typeof it.skip == 'function'
+    ? typeof it.skip === 'function'
     : false;
 
   const globalContextTestFnHasOnly = globalContextHasTestFn
-    ? typeof it.only == 'function'
+    ? typeof it.only === 'function'
     : false;
 
   if (!globalContextHasDescribeFn) {
@@ -253,7 +253,7 @@ function pluginTester(options: PluginTesterOptions = {}) {
             throw new TypeError(ErrorMessage.BadConfigInvalidTestsArrayItemType(ndx));
           }
 
-          const result = typeof test == 'string' || Boolean(test);
+          const result = typeof test === 'string' || Boolean(test);
 
           if (!result) {
             debug2(`test item \`%O\` at index ${ndx} was skipped`, test);
@@ -275,7 +275,7 @@ function pluginTester(options: PluginTesterOptions = {}) {
               );
             }
 
-            const result = typeof test == 'string' || Boolean(test);
+            const result = typeof test === 'string' || Boolean(test);
 
             if (!result) {
               debug2(`test property "${title}" with value \`%O\` was skipped`, test);
@@ -369,7 +369,7 @@ function pluginTester(options: PluginTesterOptions = {}) {
                     functionName,
                     // ? Just in case the script name/path has colons
                     filePath: filePath
-                      .split(`file://${process.platform == 'win32' ? '/' : ''}`)
+                      .split(`file://${process.platform === 'win32' ? '/' : ''}`)
                       .at(-1)!
                       .split(':')
                       .slice(0, -2)
@@ -406,19 +406,19 @@ function pluginTester(options: PluginTesterOptions = {}) {
         return [
           reversedCallStack.findIndex(({ functionName, filePath }) => {
             return (
-              functionName == 'defaultPluginTester' &&
+              functionName === 'defaultPluginTester' &&
               parseScriptFilepathRegExp.test(filePath)
             );
           }),
           reversedCallStack.findIndex(({ functionName, filePath }) => {
             return (
-              functionName == 'pluginTester' &&
+              functionName === 'pluginTester' &&
               /* istanbul ignore next */ parseScriptFilepathRegExp.test(filePath)
             );
           }),
           reversedCallStack.findIndex(({ functionName, filePath }) => {
             return (
-              functionName == 'resolveBaseConfig' &&
+              functionName === 'resolveBaseConfig' &&
               parseScriptFilepathRegExp.test(filePath)
             );
           })
@@ -469,7 +469,7 @@ function pluginTester(options: PluginTesterOptions = {}) {
                 throw new TypeError(
                   ErrorMessage.BadEnvironmentVariableRange(name, s, range)
                 );
-              } else if (start == end) {
+              } else if (start === end) {
                 return start;
               }
 
@@ -494,10 +494,11 @@ function pluginTester(options: PluginTesterOptions = {}) {
     const testConfigs: PluginTesterTestConfig[] = [];
 
     const useFixtureTitleNumbering =
-      baseConfig.titleNumbering == 'all' || baseConfig.titleNumbering == 'fixtures-only';
+      baseConfig.titleNumbering === 'all' ||
+      baseConfig.titleNumbering === 'fixtures-only';
 
     const useTestObjectTitleNumbering =
-      baseConfig.titleNumbering == 'all' || baseConfig.titleNumbering == 'tests-only';
+      baseConfig.titleNumbering === 'all' || baseConfig.titleNumbering === 'tests-only';
 
     if (fixturesAbsolutePath) {
       debug2(
@@ -509,7 +510,7 @@ function pluginTester(options: PluginTesterOptions = {}) {
         debug2('generating test objects from fixtures path');
 
         const describeBlock =
-          typeof describeBlockTitle == 'string'
+          typeof describeBlockTitle === 'string'
             ? createAndPushDescribeConfig(`${describeBlockTitle} fixtures`)
             : undefined;
 
@@ -524,7 +525,7 @@ function pluginTester(options: PluginTesterOptions = {}) {
       } else {
         debug2('not generating test objects from fixtures path: path is not a directory');
       }
-    } else if (typeof fixtures == 'string') {
+    } else if (typeof fixtures === 'string') {
       throw new TypeError(
         ErrorMessage.UnableToDeriveAbsolutePath(
           filepath,
@@ -541,7 +542,7 @@ function pluginTester(options: PluginTesterOptions = {}) {
       debug2('generating test objects from tests');
 
       const describeBlock =
-        typeof describeBlockTitle == 'string'
+        typeof describeBlockTitle === 'string'
           ? createAndPushDescribeConfig(describeBlockTitle)
           : undefined;
 
@@ -561,7 +562,7 @@ function pluginTester(options: PluginTesterOptions = {}) {
           ...entries.map(([title, test]) => {
             return createTestConfig({
               title,
-              ...(typeof test == 'string' ? { code: test } : test)
+              ...(typeof test === 'string' ? { code: test } : test)
             });
           })
         );
@@ -988,7 +989,7 @@ function pluginTester(options: PluginTesterOptions = {}) {
     debug2(`registering ${tests.length} blocks with testing framework`);
 
     tests.forEach((testConfig) => {
-      if (testConfig[$type] == 'describe-block') {
+      if (testConfig[$type] === 'describe-block') {
         debug2(
           `registering describe block "${testConfig.describeBlockTitle}" and its sub-blocks`
         );
@@ -1228,7 +1229,7 @@ function pluginTester(options: PluginTesterOptions = {}) {
             // @ts-expect-error: not sure from the docs if this is a type error
             microtaskMode: 'afterEvaluate'
           });
-        } else if (testConfig[$type] == 'test-object' && testConfig.snapshot) {
+        } else if (testConfig[$type] === 'test-object' && testConfig.snapshot) {
           debug2('expecting output from babel transform function to match snapshot');
 
           assert(
@@ -1250,7 +1251,7 @@ function pluginTester(options: PluginTesterOptions = {}) {
             output,
             ErrorMessage.ExpectedOutputToEqualActual(testConfig)
           );
-        } else if (testConfig[$type] == 'fixture-object' && outputFixture) {
+        } else if (testConfig[$type] === 'fixture-object' && outputFixture) {
           debug2('writing output from babel transform function to new output file');
           fs.writeFileSync(outputFixture, result);
         } else {
@@ -1313,7 +1314,7 @@ function pluginTester(options: PluginTesterOptions = {}) {
       }
     }
 
-    if (testConfig[$type] == 'test-object' && testConfig.snapshot) {
+    if (testConfig[$type] === 'test-object' && testConfig.snapshot) {
       if (!globalContextExpectFnHasToMatchSnapshot) {
         throwTypeErrorWithDebugOutput(ErrorMessage.TestEnvironmentNoSnapshotSupport());
       }
@@ -1422,10 +1423,10 @@ function getAbsolutePathUsingFilepathDirname(filepath?: string, basename?: strin
   const result = !basename
     ? undefined
     : path.isAbsolute(basename)
-    ? basename
-    : filepath
-    ? path.join(path.dirname(filepath), basename)
-    : undefined;
+      ? basename
+      : filepath
+        ? path.join(path.dirname(filepath), basename)
+        : undefined;
 
   verbose2(`dirname(${filepath}) + ${basename} => ${result}`);
   return result;
@@ -1479,7 +1480,7 @@ function readCode(filepath: string | undefined, basename?: string): string | und
   const { verbose: verbose2 } = getDebuggers('read-code', debug1);
 
   const codePath =
-    arguments.length == 1
+    arguments.length === 1
       ? filepath
       : getAbsolutePathUsingFilepathDirname(filepath, basename);
 
@@ -1635,10 +1636,10 @@ function numericPrefixInRanges(
   numericPrefix: number | undefined,
   ranges: (number | Range)[]
 ) {
-  if (typeof numericPrefix == 'number') {
+  if (typeof numericPrefix === 'number') {
     return ranges.some((range) => {
-      return typeof range == 'number'
-        ? numericPrefix == range
+      return typeof range === 'number'
+        ? numericPrefix === range
         : numericPrefix >= range.start && numericPrefix <= range.end;
     });
   }

test/examples/example-3.test.ts

@@ -54,7 +54,7 @@ pluginTester({
   // You can provide tests as an object
   tests: {
     // The key is the title. The value is the code that is unchanged (because
-    // snapshot == false across all tests). Test title will be: "1. does not
+    // snapshot === false across all tests). Test title will be: "1. does not
     // change code with no identifiers"
     'does not change code with no identifiers': '"hello";',
 

test/examples/example-4.test.ts

@@ -55,7 +55,7 @@ pluginTester({
 
   // Alternatively, you can provide tests as an array
   tests: [
-    // Should be unchanged by the plugin (because snapshot == false across all
+    // Should be unchanged by the plugin (because snapshot === false across all
     // tests). Test title will be: "1. identifier reverse"
     '"hello";',
     {

test/helpers/index.ts

@@ -1,6 +1,6 @@
+import { type AssertionError } from 'node:assert';
 import fs from 'node:fs';
 import path from 'node:path';
-import { type AssertionError } from 'node:assert';
 import { types } from 'node:util';
 
 import { pluginTester } from '../../src/plugin-tester';
@@ -105,7 +105,7 @@ export function addRunnableJestTest(
     }
 
     function isAssertionError(error: Error): error is AssertionError {
-      return error.name == 'AssertionError';
+      return error.name === 'AssertionError';
     }
   });
 }
@@ -192,7 +192,7 @@ export async function runPluginTester(options?: PluginTesterOptions) {
       await pendingTests[pendingTests.push(test()) - 1];
     }
 
-    return pendingTests;
+    //return pendingTests;
   } finally {
     runnableJestTests = [];
   }