open-index/open-npm huggingface dataset:
npm package: @snyk/sweater-comb
Description: “Sweats the small stuff, so you don’t have to. OpenAPI linting rules for Snyk APIs.”
Latest version: 3.8.7

# @snyk/sweater-comb

“Sweats the small stuff, so you don’t have to. OpenAPI linting rules for Snyk APIs.”

## What is Sweater Comb?

At Snyk, we’re starting an API Program whose goal it is to create a beautiful garden of repeatable & concise APIs that empower Snyk customers, partners, and Snyk’ers alike to easily and quickly build new experiences and products.

Such an API needs some guardrails to stay cohesive, consistent and “unsurprising” to its consumers, as the platform scales in the number of concepts it provides and the number of teams delivering them.

Sweater Comb is a tool which provides some of those guardrails with automation, initially by applying custom [Optic CI](https://useoptic.com) rules to Snyk's OpenAPI specifications.

Read more about the project in [Sweater Comb documentation](docs/index.md).

## Installation and Usage

```
npm install @snyk/sweater-comb --save-dev
```

## Contributing

If you are contributing to Sweater Comb, read the [contributing guidelines](CONTRIBUTING.md)

### License

Licensed under the [Apache 2.0 License](LICENSE)

Copyright (c) 2021-present, Snyk Ltd.