Skip to content

Config Schema

Kelly Selden edited this page Nov 14, 2019 · 16 revisions
/**
  This lives at config/ember-cli-update.json by default.
*/
interface BlueprintConfig {
  /**
    A base blueprint is the blueprint you started your project with.
    This could be the ember app blueprint, or a custom blueprint like libkit.
    If this is missing or false, it is a partial blueprint, like the changes
    you get when installing an ember addon like ember-cli-mirage.
  */
  isBaseBlueprint?: boolean;

  /**
    The name of the blueprint to be ran.
  */
  name: string;

  /**
    The package the blueprint comes from.
  */
  package: string;

  /**
    The version of the package above to use. 
  */
  version: string;

  /**
    The path inside your project to run in. Think deeply nested
    component generators. Missing means project root.
  */
  cwd?: string;

  /**
    The blueprint command line options.
  */
  options?: {
    /**
      All options should be normalized to match any codemod requirements.
      The work to normalise them might not be done at first, so users
      writing the CLI commands are expected to do it. For example,
      `--no-welcome` should be expanded to `--welcome=false` so that
      a codemod with a requirement of `{ "welcome": false }` can match it.
    */
    named?: {
      [key: string]: any;
    };
  }
}

Clone this wiki locally