@snailicide/cli-app 🐌

!License: MIT

Node Cli App Boilerplate with yargs, zod, chalk

---

!NodeJS
!TypeScript
!Zod

- Github:
@snailicide/cli-app
• snailicide-monorepo
- CDN:
jsdeliver

$3

👤 Gillian Tunney

- github
- email

> Recommended package manager is pnpm
>
> 

@snailicide/cli-app 🐌

---

The @snailicide/cli-app package is a builder application for making custom
command-line interface (CLI) application. Developers can quickly bootstrap a
boilerplate with powerful validation/parsing schemas. It leverages several
libraries to provide robust and interactive user experience.

#### Key Features

- Command-Line Parsing: Utilizes yargs and
yargs-interactive
for parsing command-line arguments and handling interactive prompts.
- Schema Validation/Handling: Use zod schemas to parse/validate input,
including resolving user options & application configurations, and generating
Yargs-compatible option objects.
- Configuration Management: Manages application configurations using schemas
defined with zod. This ensures that configurations are
validated and adhere to expected structures.
- Title /HelpScreen Management: Manage custom cli options and customize
appearance of title/help menu terminal output.

---

$3

This library is published in the NPM registry and can be installed using any
compatible package manager as a development dependency.

``sh
#pnpm
pnpm add @snailicide/cli-app

#yarn
yarn add @snailicide/cli-app

#npm
npm install @snailicide/cli-app
`

$3

The cli-app package can be initialized and configured using the initApp
function, which sets up the application based on provided schemas and options,
and supports interactive prompts if needed.

---

`ts
import { z } from 'zod'

import {
AppConfigIn,
commonFlagsSchema,
initApp,
InitSuccessCallback,
WrappedSchema,
wrapSchema,
} from './index.js'

/* Define custom schema, wrapper is required to avoid typescript error /
const custom_schema = z.object({
testarr: z.number().array().default([]).describe('test array'),
testarr2: z.string().array().default([]).describe('test array'),
})
const my_merged_schema = wrapSchema(commonFlagsSchema)
.merge(custom_schema)
.transform((value) => {
return value
})
.describe('this is a sample app that is made of fun')

type MergedSchema = WrappedSchema

/* Set the init function which will be called after app is intialized with typed arguments. /
const initFunc: InitSuccessCallback = <
Schema extends
| z.AnyZodObject
| z.ZodEffects = typeof commonFlagsSchema,
>(
args: z.infer,
) => {
if (args['testarr']) {
console.warn('RESOLVED APP ARGS: ', args)
}
console.log(JSON.stringify(args))
return true
}

/* Example app configuration options /
const exampleAppConfigOptions: AppConfigIn = {
description: 'This is an example to demonstrate use',
//code editor error
examples: [
['$0 --config "~/config.json"', 'Use custom config'],
['$0 --safe', 'Start in safe mode'],
],
flag_aliases: {
outDir: 'o',
rootDir: 'r',
// help: 'h',
//version: 'v',
},
hidden: ['debug', 'testarr2'],
name: 'Example App',
}

/* Initialize App /
const initialize = async (): Promise<'SUCCESS' | 'ERROR'> => {
const instance_yargs = await initApp(
my_merged_schema,
exampleAppConfigOptions,
initFunc,
)
if (instance_yargs === undefined) {
process.exit(1)
return 'ERROR'
}
process.exit(0)
return 'SUCCESS'
}

export default initialize()
``

$3

- yargs
- yargs-interactive
- zod
- chalk
- figlet