# @microsoft.azure/format-spec

> Loads an OpenAPI/Swagger file, sorts the file (ensuring that significant fields float to the top), and can output the file with clean indenting, to either JSON or YAML

Latest version **1.0.6** (published 2018-02-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install @microsoft.azure/format-spec
pnpm add @microsoft.azure/format-spec
yarn add @microsoft.azure/format-spec
bun add @microsoft.azure/format-spec
```

Provides the command `format-spec`.

## 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.6 |
| Published | 2018-02-08 |
| First published | 2018-02-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 15.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | fearthecowboy, windowsazure |

## Links

- npm: https://www.npmjs.com/package/@microsoft.azure/format-spec
- npm.io page: https://npm.io/package/@microsoft.azure/format-spec

## Dependencies (5)

- [chalk](https://npm.io/package/chalk.md) 2.3.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.10.0
- [strip-bom](https://npm.io/package/strip-bom.md) 3.0.0
- [@microsoft.azure/tasks](https://npm.io/package/@microsoft.azure/tasks.md) ^2.0.12
- [@microsoft.azure/async-io](https://npm.io/package/@microsoft.azure/async-io.md) ^1.0.24

## Recent versions

- 1.0.6 (latest) — 2018-02-08
- 1.0.5 (preview) — 2018-02-08
- 1.0.4 — 2018-02-08
- 1.0.3 — 2018-02-08
- 1.0.2 — 2018-02-08
- 1.0.0 — 2018-02-08
- 1.0.1 — 2018-02-08

## README

# Format-spec

Loads an OpenAPI/Swagger file, sorts the file (ensuring that significant fields float to the top), and can output the file with clean indenting, to either JSON or YAML

## Usage:

**format-spec** __[--switches]__ **<input-file>** __[ouptut-file(s)...]__

  `input-file` can be either a .json or .yaml file 
  `output-file` can be a list of filenames: 
    files that end in `.json` will be JSON format
    files that end in `.yaml` will be YAML format

### Switches
 `--json`       -- prints the file to stdout as JSON
 `--yaml`       -- prints the file to stdout as YAML
 `--indent=N`   -- sets indentation to N (defaults to 2 spaces)
 `--no-sort`    -- doesn't sort the file

### install it globally
> npm install -g "@microsoft-azure/format-spec" 

### Example: formats/sorts a spec and saves it as a new file
> format-spec someswagger.json formattedswagger.json

### Example: formats/sorts a spec and saves it as the same file 
> format-spec someswagger.json someswagger.json

### Example: formats/sorts a spec and saves it as a yaml file.
> format-spec someswagger.json someswagger.yaml

### Example: formats (doesn't sort) a spec and saves it as a yaml file.
> format-spec --no-sort someswagger.json someswagger.yaml 

### Example: Run without installing 
> npx "@microsoft-azure/format-spec" someswagger.json someswagger.yaml 

# Contributing

This project welcomes contributions and suggestions.  Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

---
_Source: https://npm.io/package/@microsoft.azure/format-spec · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._