@moonrepo/types 1.33.2 → 2.0.0

package/src/template-config.ts

@@ -4,21 +4,31 @@
 
 import type { Id } from './common';
 
-/** Docs: https://moonrepo.dev/docs/config/template#frontmatter */
+/**
+ * Configures the leading frontmatter within a template file.
+ * Docs: https://moonrepo.dev/docs/config/template#frontmatter
+ */
 export interface TemplateFrontmatterConfig {
-	/** @default 'https://moonrepo.dev/schemas/template-frontmatter.json' */
-	$schema?: string;
+	$schema: string;
+	/** Force overwrite a file at the destination if there is a conflict. */
 	force: boolean;
+	/** Skip writing this file to the destination. */
 	skip: boolean;
+	/** Override the destination using a relative file path. */
 	to: string | null;
 }
 
-/** Docs: https://moonrepo.dev/docs/config/template#frontmatter */
+/**
+ * Configures the leading frontmatter within a template file.
+ * Docs: https://moonrepo.dev/docs/config/template#frontmatter
+ */
 export interface PartialTemplateFrontmatterConfig {
-	/** @default 'https://moonrepo.dev/schemas/template-frontmatter.json' */
 	$schema?: string | null;
+	/** Force overwrite a file at the destination if there is a conflict. */
 	force?: boolean | null;
+	/** Skip writing this file to the destination. */
 	skip?: boolean | null;
+	/** Override the destination using a relative file path. */
 	to?: string | null;
 }
 
@@ -68,6 +78,8 @@ export interface TemplateVariableEnumValueConfig {
 export type TemplateVariableEnumValue = string | TemplateVariableEnumValueConfig;
 
 export interface TemplateVariableEnumSetting {
+	/** The default value of the variable if none was provided. */
+	defaultValue?: TemplateVariableEnumDefault;
 	/** The default value of the variable if none was provided. */
 	default: TemplateVariableEnumDefault;
 	/** Marks the variable as internal, and won't be overwritten via CLI arguments. */
@@ -147,8 +159,7 @@ export type TemplateVariable =
  * Docs: https://moonrepo.dev/docs/config/template
  */
 export interface TemplateConfig {
-	/** @default 'https://moonrepo.dev/schemas/template.json' */
-	$schema?: string;
+	$schema: string;
 	/** A description on what the template scaffolds. */
 	description: string;
 	/**
@@ -158,12 +169,12 @@ export interface TemplateConfig {
 	destination: string | null;
 	/** Extends one or many other templates. */
 	extends: Id | Id[];
-	/** Overrides the ID of the template, instead of using the folder name. */
+	/** Overrides the identifier of the template, instead of using the folder name. */
 	id: Id | null;
 	/** A human-readable title for the template. */
 	title: string;
 	/**
-	 * A mapping of variables that'll be interpolated within each template file.
+	 * A map of variables that'll be interpolated within each template file.
 	 * Variables can also be populated by passing command line arguments.
 	 */
 	variables: Record<string, TemplateVariable>;
@@ -215,6 +226,8 @@ export interface PartialTemplateVariableEnumValueConfig {
 export type PartialTemplateVariableEnumValue = string | PartialTemplateVariableEnumValueConfig;
 
 export interface PartialTemplateVariableEnumSetting {
+	/** The default value of the variable if none was provided. */
+	defaultValue?: PartialTemplateVariableEnumDefault | null;
 	/** The default value of the variable if none was provided. */
 	default?: PartialTemplateVariableEnumDefault | null;
 	/** Marks the variable as internal, and won't be overwritten via CLI arguments. */
@@ -294,7 +307,6 @@ export type PartialTemplateVariable =
  * Docs: https://moonrepo.dev/docs/config/template
  */
 export interface PartialTemplateConfig {
-	/** @default 'https://moonrepo.dev/schemas/template.json' */
 	$schema?: string | null;
 	/** A description on what the template scaffolds. */
 	description?: string | null;
@@ -305,12 +317,12 @@ export interface PartialTemplateConfig {
 	destination?: string | null;
 	/** Extends one or many other templates. */
 	extends?: Id | Id[] | null;
-	/** Overrides the ID of the template, instead of using the folder name. */
+	/** Overrides the identifier of the template, instead of using the folder name. */
 	id?: Id | null;
 	/** A human-readable title for the template. */
 	title?: string | null;
 	/**
-	 * A mapping of variables that'll be interpolated within each template file.
+	 * A map of variables that'll be interpolated within each template file.
 	 * Variables can also be populated by passing command line arguments.
 	 */
 	variables?: Record<string, PartialTemplateVariable> | null;

package/src/toolchains-config.ts

@@ -0,0 +1,143 @@
+// Automatically generated by schematic. DO NOT MODIFY!
+
+/* eslint-disable */
+
+import type { ExtendsFrom, Id } from './common';
+
+/** Configures how and where moon updates will be received. */
+export interface MoonConfig {
+	/**
+	 * A secure URL for downloading the moon binary itself.
+	 *
+	 * @default 'https://github.com/moonrepo/moon/releases/latest/download'
+	 */
+	downloadUrl?: string;
+	/**
+	 * A secure URL to lookup the latest available version.
+	 *
+	 * @default 'https://launch.moonrepo.app/moon/check_version'
+	 */
+	manifestUrl?: string;
+}
+
+export type PluginLocator = string;
+
+export type UnresolvedVersionSpec = string;
+
+export type ToolchainPluginVersionFrom = boolean | string;
+
+/** Configures an individual toolchain. */
+export interface ToolchainPluginConfig {
+	/** Arbitrary configuration that'll be passed to the WASM plugin. */
+	config: Record<string, unknown>;
+	/** Location of the WASM plugin to use. */
+	plugin: PluginLocator | null;
+	/** The version of the toolchain to download and install. */
+	version: UnresolvedVersionSpec | null;
+	/**
+	 * Inherit the version from the root `.prototools`.
+	 * When true, matches using the same identifier, otherwise a
+	 * string can be provided for a custom identifier.
+	 */
+	versionFromPrototools: ToolchainPluginVersionFrom;
+}
+
+export type VersionSpec = string;
+
+/** Configures how moon integrates with proto. */
+export interface ProtoConfig {
+	/**
+	 * The version of proto to download and install,
+	 * and to use for installing and running other toolchains.
+	 */
+	version?: VersionSpec;
+}
+
+/**
+ * Configures all toolchains.
+ * Docs: https://moonrepo.dev/docs/config/toolchain
+ */
+export interface ToolchainsConfig {
+	/** @default './cache/schemas/toolchains.json' */
+	$schema?: string;
+	/**
+	 * Extends one or many toolchain configuration files.
+	 * Supports a relative file path or a secure URL.
+	 * @since 1.12.0
+	 */
+	extends: ExtendsFrom | null;
+	/** Configures moon itself. */
+	moon: MoonConfig;
+	/**
+	 * Configures and integrates toolchains into the system using
+	 * a unique identifier.
+	 */
+	plugins: Record<Id, ToolchainPluginConfig>;
+	/** Configures how moon integrates with proto. */
+	proto: ProtoConfig;
+}
+
+/** Configures how and where moon updates will be received. */
+export interface PartialMoonConfig {
+	/**
+	 * A secure URL for downloading the moon binary itself.
+	 *
+	 * @default 'https://github.com/moonrepo/moon/releases/latest/download'
+	 */
+	downloadUrl?: string | null;
+	/**
+	 * A secure URL to lookup the latest available version.
+	 *
+	 * @default 'https://launch.moonrepo.app/moon/check_version'
+	 */
+	manifestUrl?: string | null;
+}
+
+/** Configures an individual toolchain. */
+export interface PartialToolchainPluginConfig {
+	/** Arbitrary configuration that'll be passed to the WASM plugin. */
+	config?: Record<string, unknown> | null;
+	/** Location of the WASM plugin to use. */
+	plugin?: PluginLocator | null;
+	/** The version of the toolchain to download and install. */
+	version?: UnresolvedVersionSpec | null;
+	/**
+	 * Inherit the version from the root `.prototools`.
+	 * When true, matches using the same identifier, otherwise a
+	 * string can be provided for a custom identifier.
+	 */
+	versionFromPrototools?: ToolchainPluginVersionFrom | null;
+}
+
+/** Configures how moon integrates with proto. */
+export interface PartialProtoConfig {
+	/**
+	 * The version of proto to download and install,
+	 * and to use for installing and running other toolchains.
+	 */
+	version?: VersionSpec | null;
+}
+
+/**
+ * Configures all toolchains.
+ * Docs: https://moonrepo.dev/docs/config/toolchain
+ */
+export interface PartialToolchainsConfig {
+	/** @default './cache/schemas/toolchains.json' */
+	$schema?: string | null;
+	/**
+	 * Extends one or many toolchain configuration files.
+	 * Supports a relative file path or a secure URL.
+	 * @since 1.12.0
+	 */
+	extends?: ExtendsFrom | null;
+	/** Configures moon itself. */
+	moon?: PartialMoonConfig | null;
+	/**
+	 * Configures and integrates toolchains into the system using
+	 * a unique identifier.
+	 */
+	plugins?: Record<Id, PartialToolchainPluginConfig> | null;
+	/** Configures how moon integrates with proto. */
+	proto?: PartialProtoConfig | null;
+}