@telefonica/opensource-scaffold/dist/Creator.types.d.ts

Scaffolding for open source projects. A CLI tool to create open source repositories with standard tools and resources

import type { SupportedLicense } from "./License.types.js";
import type { LogLevel } from "./Logger.types.js";
/** Options for scaffold creator */
export interface CreatorOptions {
    /** Log level */
    log?: LogLevel;
    /** License type */
    license: SupportedLicense;
    /** The project name */
    projectName: string;
    /** The project description */
    projectDescription?: string;
    /** The project copyright holder */
    copyrightHolder?: string;
    /** Whether to overwrite all existing resources */
    overwrite?: boolean;
    /** Repository URL. Including protocol, without trailing slash */
    repositoryUrl: string;
    /** Community email */
    communityEmail?: string;
}
/** Context for templates */
export interface TemplatesContext {
    /** License type */
    license: SupportedLicense;
    /** License FAQ URL */
    licenseFAQ: string;
    /** The project name */
    projectName: string;
    /** The project description */
    projectDescription?: string;
    /** The project copyright holder */
    copyrightHolder?: string;
    /** Repository URL. Including protocol, without trailing slash */
    repositoryUrl: string;
    /** Community email */
    communityEmail?: string;
    /** Current year */
    year: number;
    /** Current date */
    date: string;
}