Merge branch 'develop' into fix/ruleset-asyncapi-schema-example-valid…

…ation

.circleci/config.yml

@@ -167,7 +167,7 @@ commands:
       - run:
           name: Install ldid
           working_directory: /tmp/ldid
-          command: make install
+          command: sudo make install
 
   lint-code:
     steps:
@@ -193,7 +193,7 @@ commands:
     parameters:
       max-workers:
         type: integer
-        default: 2
+        default: 3
     steps:
       - run: yarn pretest
       - run:
@@ -212,7 +212,7 @@ commands:
         type: string
       max-workers:
         type: integer
-        default: 2
+        default: 3
     steps:
       - compute-hashes
       - restore_cache:
@@ -276,7 +276,7 @@ jobs:
             - test-harness:
                 os: linux
                 node-version: << parameters.node-version >>
-                max-workers: 2
+                max-workers: 3
 
   test-browser:
     docker:
@@ -302,7 +302,7 @@ jobs:
       - test-harness:
           os: windows
           node-version: *node-active-lts
-          max-workers: 2
+          max-workers: 3
 
   build-nix-binaries:
     docker:

.eslintignore

@@ -2,5 +2,6 @@
 /test-harness/tests/
 /packages/*/dist
 /packages/rulesets/src/oas/schemas/validators.ts
+/packages/rulesets/src/arazzo/schemas/validators.ts
 /packages/*/CHANGELOG.md
 packages/formatters/src/html/templates.ts

.github/CODEOWNERS

@@ -1,9 +1,3 @@
 * @stoplightio/oss-spectral
 
-README.md @stoplightio/documentation
-
-toc.json @stoplightio/documentation
-
-/docs @stoplightio/documentation
-
 /packages/rulesets/src/asyncapi @magicmatatjahu @smoya @jonaslagoni

README.md

@@ -2,7 +2,7 @@
 [![CircleCI](https://img.shields.io/circleci/build/github/stoplightio/spectral/develop)](https://circleci.com/gh/stoplightio/spectral) [![npm Downloads](https://img.shields.io/npm/dw/@stoplight/spectral-core?color=blue)](https://www.npmjs.com/package/@stoplight/spectral-core) [![Stoplight Forest](https://img.shields.io/ecologi/trees/stoplightinc)][stoplight_forest]
 
 - **Custom Rulesets**: Create custom rules to lint JSON or YAML objects
-- **Ready-to-use Rulesets**: Validate and lint **OpenAPI v2 & v3.x** and **AsyncAPI** Documents
+- **Ready-to-use Rulesets**: Validate and lint **OpenAPI v2 & v3.x**, **AsyncAPI**, and **Arazzo v1** Documents
 - **API Style Guides**: Automated [API Style Guides](https://stoplight.io/api-style-guides-guidelines-and-best-practices?utm_source=github.com&utm_medium=referral&utm_campaign=github_repo_spectral) using rulesets improve consistency across all your APIs
 - **Ready-to-use Functions**: Built-in set of functions to help [create custom rules](https://meta.stoplight.io/docs/spectral/e5b9616d6d50c-custom-rulesets#adding-rules). Functions include pattern checks, parameter checks, alphabetical ordering, a specified number of characters, provided keys are present in an object, etc.
 - **Custom Functions**: Create custom functions for advanced use cases
@@ -40,10 +40,10 @@ There are also [additional installation options](https://meta.stoplight.io/docs/
 
 Spectral, being a generic YAML/JSON linter, **needs a ruleset** to lint files. A ruleset is a JSON, YAML, or JavaScript/TypeScript file (often the file is called `.spectral.yaml` for a YAML ruleset) that contains a collection of rules, which can be used to lint other JSON or YAML files such as an API description.
 
-To get started, run this command in your terminal to create a `.spectral.yaml` file that uses the Spectral predefined rulesets based on OpenAPI or AsyncAPI:
+To get started, run this command in your terminal to create a `.spectral.yaml` file that uses the Spectral predefined rulesets based on OpenAPI, Arazzo or AsyncAPI:
 
 ```bash
-echo 'extends: ["spectral:oas", "spectral:asyncapi"]' > .spectral.yaml
+echo 'extends: ["spectral:oas", "spectral:asyncapi", "spectral:arazzo"]' > .spectral.yaml
 ```
 
 If you would like to create your own rules, check out the [Custom Rulesets](https://meta.stoplight.io/docs/spectral/01baf06bdd05a-rulesets) page.
@@ -114,7 +114,7 @@ Check out some additional style guides here:
 
 ## 🏁 Help Others Utilize Spectral
 
-If you're using Spectral for an interesting use case, [contact Stoplight](mailto:[email protected]) for a case study. 🎉
+If you're using Spectral for an interesting use case, create an issue with details on how you're using it. We'll add it to a list here. Spread the goodness 🎉
 
 ## 👏 Contributing
 

docs/getting-started/6-arazzo.md

@@ -0,0 +1,7 @@
+# Arazzo Support
+
+Spectral has a built-in [Arazzo v1](https://spec.openapis.org/arazzo/v1.0.0.html) ruleset that you can use to validate your Arazzo files.
+
+Add `extends: "spectral:arazzo"` to your ruleset file to apply rules for Arazzo v1.
+
+You can see a full list of the rules in this ruleset in [Arazzo Rules](../reference/arazzo-rules.md).

docs/guides/2-cli.md

@@ -27,26 +27,26 @@ spectral lint ./reference/**/*.oas*.{json,yml,yaml}
 Other options include:
 
 ```
-      --version                  Show version number                                                           [boolean]
-      --help                     Show help                                                                     [boolean]
+      --version                  Show version number                                                                              [boolean]
+      --help                     Show help                                                                                        [boolean]
   -e, --encoding                 text encoding to use
           [string] [choices: "utf8", "ascii", "utf-8", "utf16le", "ucs2", "ucs-2", "base64", "latin1"] [default: "utf8"]
   -f, --format                   formatters to use for outputting results, more than one can be provided by using
                                  multiple flags
-         [string] [choices: "json", "stylish", "junit", "html", "text", "teamcity", "pretty", "github-actions", "sarif"]
+         [string] [choices: "json", "stylish", "junit", "html", "text", "teamcity", "pretty", "github-actions", "sarif", "markdown","gitlab"]
                                                                                                     [default: "stylish"]
   -o, --output                   where to output results, can be a single file name, multiple "output.<format>" or
                                  missing to print to stdout                                                     [string]
       --stdin-filepath           path to a file to pretend that stdin comes from                                [string]
       --resolver                 path to custom json-ref-resolver instance                                      [string]
   -r, --ruleset                  path/URL to a ruleset file                                                     [string]
   -F, --fail-severity            results of this level or above will trigger a failure exit code
-                                                  [string] [choices: "error", "warn", "info", "hint"] [default: "error"]
-  -D, --display-only-failures    only output results equal to or greater than --fail-severity [boolean] [default: false]
-      --ignore-unknown-format    do not warn about unmatched formats                          [boolean] [default: false]
-      --fail-on-unmatched-globs  fail on unmatched glob patterns                              [boolean] [default: false]
-  -v, --verbose                  increase verbosity                                                            [boolean]
-  -q, --quiet                    no logging - output only                                                      [boolean]
+                                                                     [string] [choices: "error", "warn", "info", "hint"] [default: "error"]
+  -D, --display-only-failures    only output results equal to or greater than --fail-severity                    [boolean] [default: false]
+      --ignore-unknown-format    do not warn about unmatched formats                                             [boolean] [default: false]
+      --fail-on-unmatched-globs  fail on unmatched glob patterns                                                 [boolean] [default: false]
+  -v, --verbose                  increase verbosity                                                                               [boolean]
+  -q, --quiet                    no logging - output only                                                                         [boolean]
 ```
 
 The Spectral CLI supports loading documents as YAML or JSON, and validation of OpenAPI v2/v3 documents via the built-in ruleset.