Merge pull request #1057 from chromaui/cody/cap-2222-enable-unicornno…

…-null

Enable `unicorn/no-null` ESLint rule

bin-src/init.ts

@@ -35,7 +35,7 @@ export const addChromaticScriptToPackageJson = async ({ packageJson, packagePath
   }
 };
 
-export const createChromaticConfigFile = async ({ configFile, buildScriptName = null }) => {
+export const createChromaticConfigFile = async ({ configFile, buildScriptName = undefined }) => {
   await writeFile(configFile, {
     ...(buildScriptName && {
       buildScriptName,
@@ -148,7 +148,7 @@ export async function main(argv: string[]) {
     const { path: packagePath, packageJson } = pkgInfo;
     const { testFramework } = await prompts([
       {
-        type: flags.framework ? null : 'select',
+        type: flags.framework ? undefined : 'select',
         name: 'testFramework',
         message: 'What testing framework are you using?',
         choices: [

bin-src/trim-stats-file.ts

@@ -42,7 +42,7 @@ export async function main([statsFile = './storybook-static/preview-stats.json']
     const targetFile = statsFile.replace('.json', '.trimmed.json');
     await outputFile(
       targetFile,
-      JSON.stringify({ modules: trimmedModules }, null, 2)
+      JSON.stringify({ modules: trimmedModules }, undefined, 2)
         .replaceAll(/{\n {10}/g, '{ ')
         .replaceAll(/\n {8}}/g, ' }')
     );

eslint.config.mjs

@@ -136,7 +136,6 @@ export default [
       'unicorn/no-process-exit': 'off',
       'unicorn/prefer-node-protocol': 'off', // This will error our Webpack build
       // TODO: remove the following lines when we are ready to enforce these rules
-      'unicorn/no-null': 'off',
       'unicorn/prefer-module': 'off',
     },
   },
@@ -259,6 +258,7 @@ export default [
       'no-secrets/no-secrets': 'warn',
       'max-lines': 'warn',
       'jsdoc/require-jsdoc': 'off',
+      'unicorn/no-null': 'off', // GraphQL returns `null` when there is no value
     },
   },
 ];

node-src/git/findAncestorBuildWithCommit.test.ts

@@ -42,7 +42,7 @@ describe('findAncestorBuildWithCommit', () => {
       makeResult([makeBuild({ commit: 'exists', uncommittedHash: 'abc123', isLocalBuild: true })])
     );
 
-    expect(await findAncestorBuildWithCommit({ client }, 1, { page: 1, limit: 1 })).toBeNull();
+    expect(await findAncestorBuildWithCommit({ client }, 1, { page: 1, limit: 1 })).toBeUndefined();
   });
 
   it('DOES return a CI build with uncommitted changes', async () => {
@@ -74,7 +74,7 @@ describe('findAncestorBuildWithCommit', () => {
       .mockReturnValueOnce(makeResult([makeBuild(), makeBuild()]))
       .mockReturnValueOnce(makeResult([makeBuild(), makeBuild()]));
 
-    expect(await findAncestorBuildWithCommit({ client }, 1, { page: 2, limit: 3 })).toBeNull();
+    expect(await findAncestorBuildWithCommit({ client }, 1, { page: 2, limit: 3 })).toBeUndefined();
     expect(client.runQuery).toHaveBeenCalledTimes(2);
     expect(client.runQuery.mock.calls[0][1]).toMatchObject({ buildNumber: 1, skip: 0, limit: 2 });
     expect(client.runQuery.mock.calls[1][1]).toMatchObject({ buildNumber: 1, skip: 2, limit: 1 });
@@ -83,7 +83,7 @@ describe('findAncestorBuildWithCommit', () => {
   it('stops querying when the results run out', async () => {
     client.runQuery.mockReturnValueOnce(makeResult([makeBuild()]));
 
-    expect(await findAncestorBuildWithCommit({ client }, 1, { page: 2, limit: 3 })).toBeNull();
+    expect(await findAncestorBuildWithCommit({ client }, 1, { page: 2, limit: 3 })).toBeUndefined();
     expect(client.runQuery).toHaveBeenCalledTimes(1);
   });
 });

node-src/git/findAncestorBuildWithCommit.ts

@@ -76,9 +76,9 @@ export async function findAncestorBuildWithCommit(
 
     if (result) return result[0];
 
-    if (results.length < page) return null;
+    if (results.length < page) return;
 
     skip += page;
   }
-  return null;
+  return;
 }

node-src/git/getCommitAndBranch.test.ts

@@ -29,7 +29,7 @@ beforeEach(() => {
     committerEmail: '[email protected]',
   });
   hasPreviousCommit.mockResolvedValue(true);
-  mergeQueueBranchMatch.mockResolvedValue(null);
+  mergeQueueBranchMatch.mockResolvedValue(undefined);
 });
 
 afterEach(() => {

node-src/git/git.test.ts

@@ -111,7 +111,7 @@ describe('mergeQueueBranchMatch', () => {
 
   it('returns null if it is not a merge queue branch', async () => {
     const branch = 'develop';
-    expect(await mergeQueueBranchMatch(branch)).toEqual(null);
+    expect(await mergeQueueBranchMatch(branch)).toBeUndefined();
   });
 });
 

node-src/git/git.ts

@@ -302,5 +302,5 @@ export async function mergeQueueBranchMatch(branch) {
   const mergeQueuePattern = new RegExp(/gh-readonly-queue\/.*\/pr-(\d+)-[\da-f]{30}/);
   const match = branch.match(mergeQueuePattern);
 
-  return match ? Number(match[1]) : null;
+  return match ? Number(match[1]) : undefined;
 }

node-src/index.test.ts

@@ -308,7 +308,7 @@ vi.mock('./git/git', () => ({
   getRepositoryRoot: () => Promise.resolve(process.cwd()),
   getUncommittedHash: () => Promise.resolve('abc123'),
   getUserEmail: () => Promise.resolve('[email protected]'),
-  mergeQueueBranchMatch: () => Promise.resolve(null),
+  mergeQueueBranchMatch: () => Promise.resolve(undefined),
 }));
 
 vi.mock('./git/getParentCommits', () => ({

node-src/lib/compress.ts

@@ -7,7 +7,7 @@ import { Context, FileDesc } from '../types';
 export default async function makeZipFile(ctx: Context, files: FileDesc[]) {
   const archive = archiver('zip', { zlib: { level: 9 } });
   const tmp = await tempFile({ postfix: '.zip' });
-  const sink = createWriteStream(null, { fd: tmp.fd });
+  const sink = createWriteStream(undefined, { fd: tmp.fd });
 
   return new Promise<{ path: string; size: number }>((resolve, reject) => {
     sink.on('close', () => {

node-src/lib/getDependentStoryFiles.test.ts

@@ -503,7 +503,7 @@ describe('getDependentStoryFiles', () => {
     ];
     const ctx = getContext({ configDir: 'path/to/storybook-config' });
     const res = await getDependentStoryFiles(ctx, { modules }, statsPath, changedFiles);
-    expect(res).toEqual(null);
+    expect(res).toBeUndefined();
     expect(ctx.turboSnap.bailReason).toEqual({
       changedStorybookFiles: ['path/to/storybook-config/file.js'],
     });
@@ -530,7 +530,7 @@ describe('getDependentStoryFiles', () => {
     ];
     const ctx = getContext({ configDir: 'path/to/storybook-config' });
     const res = await getDependentStoryFiles(ctx, { modules }, statsPath, changedFiles);
-    expect(res).toEqual(null);
+    expect(res).toBeUndefined();
     expect(ctx.turboSnap.bailReason).toEqual({
       changedStorybookFiles: ['path/to/storybook-config/file.js'],
     });
@@ -558,7 +558,7 @@ describe('getDependentStoryFiles', () => {
     ];
     const ctx = getContext({ configDir: 'path/to/storybook-config' });
     const res = await getDependentStoryFiles(ctx, { modules }, statsPath, changedFiles);
-    expect(res).toEqual(null);
+    expect(res).toBeUndefined();
     expect(ctx.turboSnap.bailReason).toEqual({
       changedStorybookFiles: ['path/to/storybook-config/file.js', 'src/styles.js'],
     });
@@ -585,7 +585,7 @@ describe('getDependentStoryFiles', () => {
     ];
     const ctx = getContext({ staticDir: ['path/to/statics'] });
     const res = await getDependentStoryFiles(ctx, { modules }, statsPath, changedFiles);
-    expect(res).toEqual(null);
+    expect(res).toBeUndefined();
     expect(ctx.turboSnap.bailReason).toEqual({
       changedStaticFiles: ['path/to/statics/image.png'],
     });

node-src/lib/getDependentStoryFiles.ts

@@ -295,7 +295,7 @@ export async function getDependentStoryFiles(
 
   if (ctx.turboSnap.bailReason) {
     ctx.log.warn(bailFile({ turboSnap: ctx.turboSnap }));
-    return null;
+    return;
   }
 
   return affectedModules;

node-src/lib/getFileHashes.ts

@@ -18,7 +18,7 @@ const hashFile = (buffer: Buffer, path: string, xxhash: XXHashAPI): Promise<stri
     };
 
     const readIncremental = (fd: number, hash: XXHash<bigint>) => {
-      read(fd, buffer, null, BUFFER_SIZE, -1, (readErr, bytesRead) => {
+      read(fd, buffer, undefined, BUFFER_SIZE, -1, (readErr, bytesRead) => {
         if (readErr) {
           return close(fd, () => reject(readErr));
         }
@@ -36,7 +36,7 @@ const hashFile = (buffer: Buffer, path: string, xxhash: XXHashAPI): Promise<stri
       if (openErr) {
         return reject(openErr);
       }
-      read(fd, buffer, null, BUFFER_SIZE, -1, (readErr, bytesRead) => {
+      read(fd, buffer, undefined, BUFFER_SIZE, -1, (readErr, bytesRead) => {
         if (readErr) {
           return close(fd, () => reject(readErr));
         }

node-src/lib/getPrebuiltStorybookMetadata.ts

@@ -39,8 +39,8 @@ export const getStorybookMetadataFromProjectJson = async (
   const builder = getBuilder(sbProjectJson);
 
   return {
-    viewLayer: sbProjectJson.framework.name ?? null,
-    version: sbProjectJson.storybookPackages[viewLayerPackage].version ?? null,
+    viewLayer: sbProjectJson.framework.name,
+    version: sbProjectJson.storybookPackages[viewLayerPackage].version,
     builder,
     addons: Object.entries(sbProjectJson.addons)
       .filter(([packageName]) => supportedAddons[packageName])

node-src/lib/getStorybookConfiguration.ts

@@ -6,14 +6,14 @@ export default function getStorybookConfiguration(
   shortName: string,
   longName?: string
 ) {
-  if (!storybookScript) return null;
+  if (!storybookScript) return;
   const parts = storybookScript.split(/[\s"'=]+/);
   let index = parts.indexOf(longName);
   if (index === -1) {
     index = parts.indexOf(shortName);
   }
   if (index === -1) {
-    return null;
+    return;
   }
   return parts[index + 1];
 }

node-src/lib/getStorybookInfo.test.ts

@@ -203,12 +203,7 @@ describe('getStorybookInfo', () => {
         options: { storybookBuildDir: 'bin-src/__mocks__/malformedProjectJson' },
         packageJson: { dependencies: REACT },
       });
-      expect(await getStorybookInfo(ctx)).toEqual({
-        addons: [],
-        version: null,
-        viewLayer: null,
-        builder: null,
-      });
+      expect(await getStorybookInfo(ctx)).toEqual({});
     });
 
     it('does not return unsupported addons in metadata', async () => {

node-src/lib/getStorybookInfo.ts

@@ -24,6 +24,6 @@ export default async function getStorybookInfo(
     return await getStorybookMetadata(ctx);
   } catch (err) {
     ctx.log.debug(err);
-    return { viewLayer: null, version: null, addons: [], builder: null };
+    return {};
   }
 }

node-src/lib/getStorybookMetadata.ts

@@ -224,7 +224,6 @@ export const getStorybookMetadata = async (ctx: Context) => {
       v7 = true;
     } catch (err) {
       ctx.log.debug({ storybookV7error: err });
-      mainConfig = null;
     }
   }
 

node-src/lib/uploadMetadataFiles.ts

@@ -22,8 +22,8 @@ export async function uploadMetadataFiles(ctx: Context) {
     ctx.options.logFile,
     ctx.options.diagnosticsFile,
     ctx.options.storybookLogFile,
-    await findStorybookConfigFile(ctx, /^main\.[jt]sx?$/).catch(() => null),
-    await findStorybookConfigFile(ctx, /^preview\.[jt]sx?$/).catch(() => null),
+    await findStorybookConfigFile(ctx, /^main\.[jt]sx?$/).catch(() => undefined),
+    await findStorybookConfigFile(ctx, /^preview\.[jt]sx?$/).catch(() => undefined),
     ctx.fileInfo?.statsPath && (await trimStatsFile([ctx.fileInfo.statsPath])),
   ].filter(Boolean);
 

node-src/tasks/build.ts

@@ -99,7 +99,7 @@ function e2eBuildErrorMessage(
 }
 
 export const buildStorybook = async (ctx: Context) => {
-  let logFile = null;
+  let logFile;
   if (ctx.options.storybookLogFile) {
     ctx.buildLogFile = path.resolve(ctx.options.storybookLogFile);
     logFile = createWriteStream(ctx.buildLogFile);
@@ -112,10 +112,10 @@ export const buildStorybook = async (ctx: Context) => {
   const { experimental_abortSignal: signal } = ctx.options;
   try {
     ctx.log.debug('Running build command:', ctx.buildCommand);
-    ctx.log.debug('Runtime metadata:', JSON.stringify(ctx.runtimeMetadata, null, 2));
+    ctx.log.debug('Runtime metadata:', JSON.stringify(ctx.runtimeMetadata, undefined, 2));
 
     const subprocess = execaCommand(ctx.buildCommand, {
-      stdio: [null, logFile, null],
+      stdio: [undefined, logFile, undefined],
       // When `true`, this will run in the node version set by the
       // action (node20), not the version set in the workflow
       preferLocal: false,

node-src/tasks/gitInfo.test.ts

@@ -128,7 +128,7 @@ describe('setGitInfo', () => {
     });
     const ctx = { log, options: { onlyChanged: true, externals: ['**/*.scss'] }, client } as any;
     await setGitInfo(ctx, {} as any);
-    expect(ctx.git.changedFiles).toBeNull();
+    expect(ctx.git.changedFiles).toBeUndefined();
   });
 
   it('forces rebuild automatically if app is onboarding', async () => {

node-src/tasks/gitInfo.ts

@@ -71,11 +71,11 @@ export const setGitInfo = async (ctx: Context, task: Task) => {
     version: await getVersion(),
     gitUserEmail: await getUserEmail().catch((err) => {
       ctx.log.debug('Failed to retrieve Git user email', err);
-      return null;
+      return undefined;
     }),
     uncommittedHash: await getUncommittedHash().catch((err) => {
       ctx.log.warn('Failed to retrieve uncommitted files hash', err);
-      return null;
+      return undefined;
     }),
     ...commitAndBranchInfo,
   };
@@ -225,8 +225,8 @@ export const setGitInfo = async (ctx: Context, task: Task) => {
       }
     } catch (err) {
       ctx.turboSnap.bailReason = { invalidChangedFiles: true };
-      ctx.git.changedFiles = null;
-      ctx.git.replacementBuildIds = null;
+      delete ctx.git.changedFiles;
+      delete ctx.git.replacementBuildIds;
       ctx.log.warn(invalidChangedFiles());
       ctx.log.debug(err);
     }
@@ -237,8 +237,8 @@ export const setGitInfo = async (ctx: Context, task: Task) => {
         if (matches.length > 0) {
           ctx.turboSnap.bailReason = { changedExternalFiles: matches };
           ctx.log.warn(externalsChanged(matches));
-          ctx.git.changedFiles = null;
-          ctx.git.replacementBuildIds = null;
+          delete ctx.git.changedFiles;
+          delete ctx.git.replacementBuildIds;
           break;
         }
       }

node-src/tasks/initialize.ts

@@ -40,7 +40,7 @@ export const setEnvironment = async (ctx: Context) => {
     }
   }
 
-  ctx.log.debug(`Got environment:\n${JSON.stringify(ctx.environment, null, 2)}`);
+  ctx.log.debug(`Got environment:\n${JSON.stringify(ctx.environment, undefined, 2)}`);
 };
 
 export const setRuntimeMetadata = async (ctx: Context) => {

node-src/ui/messages/errors/buildFailed.ts

@@ -26,7 +26,7 @@ export default (
     `),
     message,
     chalk`${info} Build command:\n{dim ${buildCommand}}`,
-    chalk`${info} Runtime metadata:\n{dim ${JSON.stringify(runtimeMetadata, null, 2)}}`,
+    chalk`${info} Runtime metadata:\n{dim ${JSON.stringify(runtimeMetadata, undefined, 2)}}`,
     chalk`${info} Storybook build output:\n{dim ${buildLogFile}}`,
     lines.join(`\n`),
   ].join('\n\n');

node-src/ui/messages/errors/fatalError.ts

@@ -86,7 +86,7 @@ export default function fatalError(
 
       Please provide us with the above CLI output and the following info:
     `),
-    chalk`{bold ${JSON.stringify(debugInfo, null, 2)}}`,
+    chalk`{bold ${JSON.stringify(debugInfo, undefined, 2)}}`,
     stacktraces.length > 0 ? chalk`\n{dim ${stacktraces.join('\n\n')}}` : '',
   ].join('\n');
 }

node-src/ui/messages/errors/uploadFailed.ts

@@ -20,5 +20,5 @@ export function uploadFailed({ target }: { target: FileDesc & TargetInfo }, debu
     ${diagnosis}
     ${debug ? '' : chalk`Enable the {bold debug} option to get more information.`}
   `);
-  return debug ? message + JSON.stringify(target, null, 2) : message;
+  return debug ? message + JSON.stringify(target, undefined, 2) : message;
 }

node-src/ui/messages/info/tracedAffectedFiles.ts

@@ -51,7 +51,7 @@ export default (
   const changed = pluralize('changed files', changedFiles.length, true);
   const affected = pluralize('affected story files', Object.keys(affectedModules).length, true);
 
-  let directoryDebug = null;
+  let directoryDebug;
 
   if (expanded) {
     const bailReason = ctx.turboSnap?.bailReason ? `${ctx.turboSnap.bailReason}\n\n` : '';

node-src/ui/tasks/verify.stories.ts

@@ -1,3 +1,4 @@
+/* eslint-disable unicorn/no-null -- GraphQL returns `null` if a value doesn't exist */
 import task from '../components/task';
 import {
   awaitingUpgrades,

test-stories/Tests.stories.js

@@ -11,7 +11,7 @@ export default {
 };
 
 export const WithViewports = () => {
-  let bg = null;
+  let bg;
   if (window.matchMedia('(max-width: 400px)').matches) {
     bg = 'cyan';
   } else if (window.matchMedia('(max-width: 800px)').matches) {