boats-cli

boats-cli is the unofficial CLI for johndcarmichael/boats which makes it even easier to quickly setup and scaffold the BOATS files in a project.

Early alpha, docs and functionality will change

Table of Contents generated with DocToc

• Quick Start
• Development

Quick Start

1npx @acrontum/boats-cli --help
2npx @acrontum/boats-cli path --help
3npx @acrontum/boats-cli model --help
4npx @acrontum/boats-cli init --help

For an empty boats project:

1mkdir backend-spec
2
3cd backend-spec
4
5npm init --yes
6# npm i --save-dev boats @acrontum/boats-cli
7
8npx @acrontum/boats-cli \
9  path auth/verify --get \
10  path auth/login --post \
11  path auth/logout --get \
12  path auth/refresh-token --get \
13  path albums/:albumId --post --get --patch --delete --list \
14  path albums/:albumId/songs/:songId -crudl \
15  model jwt \
16  model search --type query
17
18npx boats -i src/index.yml -o build/api.json

optionally, since it's long to type:

1npm i --save-dev @acrontum/boats-cli

then you can just run npx bc model test --dry-run.

Development

Configure githooks:

1git config core.hooksPath $(git rev-parse --show-toplevel)/githooks/