Sicilian CLI Usage

@ilokesto/sicilian is a CLI tool designed to improve developer productivity and reduce repetitive code. The CLI helps you generate sicilian code snippets quickly and insert them into your project.

help command#

The help command displays usage information and available flags and options for the Sicilian CLI.

npx sicilian help

Running sicilian without arguments also shows the help output.

npx sicilian

generate command#

The generate command creates a new code snippet and inserts it into the specified file.

npx sicilian -g <file_path> [options]

• <file_path>: the file path to add the snippet to. If the file doesn't exist, it will be created; if it does exist, the snippet will be appended. Parent directories will be created if necessary.
• -o, --object: generate an object-style snippet. If omitted, the CLI will default to destructured output.

1. Generate a basic snippet (destructured)#

Use the following command to generate a destructured snippet into src/components/MyForm.tsx.

npx sicilian -g src/components/MyForm.tsx

The command result will append code similar to the example below to src/components/MyForm.tsx:

import { CreateForm } from '@ilokesto/sicilian';

export const sicilianForm = new CreateForm({ 
  initValue: {}, 
  resolver: undefined, 
  validator: {}, 
  validateOn: ["change", "blur", "submit"],
  clearFormOn: ["submit", "routeChange"]
});

2. Generate an object-style snippet#

Use the following command to generate an object-style snippet into src/utils/formHooks.ts.

npx sicilian -g src/utils/formHooks.ts -o

The command result will append code similar to the example below to src/utils/formHooks.ts.

import { CreateForm } from '@ilokesto/sicilian';

export const {
  initValue,
  register,
  getValues,
  getErrors,
  setValues,
  setErrors,
  handleSubmit,
  handleServerAction
} = new CreateForm({ 
  initValue: {}, 
  resolver: undefined, 
  validator: {}, 
  validateOn: ["change", "blur", "submit"],
  clearFormOn: ["submit", "routeChange"]
});