From 9b2f38b8b8080da86f749226aadb2dd4cd2d8e11 Mon Sep 17 00:00:00 2001 From: medric Date: Tue, 18 Jun 2019 10:50:46 +1000 Subject: [PATCH] Release api contract checksum feature (#292) --- README.md | 53 ++++++++++++++++++++++++++-------------------------- package.json | 2 +- 2 files changed, 28 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index dc8c5c198..9d57e7167 100644 --- a/README.md +++ b/README.md @@ -110,6 +110,7 @@ npx @airtasker/spot generate --contract api.ts # Commands +* [`spot checksum SPOT_CONTRACT`](#spot-checksum-spot_contract) * [`spot generate`](#spot-generate) * [`spot help [COMMAND]`](#spot-help-command) * [`spot init`](#spot-init) @@ -118,6 +119,26 @@ npx @airtasker/spot generate --contract api.ts * [`spot test SPOT_CONTRACT`](#spot-test-spot_contract) * [`spot validate SPOT_CONTRACT`](#spot-validate-spot_contract) +## `spot checksum SPOT_CONTRACT` + +Generate a version tag based on a Spot contract + +``` +USAGE + $ spot checksum SPOT_CONTRACT + +ARGUMENTS + SPOT_CONTRACT path to Spot contract + +OPTIONS + -h, --help show CLI help + +EXAMPLE + $ spot mock api.ts +``` + +_See code: [build/cli/src/commands/checksum.js](https://github.com/airtasker/spot/blob/v0.2.14/build/cli/src/commands/checksum.js)_ + ## `spot generate` Runs a generator on an API. Used to produce client libraries, server boilerplates and well-known API contract formats such as OpenAPI. @@ -137,7 +158,7 @@ EXAMPLE $ spot generate --contract api.ts --language yaml --generator openapi3 --out output/ ``` -_See code: [build/cli/src/commands/generate.js](https://github.com/airtasker/spot/blob/v0.2.13/build/cli/src/commands/generate.js)_ +_See code: [build/cli/src/commands/generate.js](https://github.com/airtasker/spot/blob/v0.2.14/build/cli/src/commands/generate.js)_ ## `spot help [COMMAND]` @@ -175,7 +196,7 @@ EXAMPLE - package.json ``` -_See code: [build/cli/src/commands/init.js](https://github.com/airtasker/spot/blob/v0.2.13/build/cli/src/commands/init.js)_ +_See code: [build/cli/src/commands/init.js](https://github.com/airtasker/spot/blob/v0.2.14/build/cli/src/commands/init.js)_ ## `spot lint SPOT_CONTRACT` @@ -195,7 +216,7 @@ EXAMPLE $ spot lint api.ts ``` -_See code: [build/cli/src/commands/lint.js](https://github.com/airtasker/spot/blob/v0.2.13/build/cli/src/commands/lint.js)_ +_See code: [build/cli/src/commands/lint.js](https://github.com/airtasker/spot/blob/v0.2.14/build/cli/src/commands/lint.js)_ ## `spot mock SPOT_CONTRACT` @@ -217,7 +238,7 @@ EXAMPLE $ spot mock api.ts ``` -_See code: [build/cli/src/commands/mock.js](https://github.com/airtasker/spot/blob/v0.2.13/build/cli/src/commands/mock.js)_ +_See code: [build/cli/src/commands/mock.js](https://github.com/airtasker/spot/blob/v0.2.14/build/cli/src/commands/mock.js)_ ## `spot test SPOT_CONTRACT` @@ -243,7 +264,7 @@ EXAMPLES $ spot test api.ts -u http://localhost:3000 -t MyEndpoint:myTest ``` -_See code: [build/cli/src/commands/test.js](https://github.com/airtasker/spot/blob/v0.2.13/build/cli/src/commands/test.js)_ +_See code: [build/cli/src/commands/test.js](https://github.com/airtasker/spot/blob/v0.2.14/build/cli/src/commands/test.js)_ ## `spot validate SPOT_CONTRACT` @@ -263,25 +284,5 @@ EXAMPLE $ spot validate api.ts ``` -_See code: [build/cli/src/commands/validate.js](https://github.com/airtasker/spot/blob/v0.2.13/build/cli/src/commands/validate.js)_ - -## `spot checksum SPOT_CONTRACT` - -Generate a checksum based on a Spot contract - -``` -USAGE - $ spot checksum SPOT_CONTRACT - -ARGUMENTS - SPOT_CONTRACT path to Spot contract - -OPTIONS - -h, --help show CLI help - -EXAMPLE - $ spot checksum api.ts -``` - -_See code: [build/cli/src/commands/validate.js](https://github.com/airtasker/spot/blob/v0.2.13/build/cli/src/commands/validate.js)_ +_See code: [build/cli/src/commands/validate.js](https://github.com/airtasker/spot/blob/v0.2.14/build/cli/src/commands/validate.js)_ diff --git a/package.json b/package.json index ff37e0b14..41039bfd0 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@airtasker/spot", - "version": "0.2.13", + "version": "0.2.14", "author": "Francois Wouts, Leslie Fung", "bin": { "spot": "./bin/run"