Merge pull request #1064 from chromaui/cody/cap-2260-enable-unicornpr…

…event-abbreviations

Enable `unicorn/prevent-abbreviations` ESLint rule

bin-src/init.ts

@@ -73,10 +73,10 @@ export const installArchiveDependencies = async (
   packageJson: PackageJson,
   testFramework: TestFrameworkType
 ) => {
-  const defaultInstallArgs = ['-D', 'chromatic', `@chromatic-com/${testFramework}`];
+  const defaultInstallArguments = ['-D', 'chromatic', `@chromatic-com/${testFramework}`];
   const sbPackages = getStorybookPackages(packageJson);
-  const installArgs = [...defaultInstallArgs, ...sbPackages];
-  const installCommand = await getPackageManagerInstallCommand(installArgs);
+  const installArguments = [...defaultInstallArguments, ...sbPackages];
+  const installCommand = await getPackageManagerInstallCommand(installArguments);
   await execaCommand(installCommand);
 };
 

bin-src/trace.test.ts

@@ -2,9 +2,9 @@ import { execSync } from 'child_process';
 import { describe, expect, it } from 'vitest';
 
 import {
-  baseDirNote,
-  rootDirNote,
-  storybookDirNote,
+  baseDirectoryNote,
+  rootDirectoryNote,
+  storybookDirectoryNote,
   traceSuggestions,
 } from '../node-src/ui/messages/info/tracedAffectedFiles';
 
@@ -17,7 +17,7 @@ describe('Test trace script from package.json', () => {
     const output = execSync(`yarn ${scriptName}`).toString().trim();
 
     // Verify that the output does not contain the expanded output
-    expect(output).not.toContain(rootDirNote);
+    expect(output).not.toContain(rootDirectoryNote);
   });
   it('outputs directory info when -m expanded is passed', () => {
     const scriptName =
@@ -30,9 +30,9 @@ describe('Test trace script from package.json', () => {
     const expandedFileModule = `node-src/ui/messages/errors/invalidReportPath.ts`;
 
     // Add your assertions based on the expected output or behavior of the script
-    expect(output).toContain(rootDirNote);
-    expect(output).toContain(baseDirNote);
-    expect(output).toContain(storybookDirNote);
+    expect(output).toContain(rootDirectoryNote);
+    expect(output).toContain(baseDirectoryNote);
+    expect(output).toContain(storybookDirectoryNote);
     expect(output).toContain(traceSuggestions);
     expect(output).toContain(expandedStoryModule);
     expect(output).toContain(expandedFileModule);

bin-src/trim-stats-file.ts

@@ -2,7 +2,7 @@ import { outputFile } from 'fs-extra';
 
 import { readStatsFile } from '../node-src/tasks/read-stats-file';
 
-const dedupe = <T>(arr: T[]) => [...new Set(arr)];
+const dedupe = <T>(array: T[]) => [...new Set(array)];
 const isUserCode = ({ name, moduleName = name }: { name?: string; moduleName?: string }) =>
   moduleName &&
   !moduleName.startsWith('(webpack)') &&

eslint.config.mjs

@@ -113,7 +113,7 @@ export default [
       // Chromatic uses err as our catch convention.
       // This is baked into pino transforms as well.
       'unicorn/prevent-abbreviations': [
-        'off', // TODO: Switch this to 'error' when we are ready to enforce this rule
+        'error',
         {
           allowList: {
             err: true,
@@ -122,7 +122,10 @@ export default [
             str: true,
             args: true,
             docsUrl: true,
+            fn: true,
+            pkg: true,
           },
+          ignore: [/.*e2e.*/, /\w+[Dd]ocs\w*/],
         },
       ],
       'unicorn/catch-error-name': [

isChromatic.js

@@ -1,7 +1,7 @@
 /* eslint-env browser */
 
-module.exports = function isChromatic(windowArg) {
-  const windowToCheck = windowArg || (typeof window !== 'undefined' && window);
+module.exports = function isChromatic(windowArgument) {
+  const windowToCheck = windowArgument || (typeof window !== 'undefined' && window);
   return !!(
     windowToCheck &&
     (/Chromatic/.test(windowToCheck.navigator.userAgent) ||

isChromatic.mjs

@@ -1,7 +1,7 @@
 /* eslint-env browser */
 
-export default function isChromatic(windowArg) {
-  const windowToCheck = windowArg || (typeof window !== 'undefined' && window);
+export default function isChromatic(windowArgument) {
+  const windowToCheck = windowArgument || (typeof window !== 'undefined' && window);
   return !!(
     windowToCheck &&
     (/Chromatic/.test(windowToCheck.navigator.userAgent) ||

node-src/git/generateGitRepository.ts

@@ -24,22 +24,22 @@ async function generateCommit(
     .map((parentName) => parentName && commitMap[parentName].hash);
 
   const randomBranchName = `temp-${Math.random().toString().slice(2)}`;
-  const commitEnv = `GIT_COMMITTER_DATE='${nextDate()}'`;
+  const commitEnvironment = `GIT_COMMITTER_DATE='${nextDate()}'`;
   // No parent, check out nothing
   if (parentCommits.length === 0) {
     await runGit(`git checkout --orphan ${randomBranchName}`);
-    await runGit(`${commitEnv} git commit -m ${name} --allow-empty`);
+    await runGit(`${commitEnvironment} git commit -m ${name} --allow-empty`);
   } else {
     // Check out the first parent
     await runGit(`git checkout ${parentCommits[0]}`);
 
     // If more parents, create merge commit
     await (parentCommits.length > 1
-      ? runGit(`${commitEnv} git merge -m ${name} ${parentCommits.slice(1).join(' ')}`)
-      : runGit(`${commitEnv} git commit -m ${name} --allow-empty`));
+      ? runGit(`${commitEnvironment} git merge -m ${name} ${parentCommits.slice(1).join(' ')}`)
+      : runGit(`${commitEnvironment} git commit -m ${name} --allow-empty`));
   }
-  const gitShowStr = await runGit(`git show --format=%H,%ct`);
-  const [hash, committedAt] = gitShowStr.stdout.trim().split(',');
+  const gitShowString = await runGit(`git show --format=%H,%ct`);
+  const [hash, committedAt] = gitShowString.stdout.trim().split(',');
 
   return { hash, committedAt: Number.parseInt(committedAt, 10) };
 }

node-src/git/getCommitAndBranch.test.ts

@@ -17,9 +17,9 @@ const mergeQueueBranchMatch = vi.mocked(git.mergeQueueBranchMatch);
 
 const log = { info: vi.fn(), warn: vi.fn(), debug: vi.fn() };
 
-const processEnv = process.env;
+const processEnvironment = process.env;
 beforeEach(() => {
-  process.env = { ...processEnv };
+  process.env = { ...processEnvironment };
   envCi.mockReturnValue({});
   getBranch.mockResolvedValue('main');
   getCommit.mockResolvedValue({

node-src/git/getCommitAndBranch.ts

@@ -56,7 +56,7 @@ export default async function getCommitAndBranch(
   } = process.env;
   const { isCi, service, prBranch, branch: ciBranch, commit: ciCommit, slug: ciSlug } = envCi();
 
-  const isFromEnvVariable = CHROMATIC_SHA && CHROMATIC_BRANCH; // Our GitHub Action also sets these
+  const isFromEnvironmentVariable = CHROMATIC_SHA && CHROMATIC_BRANCH; // Our GitHub Action also sets these
   const isTravisPrBuild = TRAVIS_EVENT_TYPE === 'pull_request';
   const isGitHubAction = GITHUB_ACTIONS === 'true';
   const isGitHubPrBuild = GITHUB_EVENT_NAME === 'pull_request';
@@ -70,7 +70,7 @@ export default async function getCommitAndBranch(
     }
   }
 
-  if (isFromEnvVariable) {
+  if (isFromEnvironmentVariable) {
     commit = await getCommit(CHROMATIC_SHA).catch((err) => {
       log.warn(noCommitDetails({ sha: CHROMATIC_SHA, env: 'CHROMATIC_SHA' }));
       log.debug(err);
@@ -156,7 +156,7 @@ export default async function getCommitAndBranch(
     !!process.env.GITHUB_REPOSITORY;
 
   // Strip off any `origin/` prefix that's added sometimes.
-  if (!branchName && !isFromEnvVariable && ORIGIN_PREFIX_REGEXP.test(branch)) {
+  if (!branchName && !isFromEnvironmentVariable && ORIGIN_PREFIX_REGEXP.test(branch)) {
     log.warn(`Ignoring 'origin/' prefix in branch name.`);
     branch = branch.replace(ORIGIN_PREFIX_REGEXP, '');
   }

node-src/git/git.ts

@@ -1,7 +1,7 @@
 import { execaCommand } from 'execa';
 import { EOL } from 'os';
 import pLimit from 'p-limit';
-import { file as tmpFile } from 'tmp-promise';
+import { file as temporaryFile } from 'tmp-promise';
 
 import { Context } from '../types';
 import gitNoCommits from '../ui/messages/errors/gitNoCommits';
@@ -88,13 +88,13 @@ export async function getBranch() {
     try {
       // Git v1.8 and above
       // Throws when in detached HEAD state
-      const ref = await execGitCommand('git symbolic-ref HEAD');
-      return ref.replace(/^refs\/heads\//, ''); // strip the "refs/heads/" prefix
+      const reference = await execGitCommand('git symbolic-ref HEAD');
+      return reference.replace(/^refs\/heads\//, ''); // strip the "refs/heads/" prefix
     } catch {
       // Git v1.7 and above
       // Yields 'HEAD' when in detached HEAD state
-      const ref = await execGitCommand('git rev-parse --abbrev-ref HEAD');
-      return ref.replace(/^heads\//, ''); // strip the "heads/" prefix that's sometimes present
+      const reference = await execGitCommand('git rev-parse --abbrev-ref HEAD');
+      return reference.replace(/^heads\//, ''); // strip the "heads/" prefix that's sometimes present
     }
   }
 }
@@ -230,8 +230,8 @@ export async function getUpdateMessage() {
  * @param {string} headRef Name of the head branch
  * @param {string} baseRef Name of the base branch
  */
-export async function findMergeBase(headRef: string, baseRef: string) {
-  const result = await execGitCommand(`git merge-base --all ${headRef} ${baseRef}`);
+export async function findMergeBase(headReference: string, baseReference: string) {
+  const result = await execGitCommand(`git merge-base --all ${headReference} ${baseReference}`);
   const mergeBases = result.split(newline).filter((line) => line && !line.startsWith('warning: '));
   if (mergeBases.length === 0) return undefined;
   if (mergeBases.length === 1) return mergeBases[0];
@@ -244,21 +244,25 @@ export async function findMergeBase(headRef: string, baseRef: string) {
       return name.replace(/~\d+$/, ''); // Drop the potential suffix
     })
   );
-  const baseRefIndex = branchNames.indexOf(baseRef);
-  return mergeBases[baseRefIndex] || mergeBases[0];
+  const baseReferenceIndex = branchNames.indexOf(baseReference);
+  return mergeBases[baseReferenceIndex] || mergeBases[0];
 }
 
-export async function checkout(ref: string) {
-  return execGitCommand(`git checkout ${ref}`);
+export async function checkout(reference: string) {
+  return execGitCommand(`git checkout ${reference}`);
 }
 
 const fileCache = {};
 const limitConcurrency = pLimit(10);
-export async function checkoutFile({ log }: Pick<Context, 'log'>, ref: string, fileName: string) {
-  const pathspec = `${ref}:${fileName}`;
+export async function checkoutFile(
+  { log }: Pick<Context, 'log'>,
+  reference: string,
+  fileName: string
+) {
+  const pathspec = `${reference}:${fileName}`;
   if (!fileCache[pathspec]) {
     fileCache[pathspec] = limitConcurrency(async () => {
-      const { path: targetFileName } = await tmpFile({
+      const { path: targetFileName } = await temporaryFile({
         postfix: `-${fileName.replaceAll('/', '--')}`,
       });
       log.debug(`Checking out file ${pathspec} at ${targetFileName}`);

node-src/index.test.ts

@@ -11,8 +11,8 @@ import { getGitInfo, runAll } from '.';
 import * as git from './git/git';
 import { DNSResolveAgent } from './io/getDNSResolveAgent';
 import * as checkPackageJson from './lib/checkPackageJson';
-import getEnv from './lib/getEnv';
-import parseArgs from './lib/parseArgs';
+import getEnvironment from './lib/getEnvironment';
+import parseArguments from './lib/parseArguments';
 import TestLogger from './lib/testLogger';
 import { uploadFiles } from './lib/uploadFiles';
 import { writeChromaticDiagnostics } from './lib/writeChromaticDiagnostics';
@@ -342,9 +342,9 @@ vi.mock('./lib/uploadFiles');
 
 vi.mock('./lib/spawn', () => ({ default: () => Promise.resolve('https://npm.example.com') }));
 
-let processEnv;
+let processEnvironment;
 beforeEach(() => {
-  processEnv = process.env;
+  processEnvironment = process.env;
   process.env = {
     DISABLE_LOGGING: 'true',
     CHROMATIC_APP_CODE: undefined,
@@ -361,14 +361,14 @@ beforeEach(() => {
   getSlug.mockResolvedValue('user/repo');
 });
 afterEach(() => {
-  process.env = processEnv;
+  process.env = processEnvironment;
 });
 
 const getContext = (argv: string[]): Context & { testLogger: TestLogger } => {
   const testLogger = new TestLogger();
   return {
     title: '',
-    env: getEnv(),
+    env: getEnvironment(),
     log: testLogger,
     testLogger,
     sessionId: ':sessionId',
@@ -384,7 +384,7 @@ const getContext = (argv: string[]): Context & { testLogger: TestLogger } => {
     packagePath: '',
     statsPath: 'preview-stats.json',
     options: {},
-    ...parseArgs(argv),
+    ...parseArguments(argv),
   } as any;
 };
 

node-src/index.ts

@@ -19,12 +19,12 @@ import checkPackageJson from './lib/checkPackageJson';
 import { isE2EBuild } from './lib/e2e';
 import { emailHash } from './lib/emailHash';
 import { getConfiguration } from './lib/getConfiguration';
-import getEnv from './lib/getEnv';
+import getEnvironment from './lib/getEnvironment';
 import getOptions from './lib/getOptions';
 import { createLogger } from './lib/log';
 import LoggingRenderer from './lib/LoggingRenderer';
 import NonTTYRenderer from './lib/NonTTYRenderer';
-import parseArgs from './lib/parseArgs';
+import parseArguments from './lib/parseArguments';
 import { exitCodes, setExitCode } from './lib/setExitCode';
 import { uploadMetadataFiles } from './lib/uploadMetadataFiles';
 import { rewriteErrorMessage } from './lib/utils';
@@ -96,22 +96,26 @@ export async function run({
   flags?: Flags;
   options?: Partial<Options>;
 }): Promise<Output> {
-  const { sessionId = uuid(), env = getEnv(), log = createLogger() } = extraOptions || {};
+  const {
+    sessionId = uuid(),
+    env: environment = getEnvironment(),
+    log = createLogger(),
+  } = extraOptions || {};
 
-  const pkgInfo = await readPkgUp({ cwd: process.cwd() });
-  if (!pkgInfo) {
+  const packageInfo = await readPkgUp({ cwd: process.cwd() });
+  if (!packageInfo) {
     log.error(noPackageJson());
     process.exit(253);
   }
 
-  const { path: packagePath, packageJson } = pkgInfo;
+  const { path: packagePath, packageJson } = packageInfo;
   const ctx: InitialContext = {
-    ...parseArgs(argv),
+    ...parseArguments(argv),
     ...(flags && { flags }),
     ...(extraOptions && { extraOptions }),
     packagePath,
     packageJson,
-    env,
+    env: environment,
     log,
     sessionId,
   };
@@ -142,12 +146,12 @@ export async function runAll(ctx: InitialContext) {
   ctx.log.info(intro(ctx));
   ctx.log.info('');
 
-  const onError = (e: Error | Error[]) => {
+  const onError = (err: Error | Error[]) => {
     ctx.log.info('');
-    ctx.log.error(fatalError(ctx, [e].flat()));
+    ctx.log.error(fatalError(ctx, [err].flat()));
     ctx.extraOptions?.experimental_onTaskError?.(ctx, {
-      formattedError: fatalError(ctx, [e].flat()),
-      originalError: e,
+      formattedError: fatalError(ctx, [err].flat()),
+      originalError: err,
     });
     setExitCode(ctx, exitCodes.INVALID_OPTIONS, true);
   };
@@ -278,6 +282,8 @@ export interface GitInfo {
   repositoryRootDir: string;
 }
 
+// Although this function may not be used directly in this project, it can be used externally (such
+// as https://github.com/chromaui/addon-visual-tests).
 export async function getGitInfo(): Promise<GitInfo> {
   let slug: string;
   try {
@@ -289,7 +295,7 @@ export async function getGitInfo(): Promise<GitInfo> {
   const commitInfo = await getCommit();
   const userEmail = await getUserEmail();
   const userEmailHash = emailHash(userEmail);
-  const repositoryRootDir = await getRepositoryRoot();
+  const repositoryRootDirectory = await getRepositoryRoot();
 
   const [ownerName, repoName, ...rest] = slug ? slug.split('/') : [];
   const isValidSlug = !!ownerName && !!repoName && rest.length === 0;
@@ -302,7 +308,7 @@ export async function getGitInfo(): Promise<GitInfo> {
     uncommittedHash,
     userEmail,
     userEmailHash,
-    repositoryRootDir,
+    repositoryRootDir: repositoryRootDirectory,
   };
 }
 

node-src/io/GraphQLClient.ts

@@ -47,7 +47,7 @@ export default class GraphQLClient {
             },
             { retries }
           )
-          .then((res) => res.json() as any)
+          .then((result) => result.json() as any)
           .catch(bail);
 
         if (!errors) return data;