Skip to main content

writeCliBin

@webda/compiler


Function: writeCliBin()

writeCliBin(appPath, packageDescription): { path: string; written: boolean; } | undefined

Defined in: cli-bin.ts:68

Generate the executable of the webda.cli section of package.json

The file is (re)written only when its content changes, with mode 755. A warning is logged when the package.json bin field does not reference it: npm installs only the declared ones.

Parameters​

appPath​

string

the package root

packageDescription​

PackageDescriptor

the package.json content

Returns​

{ path: string; written: boolean; } | undefined

the absolute path of the executable and whether it was written; undefined without webda.cli