diff --git a/README.md b/README.md index 39ca0aa..26fa786 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,16 @@ Convert Postman collections to OpenAPI definitions. **Try it on the Web: https://kevinswiber.github.io/postman2openapi/** -- [CLI](#cli) - - [Installation](#installation) - - [Usage](#usage) - - [Examples](#examples) -- [JavaScript Library](#javascript-library) - - [Installation](#installation-1) - - [Usage](#usage-1) - - [JavaScript API](#javascript-api) -- [Build](#build) -- [License](#license) +- [CLI](#cli) + - [Installation](#installation) + - [Usage](#usage) + - [Examples](#examples) +- [JavaScript Library](#javascript-library) + - [Installation](#installation-1) + - [Usage](#usage-1) + - [JavaScript API](#javascript-api) +- [Build](#build) +- [License](#license) ## CLI @@ -80,8 +80,8 @@ npm install postman2openapi ### Usage ```js -const collection = require('./collection'); // any Postman collection JSON file -const { transpile } = require('postman2openapi'); +const collection = require("./collection"); // any Postman collection JSON file +const { transpile } = require("postman2openapi"); // Returns a JavaScript object representation of the OpenAPI definition. const openapi = transpile(collection); @@ -93,8 +93,8 @@ console.log(JSON.stringify(openapi, null, 2)); #### transpile(collection: object): object -- collection - An object representing the Postman collection. -- _returns_ - an OpenAPI definition as a JavaScript object. +- collection - An object representing the Postman collection. +- _returns_ - an OpenAPI definition as a JavaScript object. ## Build @@ -104,7 +104,7 @@ To take advantage of build recipes, install [just](https://github.com/casey/just ### `just build` -Builds all projects. +Builds the Rust library and the CLI packages. ### `just test` @@ -114,6 +114,10 @@ Runs all lint checks (`cargo fmt --check`, `cargo clippy`) and runs all tests, i Builds the WebAssembly project and starts a local version of the [postman2openapi site](https://kevinswiber.github.io/postman2openapi/). +### `just prepare` + +Builds the Rust library, the CLI, the Node.js library, and the Web site. Then all tests are run. + ## License Apache License 2.0 (Apache-2.0) diff --git a/justfile b/justfile index 473e1b3..ab82f3a 100644 --- a/justfile +++ b/justfile @@ -1,3 +1,5 @@ +prepare: build-release build-nodejs build-web test + build: cargo build --all diff --git a/web/package-lock.json b/web/package-lock.json index b343540..8b6baba 100644 --- a/web/package-lock.json +++ b/web/package-lock.json @@ -7248,7 +7248,7 @@ }, "wasm": { "name": "postman2openapi", - "version": "1.1.0", + "version": "1.1.1", "license": "Apache-2.0" } },