Skip to content

Commit

Permalink
Adding prepare in justfile.
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinswiber committed Nov 26, 2023
1 parent 7dd702c commit d276555
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 16 deletions.
34 changes: 19 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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);
Expand All @@ -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

Expand All @@ -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`

Expand All @@ -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)
2 changes: 2 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
prepare: build-release build-nodejs build-web test

build:
cargo build --all

Expand Down
2 changes: 1 addition & 1 deletion web/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d276555

Please sign in to comment.