cli/create

Interfaces

CreateOptions

Defined in: venpm/src/cli/create.ts:9

Extends

• GlobalOptions

Properties

config?

optional config?: string;

Defined in: venpm/src/core/types.ts:183

Inherited from

GlobalOptions.config

css?

optional css?: boolean;

Defined in: venpm/src/cli/create.ts:11

json?

optional json?: boolean;

Defined in: venpm/src/core/types.ts:187

Inherited from

GlobalOptions.json

jsonStream?

optional jsonStream?: boolean;

Defined in: venpm/src/core/types.ts:188

Inherited from

GlobalOptions.jsonStream

native?

optional native?: boolean;

Defined in: venpm/src/cli/create.ts:12

quiet?

optional quiet?: boolean;

Defined in: venpm/src/core/types.ts:185

Inherited from

GlobalOptions.quiet

tsx?

optional tsx?: boolean;

Defined in: venpm/src/cli/create.ts:10

verbose?

optional verbose?: boolean;

Defined in: venpm/src/core/types.ts:184

Inherited from

GlobalOptions.verbose

yes?

optional yes?: boolean;

Defined in: venpm/src/core/types.ts:186

Inherited from

GlobalOptions.yes

Functions

detectCreateMode()

function detectCreateMode(fs, targetPath): Promise<"repo" | "plugin">;

Defined in: venpm/src/cli/create.ts:52

Walk up ancestor directories from targetPath looking for a venpm plugins.json. Returns "plugin" if found, "repo" otherwise.

Parameters

Parameter	Type
fs	FileSystem
targetPath	string

Returns

Promise<"repo" | "plugin">

---

executeCreate()

function executeCreate(
   ctx, 
   targetPath, 
options): Promise<void>;

Defined in: venpm/src/cli/create.ts:244

Parameters

Parameter	Type
ctx	IOContext
targetPath	string
options	CreateOptions

Returns

Promise<void>

---

findAncestorIndex()

function findAncestorIndex(fs, startPath): Promise<
  | {
  data: Record<string, unknown>;
  path: string;
}
| null>;

Defined in: venpm/src/cli/create.ts:21

Walk up ancestor directories from startPath looking for a plugins.json whose $schema contains "venpm". Returns { path, data } if found, null otherwise.

Parameters

Parameter	Type
fs	FileSystem
startPath	string

Returns

Promise< | { data: Record<string, unknown>; path: string; } | null>

---

registerCreateCommand()

function registerCreateCommand(program): void;

Defined in: venpm/src/cli/create.ts:267

Parameters

Parameter	Type
program	Command

Returns

void