File

libs/nx/src/generators/webcomponent-config/schema.ts

Description

The schema for the web component config generator

Index

Properties

Properties

buildTarget (Optional)
Type string
CLI Usage --buildTarget="my-build-target:my-configuration-name"
Default value "build-generated-app:webcomponent"
Description

The build target and configuration to which the web component configuration will be added. The target must exist. A new target is never created. If the given configuration does not exist, it will be created. If only the target is specified it will use the configuration name "webcomponent".

bundleTarget (Optional)
Type string
CLI Usage --bundleTarget="my-webcomponent-bundle"
Default value "webcomponent-bundle"
Description

The name of the target that turns the built journey into a web component bundle. The specified target will be created. If the target already exists, it will be overwritten. If bundleTarget is not specified, “webcomponent-bundle” is used as the default

deployUrl (Optional)
Type string
CLI Usage --deployUrl="https://example.com/"
Description

The url at which the web component will be served.

developTarget (Optional)
Type string
CLI Usage --developTarget="my-develop-target:my-configuration-name"
Default value "develop:webcomponent"
Description

The develop target and configuration to which the web component configuration will be added. The target must exist. A new target is never created. If the given configuration does not exist, it will be created. If only the target is specified it will use the configuration name "webcomponent".

generateTarget (Optional)
Type string
CLI Usage --generateTarget="my-generate-target:my-configuration-name"
Default value "generate-only:webcomponent"
Description

The generate target and configuration to which the web component configuration will be added. The target must exist. A new target is never created. If the given configuration does not exist, it will be created. If only the target is specified it will use the configuration name "webcomponent".

project
Type string
CLI Usage --project="my-app"
Description

The name of the project to which the web component configuration will be added

serveTarget (Optional)
Type string
CLI Usage --serveTarget="my-serve-target:my-configuration-name"
Default value "serve-generated-app:webcomponent"
Description

The serve target and configuration to which the web component configuration will be added. The target must exist. A new target is never created. If the given configuration does not exist, it will be created. If only the target is specified it will use the configuration name "webcomponent".

export interface WebComponentConfigGeneratorSchema {
  /**
   * The name of the project to which the web component configuration will be added
   *
   * @cliUsage --project="my-app"
   */
  project: string;

  /**
   * The url at which the web component will be served.
   *
   * @cliUsage --deployUrl="https://example.com/"
   */
  deployUrl?: string;

  /**
   * The develop target and configuration to which the web component configuration will be added.
   * The target must exist. A new target is never created.
   * If the given configuration does not exist, it will be created.
   * If only the target is specified it will use the configuration name `"webcomponent"`.
   *
   * @default "develop:webcomponent"
   * @examples ["my-develop-target", "my-develop-target:my-configuration-name"]
   * @cliUsage --developTarget="my-develop-target:my-configuration-name"
   */
  developTarget?: string;

  /**
   * The serve target and configuration to which the web component configuration will be added.
   * The target must exist. A new target is never created.
   * If the given configuration does not exist, it will be created.
   * If only the target is specified it will use the configuration name `"webcomponent"`.
   *
   * @default "serve-generated-app:webcomponent"
   * @examples ["my-serve-target", "my-serve-target:my-configuration-name"]
   * @cliUsage --serveTarget="my-serve-target:my-configuration-name"
   */
  serveTarget?: string;

  /**
   * The build target and configuration to which the web component configuration will be added.
   * The target must exist. A new target is never created.
   * If the given configuration does not exist, it will be created.
   * If only the target is specified it will use the configuration name `"webcomponent"`.
   *
   * @default "build-generated-app:webcomponent"
   * @examples ["my-build-target", "my-build-target:my-configuration-name"]
   * @cliUsage --buildTarget="my-build-target:my-configuration-name"
   */
  buildTarget?: string;

  /**
   * The generate target and configuration to which the web component configuration will be added.
   * The target must exist. A new target is never created.
   * If the given configuration does not exist, it will be created.
   * If only the target is specified it will use the configuration name `"webcomponent"`.
   *
   * @default "generate-only:webcomponent"
   * @examples ["my-generate-target", "my-generate-target:my-configuration-name"]
   * @cliUsage --generateTarget="my-generate-target:my-configuration-name"
   */
  generateTarget?: string;

  /**
   * The name of the target that turns the built journey into a web component bundle.
   * The specified target will be created. If the target already exists, it will be overwritten.
   * If `bundleTarget` is not specified, `“webcomponent-bundle”` is used as the default
   *
   * @default "webcomponent-bundle"
   * @cliUsage --bundleTarget="my-webcomponent-bundle"
   */
  bundleTarget?: string;
}

results matching ""

    No results matching ""