Editful
DocsCLI API

CLI API.

Every public export from @editful/cli.

  • Generated from declarations
  • TSDoc annotations

Functions

Function

scaffoldPlugin

#

Parameters

Parameters and TSDoc annotations
NameTypeStatusDescription
optionsScaffoldPluginOptionsRequiredNo description.
Show raw definition
TypeScript
export declare function scaffoldPlugin(options: ScaffoldPluginOptions): Promise<ScaffoldPluginResult>;

Types

Type

ScaffoldPluginOptions

#

Properties

Properties and TSDoc annotations
NameTypeStatusDescription
namestringRequired · readonlyNo description.
parentDirectorystringOptional · readonlyNo description.
Show raw definition
TypeScript
export interface ScaffoldPluginOptions {
    readonly name: string;
    readonly parentDirectory?: string;
}
Type

ScaffoldPluginResult

#

Properties

Properties and TSDoc annotations
NameTypeStatusDescription
directorystringRequired · readonlyNo description.
namestringRequired · readonlyNo description.
Show raw definition
TypeScript
export interface ScaffoldPluginResult {
    readonly directory: string;
    readonly name: string;
}