Add support for a JSON configuration file

[tmeasday]

Note that I made a judgement on which keys to support in the file (see

chromatic-cli/node-src/lib/getConfiguration.ts

Lines 9 to 34 in 72ab4cc

	projectId: z.string(),
	projectToken: z.string(),
	onlyChanged: z.union([z.string(), z.boolean()]),
	onlyStoryFiles: z.array(z.string()),
	onlyStoryNames: z.array(z.string()),
	untraced: z.array(z.string()),
	externals: z.array(z.string()),
	ci: z.boolean(),
	debug: z.boolean(),
	junitReport: z.union([z.string(), z.boolean()]),
	autoAcceptChanges: z.union([z.string(), z.boolean()]),
	exitZeroOnChanged: z.union([z.string(), z.boolean()]),
	exitOnceUploaded: z.union([z.string(), z.boolean()]),
	ignoreLastBuildOneBranch: z.string(),
	buildScriptName: z.string(),
	outputDir: z.string(),
	storybookBuildDir: z.string(),
	storybookBaseDir: z.string(),
	storybookConfigDir: z.string(),
	ownerName: z.string(),
	repositorySlug: z.string(),
	})

) - which may be wrong, I am very open to ideas here.

[linear]

AP-3623 Add CLI support for a chromatic.js config file that allows multiple environments and configuration outside of .storybook/

Currently users must configure their chromatic cli inside of storybook configuration and through cli flags. This may be confusing as users might require different settings for local builds vs ci builds. We may be able to improve this by allowing users to define their configurations in a separate, type-safe config file.

This should be an additional form of configuration, and allow backwards compatibility for existing setups using cli flags and ci configuration. It may need to allow both approaches to be mixed.

Multiple Environments:

With the addon-visual-tests having more users run builds outside of CI, configuration for the cli may need to vary based on the environment. Supporting multiple environments, through environment-suffixed names or programatic configuration would help optimize configuration for local builds.

Related Slack thread: https://chromaticqa.slack.com/archives/C051TQR6QLC/p1693198584200749

[ghengeveld]

I don't like the filename, but otherwise looks good.

[jonniebigodes]

@tmeasday left some questions for you that we can follow async to address the documentation accordingly. I'm approving this to unblock you on this.

[weeksling]

I had a question and a couple suggestions about using the flag to override configuration instead of the other way around.