# caporal-loader

> A simple loader aims to simplify the development of cli applications using [caporal](https://github.com/mattallty/Caporal.js).

Latest version **1.0.1** (published 2019-01-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install caporal-loader
pnpm add caporal-loader
yarn add caporal-loader
bun add caporal-loader
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-01-21 |
| First published | 2019-01-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 9.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | gopherj |

## Links

- npm: https://www.npmjs.com/package/caporal-loader
- Repository: https://github.com/GopherJ/caporal-loader
- Homepage: https://github.com/GopherJ/caporal-loader#readme
- Issues: https://github.com/GopherJ/caporal-loader/issues
- npm.io page: https://npm.io/package/caporal-loader

## Dependencies (1)

- [uti-js](https://npm.io/package/uti-js.md) ^1.0.5

## Recent versions

- 1.0.1 (latest) — 2019-01-21
- 1.0.0 — 2019-01-21

## README

# caporal-loader

A simple loader aims to simplify the development of cli applications using [caporal](https://github.com/mattallty/Caporal.js).


## Installation

```bash
npm i caporal-loader -S

# OR

yarn add caporal-loader
```


## Usage

```javascript
const caporalLoader = require('caporal-loader');
caporalLoader()
    .subcmdsPath('./subcmds')
    .version('1.0.0')
    .description('demo app')
    .parse();
```

**AND** put your subcmds in directory 'subcmds', make them use the following format.

```javascript
const alias = 'ALIAS'; // subcmd alias

const command = {
    name: '', // subcmd's name
    description: '' // subcmd's description
};

const arguments = [
    {
        var: 'NAME', // name to be used in action. e.g. args.NAME  
        description: '',
        complete: () => Promise.resolve([...])
    }
];

const options = [
    {
        var: 'NAME',
        description: '',
        validator: () => {},
        default: '',
        required: '',
        complete: () => Promise.resolve([...])
    }
];

const action = (args, opts, log) => {
    //
};

module.exports = {
    alias,
    command,
    arguments,
    options,
    action
}
```

---
_Source: https://npm.io/package/caporal-loader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._