Move site-configs.ts to site-configs directory

[dkarnutsch]

Description

As a prerequisite for #388, I need to move site-configs.ts to a directory in order to mount it during build. Additionally, I think this improves readability.

[dkarnutsch]

This is due to https://github.com/vivid-planet/comet/blob/e2eb8265316f76980c0f47cb2ccdce2106ea7847/packages/cli/src/commands/site-configs.ts#L16.

It should always prepend process.cwd(). This should be fixed in Comet.

[fraxachun]

vivid-planet/comet#2642

[johnnyomair]

@dkarnutsch do you want to merge it like this and change it once the fix is released in core?

[dkarnutsch]

yes 👍

[dkarnutsch]

I don't like this solution. I think we should use a more declarative solution instead of relying on some magic.

I would propose to introduce a variable containing all sites. This was briefly discussed in one JFX.

[nsams]

Or use a standard, non-dynamic import, that would also improve typing (as you don't need as ... GetSiteConfig)

[fraxachun]

I had a brief test and I also suggest to go with @nsams basic solution:

import { SiteConfig } from "./site-configs.d";
import main from "./main";
import secondary from "./secondary";

// Types for files in site-configs/
export type Environment = "local" | "dev" | "test" | "staging" | "prod";
export type GetSiteConfig = (env: Environment) => SiteConfig;

const isValidEnvironment = (env: string): env is Environment => {
    return ["local", "dev", "test", "staging", "prod"].includes(env);
};

// Called by `npx @comet/cli inject-site-configs`
const getSiteConfigs = async (env: string): Promise<SiteConfig[]> => {
    if (!isValidEnvironment(env)) {
        throw new Error(`Invalid environment: ${env}`);
    }

    const imports = [main, secondary];
    return imports.map((getSiteConfig) => getSiteConfig(env));
};
export default getSiteConfigs;

[dkarnutsch]

cc4fc17

[johnnyomair]

We should implement both your suggestions before merging this.