New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

creatium

Package Overview
Dependencies
Maintainers
0
Versions
18
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

creatium

<!-- AUTOGEN BY DOVENV - START Do not edit this file -->

  • 0.0.2
  • Source
  • npm
  • Socket score
Version published
Weekly downloads
23
decreased by-48.89%
Maintainers
0
Weekly downloads
 
Created
Source

Creatium

Web About Us Donate Github Twitter Instagram Medium

{{desc}}

Table of contents

🔑 Installation

npm install creatium
# or 
pnpm add creatium
# or 
yarn add creatium
# or 
deno install creatium
# or 
bun add creatium

🤔 What is it Creatium?

Creatium is a CLI and Library for creating project templates.

Useful for create-binaries like pnpm create backan

Read more

🚀 Usage

Create a cli and a library project with creatium

Simple usage example:

Project structure

Create a project with the following structure:

📂 src
  ├── bin.js
  ├── lib.js
  └── main.js
📂 templates
  └── 📂 js-project
  └── 📂 ts-project
📄 package.json

src/main.js

Create a new instance of creatium and export it as core


import { dirname, join } from 'node:path'
import { fileURLToPath } from 'node:url'
import { version }  from './package.json'
import { Creatium } from 'creatium'

const currentDir   = join( dirname( fileURLToPath( import.meta.url ) ) )
const templatesDir = join( currentDir, '..', 'templates' )

export const core = new Creatium( {
 name: 'Simple test',
 version,
 templates : {
  js : {
   input : join( templatesDir, 'js-project' ),
   name  : 'JavaScript project',
  },
  ts : {
   input : join( templatesDir, 'ts-project' ),
   name  : 'TypeScript project',
  },
 },
} )

src/bin.js

Create a bin file and call the cli method of the core instance.


// create cli
import { core } from './main.js'
await core.cli()

src/lib.js

Create a library file and export the create function for use outside.

import { core } from './main.js'

/**
 * Create project template.
 * @param {Parameters<typeof core.build>[0]} params - The parameters required for creation.
 * @returns {Promise<Object>} A promise that resolves to the result of the creation process.
 */
export const create = async ( params ) => {

 return await core.build( params )

}

package.json

{
 "name": "create-{my-library-name}",
 "version": "0.0.1",
 "type": "module",
 "main": "src/lib.js",
 "module": "src/lib.js",
 "bin": {
  "create-{my-library-name}": "bin.js"
 },
 "files": [
  "src",
  "templates",
 ]
}

templates

Create a template folder with your templates.

Api documentation

Classes

Creatium
Constructors
new Creatium()
new Creatium(options: {
  cache: boolean;
  consts: Record<string, string>;
  intro: false | (data: HookParams) => Response<void>;
  name: string;
  onCancel: false | (data: HookParams) => Response<void>;
  opts: {
     install: false | [
        | "deno"
        | "bun"
        | "npm"
        | "pnpm"
        | "yarn", 
        | "deno"
        | "bun"
        | "npm"
        | "pnpm"
        | "yarn", ...("deno" | "bun" | "npm" | "pnpm" | "yarn")[]];
     name: boolean;
     openEditor: false | ["code" | "subl" | "webstorm", "code" | "subl" | "webstorm", ...("code" | "subl" | "webstorm")[]];
    };
  outro: false | (data: HookParams) => Response<void>;
  templates: {};
  updater: boolean;
  version: string;
 }): Creatium
Parameters
ParameterTypeDescription
optionsobject-
options.cache?booleanUse cache Default true
options.consts?Record<string, string>Add consts to use in your templates.
options.intro?false | (data: HookParams) => Response<void>-
options.namestringSet name of you project
options.onCancel?false | (data: HookParams) => Response<void>-
options.opts?object-
options.opts.install?false | [ | "deno" | "bun" | "npm" | "pnpm" | "yarn", | "deno" | "bun" | "npm" | "pnpm" | "yarn", ...("deno" | "bun" | "npm" | "pnpm" | "yarn")[]]-
options.opts.name?boolean-
options.opts.openEditor?false | ["code" | "subl" | "webstorm", "code" | "subl" | "webstorm", ...("code" | "subl" | "webstorm")[]]-
options.outro?false | (data: HookParams) => Response<void>-
options.templatesobjectSet your template ooptions
options.updater?booleanUse updater Default false
options.versionstringSet version of you current project Used in for the updater notifications.
Returns

Creatium

Methods
build()
build(values?: {
  input: string;
  install: PkgManager;
  name: string;
  openEditor: TextEditor;
  output: string;
 }, opts?: CreateOpts): Promise<{
  input: string;
  install: undefined;
  name: undefined;
  openEditor: undefined;
  output: string;
}>

A simplified version of the build method from the main class.

Parameters
ParameterTypeDescription
values?objectThe values to override the CLI prompts. If not set, the CLI prompts will be executed.
values.input?stringSet the input path or the template key
values.install?PkgManagerSet the installer
values.name?stringSet the name of the template
values.openEditor?TextEditorOpen editor
values.output?stringSet the output path
opts?CreateOptsThe options to pass to the CLI.
Returns

Promise<{ input: string; install: undefined; name: undefined; openEditor: undefined; output: string; }>

A promise resolving to the prompt values obtained after executing the CLI.

NameType
input?string
install?undefined
name?undefined
openEditor?undefined
output?string
Examples
// simple usage
await core.build()

// custom usage
await core.build( { args : process.argv.slice(4), hideBin : false } )
cli()
cli(props?: CliOpts): Promise<{
  input: string;
  install: undefined;
  name: undefined;
  openEditor: undefined;
  output: string;
}>

A simplified version of the cli method from the main class. Initializes and executes the command-line interface (CLI) process.

Parameters
ParameterTypeDescription
props?CliOptsOptional CLI options to configure the initialization process.
Returns

Promise<{ input: string; install: undefined; name: undefined; openEditor: undefined; output: string; }>

A promise resolving to the prompt values obtained after executing the CLI.

NameType
input?string
install?undefined
name?undefined
openEditor?undefined
output?string
Examples
// simple usage
await core.cli()

// custom usage
await core.cli( { args : process.argv.slice(4), hideBin : false } )
CreatiumPrompt<C>

Build a CLI with prompts for create project templates.

Example
const core = new CreatiumPrompt({
  name: 'My Project',
  version: '1.0.0',
  ...
})

core.cli()
Type Parameters
Type ParameterDefault typeDescription
C extends ConfigConfig
Accessors
debugMode
Set Signature
set debugMode(value: boolean): void

Force debug mode

Parameters
ParameterType
valueboolean
Returns

void

Constructors
new CreatiumPrompt()
new CreatiumPrompt<C>(config: C): CreatiumPrompt<C>
Parameters
ParameterType
configC
Returns

CreatiumPrompt<C>

Methods
build()
build(values?: { [K in string | number | symbol]: { [K in string | number | symbol]: { [K in string | number | symbol]?: { [K in string | number | symbol]: ((...)[(...)] extends Object ? (...) extends (...) ? (...) : (...) : never)[K] } }[K] }[K] }, opts?: CreateOpts): Promise<{ [K_1 in string | number | symbol]?: (C["prompt"][K_1] extends Object ? T_2 extends keyof OptionsClasses ? ("prompt" extends keyof (...)[(...)] ? Awaited<ReturnType<(...)>> : never) extends T_7 ? { [K_3 in string | number | symbol]: ((...) extends (...) ? (...) : (...))[K_3] } : never : never : never) extends T_5 ? { [K_2 in string | number | symbol]: (C["prompt"][K_1] extends Object ? T_2 extends keyof OptionsClasses ? ((...) extends (...) ? (...) : (...)) extends T_6 ? { [K_3 in (...)]: (...) } : never : never : never)[K_2] } : never } extends T ? { [K in string | number | symbol]: { [K_1 in string | number | symbol]?: (C["prompt"][K_1] extends Object ? T_2 extends keyof OptionsClasses ? ((...) extends (...) ? (...) : (...)) extends T_4 ? { [K_3 in (...)]: (...) } : never : never : never) extends T_1 ? { [K_2 in string | number | symbol]: ((...)[(...)] extends Object ? (...) extends (...) ? (...) : (...) : never)[K_2] } : never }[K] } : never>

Initialize the CLI and executes the callback function passed in the config.

Parameters
ParameterTypeDescription
values?{ [K in string | number | symbol]: { [K in string | number | symbol]: { [K in string | number | symbol]?: { [K in string | number | symbol]: ((...)[(...)] extends Object ? (...) extends (...) ? (...) : (...) : never)[K] } }[K] }[K] }The values to override the CLI prompts. If not set, the CLI prompts will be executed.
opts?CreateOptsThe options to pass to the CLI.
Returns

Promise<{ [K_1 in string | number | symbol]?: (C["prompt"][K_1] extends Object ? T_2 extends keyof OptionsClasses ? ("prompt" extends keyof (...)[(...)] ? Awaited<ReturnType<(...)>> : never) extends T_7 ? { [K_3 in string | number | symbol]: ((...) extends (...) ? (...) : (...))[K_3] } : never : never : never) extends T_5 ? { [K_2 in string | number | symbol]: (C["prompt"][K_1] extends Object ? T_2 extends keyof OptionsClasses ? ((...) extends (...) ? (...) : (...)) extends T_6 ? { [K_3 in (...)]: (...) } : never : never : never)[K_2] } : never } extends T ? { [K in string | number | symbol]: { [K_1 in string | number | symbol]?: (C["prompt"][K_1] extends Object ? T_2 extends keyof OptionsClasses ? ((...) extends (...) ? (...) : (...)) extends T_4 ? { [K_3 in (...)]: (...) } : never : never : never) extends T_1 ? { [K_2 in string | number | symbol]: ((...)[(...)] extends Object ? (...) extends (...) ? (...) : (...) : never)[K_2] } : never }[K] } : never>

The result of the callback function.

cli()
cli(props?: CliOpts): Promise<{ [K_1 in string | number | symbol]?: (C["prompt"][K_1] extends Object ? T_2 extends keyof OptionsClasses ? ("prompt" extends keyof (...)[(...)] ? Awaited<ReturnType<(...)>> : never) extends T_7 ? { [K_3 in string | number | symbol]: ((...) extends (...) ? (...) : (...))[K_3] } : never : never : never) extends T_5 ? { [K_2 in string | number | symbol]: (C["prompt"][K_1] extends Object ? T_2 extends keyof OptionsClasses ? ((...) extends (...) ? (...) : (...)) extends T_6 ? { [K_3 in (...)]: (...) } : never : never : never)[K_2] } : never } extends T ? { [K in string | number | symbol]: { [K_1 in string | number | symbol]?: (C["prompt"][K_1] extends Object ? T_2 extends keyof OptionsClasses ? ((...) extends (...) ? (...) : (...)) extends T_4 ? { [K_3 in (...)]: (...) } : never : never : never) extends T_1 ? { [K_2 in string | number | symbol]: ((...)[(...)] extends Object ? (...) extends (...) ? (...) : (...) : never)[K_2] } : never }[K] } : never>

Initializes and executes the command-line interface (CLI) process.

Parameters
ParameterTypeDescription
props?CliOptsOptional CLI options to configure the initialization process.
Returns

Promise<{ [K_1 in string | number | symbol]?: (C["prompt"][K_1] extends Object ? T_2 extends keyof OptionsClasses ? ("prompt" extends keyof (...)[(...)] ? Awaited<ReturnType<(...)>> : never) extends T_7 ? { [K_3 in string | number | symbol]: ((...) extends (...) ? (...) : (...))[K_3] } : never : never : never) extends T_5 ? { [K_2 in string | number | symbol]: (C["prompt"][K_1] extends Object ? T_2 extends keyof OptionsClasses ? ((...) extends (...) ? (...) : (...)) extends T_6 ? { [K_3 in (...)]: (...) } : never : never : never)[K_2] } : never } extends T ? { [K in string | number | symbol]: { [K_1 in string | number | symbol]?: (C["prompt"][K_1] extends Object ? T_2 extends keyof OptionsClasses ? ((...) extends (...) ? (...) : (...)) extends T_4 ? { [K_3 in (...)]: (...) } : never : never : never) extends T_1 ? { [K_2 in string | number | symbol]: ((...)[(...)] extends Object ? (...) extends (...) ? (...) : (...) : never)[K_2] } : never }[K] } : never>

A promise resolving to the prompt values obtained after executing the CLI.

Examples
// simple usage
`await core.cli()`

// custom usage
`await core.cli( { args : process.argv.slice( 4), hideBin : false } )`
createTemplate()
createTemplate(values: CreateTemplateOpts): Promise<void>

Create a new project template.

Parameters
ParameterTypeDescription
valuesCreateTemplateOptsThe values to create the template.
Returns

Promise<void>

  • A promise that resolves when the template is created.
Examples
// basic usage
await core.createTemplate( { input : 'my/template/path', output : 'my/project/path' } )

// custom usage
await core.createTemplate( {
  input : 'my/template/path',
  output : 'my/project/path',
  install : 'pnpm',
  open : 'vscode',
  consts : {
    version : '1.0.0',
    header : '// Template generated by Creatium. a project from PigeonPosse',
  },
} )
Properties
PropertyType
configC
utils{ env: typeof env; prompt: { box: (opts: { opts: Options; type: PromptLineMethod; value: string; }) => void; cancel: (message?: string) => void; columns: (opts: { opts: GlobalOptions; type: PromptLineMethod; value: ColumnData; }) => void; confirm: (opts: ConfirmOptions) => Promise<boolean | symbol>; group: <T>(prompts: PromptGroup<T>, opts?: PromptGroupOptions<T>) => Promise<{ [P in string | number | symbol]: PromptGroupAwaitedReturn<T>[P] }>; groupMultiselect: <Value>(opts: GroupMultiSelectOptions<Value>) => Promise<symbol | Value[]>; intro: (title?: string) => void; isCancel: (value: unknown) => value is symbol; log: { error: (message: string) => void; info: (message: string) => void; message: (message?: string, __namedParameters?: LogMessageOptions) => void; step: (message: string) => void; success: (message: string) => void; warn: (message: string) => void; warning: (message: string) => void; }; multiselect: <Value>(opts: MultiSelectOptions<Value>) => Promise<symbol | Value[]>; note: (message?: string, title?: string) => void; number: (opts: { defaultValue: string; errorText: string; initialValue: string; message: string; placeholder: string; validate: (value: string) => string | void; }) => Promise<number | symbol>; outro: (message?: string) => void; password: (opts: PasswordOptions) => Promise<string | symbol>; select: <Value>(opts: SelectOptions<Value>) => Promise<symbol | Value>; selectKey: <Value>(opts: SelectOptions<Value>) => Promise<symbol | Value>; spinner: () => { message: (msg?: string) => void; start: (msg?: string) => void; stop: (msg?: string, code?: number) => void; }; table: (opts: { opts: TableUserConfig; type: PromptLineMethod; value: TableData; }) => void; tasks: (tasks: Task[]) => Promise<void>; text: (opts: TextOptions) => Promise<string | symbol>; }; style: typeof style; }
utils.envtypeof env
utils.prompt{ box: (opts: { opts: Options; type: PromptLineMethod; value: string; }) => void; cancel: (message?: string) => void; columns: (opts: { opts: GlobalOptions; type: PromptLineMethod; value: ColumnData; }) => void; confirm: (opts: ConfirmOptions) => Promise<boolean | symbol>; group: <T>(prompts: PromptGroup<T>, opts?: PromptGroupOptions<T>) => Promise<{ [P in string | number | symbol]: PromptGroupAwaitedReturn<T>[P] }>; groupMultiselect: <Value>(opts: GroupMultiSelectOptions<Value>) => Promise<symbol | Value[]>; intro: (title?: string) => void; isCancel: (value: unknown) => value is symbol; log: { error: (message: string) => void; info: (message: string) => void; message: (message?: string, __namedParameters?: LogMessageOptions) => void; step: (message: string) => void; success: (message: string) => void; warn: (message: string) => void; warning: (message: string) => void; }; multiselect: <Value>(opts: MultiSelectOptions<Value>) => Promise<symbol | Value[]>; note: (message?: string, title?: string) => void; number: (opts: { defaultValue: string; errorText: string; initialValue: string; message: string; placeholder: string; validate: (value: string) => string | void; }) => Promise<number | symbol>; outro: (message?: string) => void; password: (opts: PasswordOptions) => Promise<string | symbol>; select: <Value>(opts: SelectOptions<Value>) => Promise<symbol | Value>; selectKey: <Value>(opts: SelectOptions<Value>) => Promise<symbol | Value>; spinner: () => { message: (msg?: string) => void; start: (msg?: string) => void; stop: (msg?: string, code?: number) => void; }; table: (opts: { opts: TableUserConfig; type: PromptLineMethod; value: TableData; }) => void; tasks: (tasks: Task[]) => Promise<void>; text: (opts: TextOptions) => Promise<string | symbol>; }
utils.prompt.box(opts: { opts: Options; type: PromptLineMethod; value: string; }) => void
utils.prompt.cancel(message?: string) => void
utils.prompt.columns(opts: { opts: GlobalOptions; type: PromptLineMethod; value: ColumnData; }) => void
utils.prompt.confirm(opts: ConfirmOptions) => Promise<boolean | symbol>
utils.prompt.group<T>(prompts: PromptGroup<T>, opts?: PromptGroupOptions<T>) => Promise<{ [P in string | number | symbol]: PromptGroupAwaitedReturn<T>[P] }>
utils.prompt.groupMultiselect<Value>(opts: GroupMultiSelectOptions<Value>) => Promise<symbol | Value[]>
utils.prompt.intro(title?: string) => void
utils.prompt.isCancel(value: unknown) => value is symbol
utils.prompt.log{ error: (message: string) => void; info: (message: string) => void; message: (message?: string, __namedParameters?: LogMessageOptions) => void; step: (message: string) => void; success: (message: string) => void; warn: (message: string) => void; warning: (message: string) => void; }
utils.prompt.log.error(message: string) => void
utils.prompt.log.info(message: string) => void
utils.prompt.log.message(message?: string, __namedParameters?: LogMessageOptions) => void
utils.prompt.log.step(message: string) => void
utils.prompt.log.success(message: string) => void
utils.prompt.log.warn(message: string) => void
utils.prompt.log.warning(message: string) => void
utils.prompt.multiselect<Value>(opts: MultiSelectOptions<Value>) => Promise<symbol | Value[]>
utils.prompt.note(message?: string, title?: string) => void
utils.prompt.number(opts: { defaultValue: string; errorText: string; initialValue: string; message: string; placeholder: string; validate: (value: string) => string | void; }) => Promise<number | symbol>
utils.prompt.outro(message?: string) => void
utils.prompt.password(opts: PasswordOptions) => Promise<string | symbol>
utils.prompt.select<Value>(opts: SelectOptions<Value>) => Promise<symbol | Value>
utils.prompt.selectKey<Value>(opts: SelectOptions<Value>) => Promise<symbol | Value>
utils.prompt.spinner() => { message: (msg?: string) => void; start: (msg?: string) => void; stop: (msg?: string, code?: number) => void; }
utils.prompt.table(opts: { opts: TableUserConfig; type: PromptLineMethod; value: TableData; }) => void
utils.prompt.tasks(tasks: Task[]) => Promise<void>
utils.prompt.text(opts: TextOptions) => Promise<string | symbol>
utils.styletypeof style

Type Aliases

CliOpts
type CliOpts: {
  args: string[];
  hideBin: boolean;
};
Type declaration
NameTypeDescription
args?string[]Arguments to pass to the command Default process.argv.slice(2)
hideBin?booleanHide the first two arguments Default false
Config
type Config: {
  cache: boolean;
  hooks: {
     afterPrompt: <D>(data: D) => Response<D | undefined>;
     beforePrompt: <D>(data: D) => Response<D | undefined>;
    };
  intro: (data: HookParams) => Response<void> | false;
  name: string;
  onCancel: (data: HookParams) => Response<void> | false;
  outro: (data: HookParams) => Response<void> | false;
  prompt: OptionsParams;
  updater: boolean;
  version: string;
};
Type declaration
NameTypeDescription
cache?booleanUse cache Default true
hooks?{ afterPrompt: <D>(data: D) => Response<D | undefined>; beforePrompt: <D>(data: D) => Response<D | undefined>; }hooks for
hooks.afterPrompt?<D>(data: D) => Response<D | undefined>-
hooks.beforePrompt?<D>(data: D) => Response<D | undefined>-
intro?(data: HookParams) => Response<void> | false-
namestringSet name of you project
onCancel?(data: HookParams) => Response<void> | false-
outro?(data: HookParams) => Response<void> | false-
promptOptionsParamsSet you prompts config
updater?booleanUse updater Default false
versionstringSet version of you current project Used in for the updater notifications.
CreateOpts
type CreateOpts: CliOpts & {
  activeCli: boolean;
};
Type declaration
NameTypeDescription
activeCli?booleanOptions for activate cli. Default true
CreateTemplateOpts
type CreateTemplateOpts: {
  consts: Record<string, string>;
  input: string;
  install: PkgManager;
  name: string;
  openEditor: TextEditor;
  output: string;
};
Type declaration
NameTypeDescription
consts?Record<string, string>Add consts to use in your templates.
input?stringSet the input path or the template key
install?PkgManagerSet the installer
name?stringSet the name of the template
openEditor?TextEditorOpen editor
output?stringSet the output path

Variables

OPTIONS
const OPTIONS: {
  array: "array";
  boolean: "boolean";
  install: "install";
  multiselect: "multiselect";
  name: "name";
  number: "number";
  openEditor: "openEditor";
  output: "output";
  path: "path";
  select: "select";
  template: "template";
  text: "text";
  void: "void";
};

Object of the CREATIUM types

Type declaration
NameType
array"array"
boolean"boolean"
install"install"
multiselect"multiselect"
name"name"
number"number"
openEditor"openEditor"
output"output"
path"path"
select"select"
template"template"
text"text"
void"void"
prompt
const prompt: {
  box: (opts: {
     opts: BoxParams[1];
     type: PromptLineMethod;
     value: BoxParams[0];
    }) => void;
  cancel: (message?: string) => void;
  columns: (opts: {
     opts: ColumnsParams[1];
     type: PromptLineMethod;
     value: ColumnsParams[0];
    }) => void;
  confirm: (opts: _clack_prompts.ConfirmOptions) => Promise<boolean | symbol>;
  group: <T>(prompts: _clack_prompts.PromptGroup<T>, opts?: _clack_prompts.PromptGroupOptions<T>) => Promise<{ [P in keyof _clack_prompts.PromptGroupAwaitedReturn<T>]: _clack_prompts.PromptGroupAwaitedReturn<T>[P] }>;
  groupMultiselect: <Value>(opts: _clack_prompts.GroupMultiSelectOptions<Value>) => Promise<symbol | Value[]>;
  intro: (title?: string) => void;
  isCancel: typeof _clack_prompts.isCancel;
  log: {
     error: (message: string) => void;
     info: (message: string) => void;
     message: (message?: string, { symbol }?: _clack_prompts.LogMessageOptions) => void;
     step: (message: string) => void;
     success: (message: string) => void;
     warn: (message: string) => void;
     warning: (message: string) => void;
    };
  multiselect: <Value>(opts: _clack_prompts.MultiSelectOptions<Value>) => Promise<symbol | Value[]>;
  note: (message?: string, title?: string) => void;
  number: typeof number;
  outro: (message?: string) => void;
  password: (opts: _clack_prompts.PasswordOptions) => Promise<string | symbol>;
  select: <Value>(opts: _clack_prompts.SelectOptions<Value>) => Promise<symbol | Value>;
  selectKey: <Value>(opts: _clack_prompts.SelectOptions<Value>) => Promise<symbol | Value>;
  spinner: () => {
     message: (msg?: string) => void;
     start: (msg?: string) => void;
     stop: (msg?: string, code?: number) => void;
    };
  table: (opts: {
     opts: TableParams[1];
     type: PromptLineMethod;
     value: TableParams[0];
    }) => void;
  tasks: (tasks: _clack_prompts.Task[]) => Promise<void>;
  text: (opts: _clack_prompts.TextOptions) => Promise<string | symbol>;
};
Type declaration
NameType
box(opts: { opts: BoxParams[1]; type: PromptLineMethod; value: BoxParams[0]; }) => void
cancel(message?: string) => void
columns(opts: { opts: ColumnsParams[1]; type: PromptLineMethod; value: ColumnsParams[0]; }) => void
confirm(opts: _clack_prompts.ConfirmOptions) => Promise<boolean | symbol>
group<T>(prompts: _clack_prompts.PromptGroup<T>, opts?: _clack_prompts.PromptGroupOptions<T>) => Promise<{ [P in keyof _clack_prompts.PromptGroupAwaitedReturn<T>]: _clack_prompts.PromptGroupAwaitedReturn<T>[P] }>
groupMultiselect<Value>(opts: _clack_prompts.GroupMultiSelectOptions<Value>) => Promise<symbol | Value[]>
intro(title?: string) => void
isCanceltypeof _clack_prompts.isCancel
log{ error: (message: string) => void; info: (message: string) => void; message: (message?: string, { symbol }?: _clack_prompts.LogMessageOptions) => void; step: (message: string) => void; success: (message: string) => void; warn: (message: string) => void; warning: (message: string) => void; }
log.error(message: string) => void
log.info(message: string) => void
log.message(message?: string, { symbol }?: _clack_prompts.LogMessageOptions) => void
log.step(message: string) => void
log.success(message: string) => void
log.warn(message: string) => void
log.warning(message: string) => void
multiselect<Value>(opts: _clack_prompts.MultiSelectOptions<Value>) => Promise<symbol | Value[]>
note(message?: string, title?: string) => void
numbertypeof number
outro(message?: string) => void
password(opts: _clack_prompts.PasswordOptions) => Promise<string | symbol>
select<Value>(opts: _clack_prompts.SelectOptions<Value>) => Promise<symbol | Value>
selectKey<Value>(opts: _clack_prompts.SelectOptions<Value>) => Promise<symbol | Value>
spinner() => { message: (msg?: string) => void; start: (msg?: string) => void; stop: (msg?: string, code?: number) => void; }
table(opts: { opts: TableParams[1]; type: PromptLineMethod; value: TableParams[0]; }) => void
tasks(tasks: _clack_prompts.Task[]) => Promise<void>
text(opts: _clack_prompts.TextOptions) => Promise<string | symbol>

Namespaces

👨‍💻 Development

creatium is an open-source project and its development is open to anyone who wants to participate.

Issues Pull requests Read more

☕ Donate

Help us to develop more interesting things.

Donate

📜 License

This software is licensed with GPL-3.0.

Read more

🐦 About us

PigeonPosse is a ✨ code development collective ✨ focused on creating practical and interesting tools that help developers and users enjoy a more agile and comfortable experience. Our projects cover various programming sectors and we do not have a thematic limitation in terms of projects.

More

Web About Us Donate Github Twitter Instagram Medium

FAQs

Package last updated on 30 Nov 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

Create React App Officially Deprecated Amid React 19 Compatibility Issues

Security News

Create React App Officially Deprecated Amid React 19 Compatibility Issues

Create React App is officially deprecated due to React 19 issues and lack of maintenance—developers should switch to Vite or other modern alternatives.

By Sarah Gooding  -  Feb 11, 2025
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc