diff --git a/README.md b/README.md index dee6756..eb0c548 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,25 @@ # HAR Validator -[![License][license-image]][license-url] [![version][npm-image]][npm-url] [![Build Status][circle-image]][circle-url] +[![license][license-img]][license-url] +[![version][npm-img]][npm-url] +[![super linter][super-linter-img]][super-linter-url] +[![test][test-img]][test-url] +[![release][release-img]][release-url] + +[license-url]: LICENSE +[license-img]: https://badgen.net/github/license/ahmadnassri/node-har-validator + +[npm-url]: https://www.npmjs.com/package/oas-fastify +[npm-img]: https://badgen.net/npm/v/oas-fastify + +[super-linter-url]: https://github.com/ahmadnassri/node-har-validator/actions?query=workflow%3Asuper-linter +[super-linter-img]: https://github.com/ahmadnassri/node-har-validator/workflows/super-linter/badge.svg + +[test-url]: https://github.com/ahmadnassri/node-har-validator/actions?query=workflow%3Atest +[test-img]: https://github.com/ahmadnassri/node-har-validator/workflows/test/badge.svg + +[release-url]: https://github.com/ahmadnassri/node-har-validator/actions?query=workflow%3Arelease +[release-img]: https://github.com/ahmadnassri/node-har-validator/workflows/release/badge.svg > Extremely fast HTTP Archive ([HAR](https://github.com/ahmadnassri/har-spec/blob/master/versions/1.2.md)) validator using JSON Schema. @@ -16,22 +35,9 @@ Please refer to [`har-cli`](https://github.com/ahmadnassri/har-cli) for more inf ## API -**Note**: as of [`v2.0.0`](https://github.com/ahmadnassri/node-har-validator/releases/tag/v2.0.0) this module defaults to Promise based API. _For backward compatibility with `v1.x` an [async/callback API](docs/async.md) is also provided_ +**Note**: as of [`v2.0.0`](https://github.com/ahmadnassri/node-har-validator/releases/tag/v2.0.0) this module defaults to Promise based API. +_For backward compatibility with `v1.x` an [async/callback API](docs/async.md) is also provided_ - [async API](docs/async.md) - [callback API](docs/async.md) - [Promise API](docs/promise.md) _(default)_ - ---- -> Author: [Ahmad Nassri](https://www.ahmadnassri.com/) • -> Github: [@ahmadnassri](https://github.com/ahmadnassri) • -> Twitter: [@ahmadnassri](https://twitter.com/ahmadnassri) - -[license-url]: LICENSE -[license-image]: https://img.shields.io/github/license/ahmadnassri/node-har-validator.svg?style=for-the-badge&logo=circleci - -[circle-url]: https://circleci.com/gh/ahmadnassri/workflows/node-har-validator -[circle-image]: https://img.shields.io/circleci/project/github/ahmadnassri/node-har-validator/master.svg?style=for-the-badge&logo=circleci - -[npm-url]: https://www.npmjs.com/package/har-validator -[npm-image]: https://img.shields.io/npm/v/har-validator.svg?style=for-the-badge&logo=npm diff --git a/docker-compose.yml b/docker-compose.yml index cb9b4c6..1a5f708 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -16,46 +16,7 @@ services: - ./:/tmp/lint environment: RUN_LOCAL: 'true' - VALIDATE_ANSIBLE: 'false' - VALIDATE_ARM: 'false' - VALIDATE_BASH: 'true' - VALIDATE_CLOJURE: 'false' - VALIDATE_CLOUDFORMATION: 'false' - VALIDATE_COFFEE: 'false' - VALIDATE_CSS: 'true' - VALIDATE_DART: 'false' - VALIDATE_DOCKER: 'true' - VALIDATE_EDITORCONFIG: 'true' - VALIDATE_ENV: 'false' - VALIDATE_GO: 'false' - VALIDATE_GROOVY: 'false' - VALIDATE_HTML: 'true' - VALIDATE_JAVASCRIPT_ES: 'false' - VALIDATE_JAVASCRIPT_STANDARD: 'true' - VALIDATE_JSON: 'true' - VALIDATE_JSX: 'true' - VALIDATE_KOTLIN: 'false' - VALIDATE_LUA: 'false' - VALIDATE_MD: 'true' - VALIDATE_OPENAPI: 'true' - VALIDATE_PERL: 'false' - VALIDATE_PHP: 'false' - VALIDATE_PHP_PHPSTAN: 'false' - VALIDATE_PROTOBUF: 'false' - VALIDATE_PYTHON: 'false' - VALIDATE_PYTHON_PYLINT: 'false' - VALIDATE_PYTHON_FLAKE8: 'false' - VALIDATE_POWERSHELL: 'false' - VALIDATE_RAKU: 'false' - VALIDATE_RUBY: 'false' - VALIDATE_STATES: 'false' - VALIDATE_TERRAFORM: 'true' - VALIDATE_TERRAFORM_TERRASCAN: 'true' - VALIDATE_TSX: 'false' - VALIDATE_TYPESCRIPT_ES: 'false' - VALIDATE_TYPESCRIPT_STANDARD: 'false' - VALIDATE_XML: 'false' - VALIDATE_YAML: 'true' + MULTI_STATUS: 'false' test: <<: *node diff --git a/docs/async.md b/docs/async.md index 16d802b..ee53c63 100644 --- a/docs/async.md +++ b/docs/async.md @@ -1,4 +1,4 @@ -## async API +# async API ```js import * as validate from 'har-validator/lib/async' diff --git a/docs/callback.md b/docs/callback.md index 9e850e1..5fd9c9e 100644 --- a/docs/callback.md +++ b/docs/callback.md @@ -1,5 +1,4 @@ - -## Callback API +# Callback API ```js import * as validate from 'har-validator/lib/async' diff --git a/docs/promise.md b/docs/promise.md index eb29ca7..15fb2dd 100644 --- a/docs/promise.md +++ b/docs/promise.md @@ -1,4 +1,4 @@ -## Promise API +# Promise API ```js import * as validate from 'har-validator'