feat: configure CLI with config file

[angeloashmore]

Types of changes

• [ ] Chore (a non-breaking change which is related to package maintenance)
• [ ] Bug fix (a non-breaking change which fixes an issue)
• [x] New feature (a non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to change)

Description

This PR adds the ability to configure the CLI with a configuration file.

Configuration is loaded from the following locations:

• prismicCodegen.config.ts
• prismicCodegen.config.js

Note: The name of the file is up for debate as it feels a bit clunky.

With the new configuration options, the CLI is now able to do the following:

• Load models from local files (you no longer need to specify Custom Type models separately from Shared Slice models)
• Fetch models from from a repository via the Custom Types API
• Fetch locale IDs from a repository via the Rest API
• Customize Embed field oEmbed data
• Customize Integration Fields data

The fully filled out configuration file could look like the following:

// prismicCodegen.config.ts

import { Config } from "prismic-ts-codegen";

const config: Config = {
  repositoryName: "my-repo-name",
  accessToken: "abc123xyz345",
  customTypesAPIToken: "abc123xyz345",

  output: "./types.generated.ts",

  locales: {
    ids: ["en-us", "fr-fr", "en-gb"],
    fetchFromRepository: true,
  },

  models: {
    files: ["./customtypes/**/index.json", "./slices/**/model.json"],
    fetchFromRepository: true,
  },

  fields: {
    embed: {
      providerTypes: {
        YouTube: 'import("./types").OEmbedYouTube',
        Twitter: 'import("./types").OEmbedTwitter',
        Vimeo: 'import("./types").OEmbedVimeo',
      },
    },
    integrationFields: {
      catalogTypes: {
        shop: 'import("./types").IntegrationFieldShop',
      },
    },
  },
};

export default config

All properties are optional. Providing some options require other options. For example, if models.fetchFromRepository is true, then repositoryName and customTypesApiToken are required.

The config object will be validated when the CLI is called.

Checklist:

• [ ] My change requires an update to the official documentation.
• [ ] All TSDoc comments are up-to-date and new ones have been added where necessary.
• [x] All new and existing tests are passing.

🐕

[github-actions[bot]]

size-limit report 📦

Path	Size
dist/index.js	1.04 MB (+0.01% 🔺)
dist/index.cjs	1.04 MB (-0.01% 🔽)