@stoplight/spectral - npm Package Compare versions

Comparing version 1.2.0 to 2.0.0

package.json

 {
   "name": "@stoplight/spectral",
-  "version": "1.2.0",
+  "version": "2.0.0",
   "description": "A flexible object linter with out of the box support for OpenAPI v2 and v3.",
@@ -18,3 +18,4 @@ "keywords": [
   "files": [
-    "**/*"
+    "./*",
+    "src/**/*"
   ],
@@ -31,9 +32,27 @@ "author": "Stoplight <[e-mail]>",
   "dependencies": {
-    "@stoplight/json": "1.x.x",
-    "@stoplight/types": "3.x.x",
+    "@oclif/command": "^1.0",
+    "@oclif/plugin-help": "^2.0",
+    "@stoplight/json": "^1.8.0",
+    "@stoplight/json-ref-resolver": "^1.2.2",
+    "@stoplight/types": "^4.0.0",
+    "@stoplight/yaml": "^2.1.1",
     "ajv": "6.x.x",
+    "chalk": "^2.4.2",
     "jsonpath": "https://github.com/stoplightio/jsonpath#78140eb1980d4ff385780e2fa12177735685ec3e",
-    "lodash": ">=4.17.5"
+    "lodash": ">=4.17.5",
+    "node-fetch": "2.x.x",
+    "strip-ansi": "^5.2.0",
+    "text-table": "^0.2.0"
   },
-  "typings": "index.d.ts"
+  "typings": "index.d.ts",
+  "bin": {
+    "spectral": "./bin/run"
+  },
+  "oclif": {
+    "commands": "./cli/commands",
+    "bin": "spectral",
+    "plugins": [
+      "@oclif/plugin-help"
+    ]
+  }
 }

README.md

@@ -6,12 +6,12 @@ ![Spectral logo](img/spectral-banner.png)
 
-A flexible JSON object linter with out of the box support for OpenAPI Specification 2 and 3
+A flexible JSON object linter with out of the box support for OpenAPI v2 and v3
 
 ## Features
 
-- Create custom rules to lint _any JSON object_.
-- Use JSON paths to apply rules / functions to specific parts of your JSON objects.
-- Built-in set of functions to help build custom rules. Functions include pattern checks, parameter checks, alphabetical ordering, a specified number of characters, provided keys are present in an object, etc.
-- Create custom functions for advanced use cases.
-- Optional ready to use rules and functions to validate and lint OpenAPI Specification (OAS) 2 _and_ 3 documents.
-- Validate JSON with [Ajv](https://github.com/epoberezkin/ajv).
+- Create custom rules to lint _any JSON object_
+- Use JSON paths to apply rules / functions to specific parts of your JSON objects
+- Built-in set of functions to help [build custom rules](#creating-a-custom-rule). Functions include pattern checks, parameter checks, alphabetical ordering, a specified number of characters, provided keys are present in an object, etc
+- [Create custom functions](#creating-a-custom-function) for advanced use cases
+- Optional ready to use rules and functions to validate and lint [OpenAPI v2 _and_ v3 documents](#example-linting-an-openapi-document)
+- Validate JSON with [Ajv](https://github.com/epoberezkin/ajv)
 
@@ -24,6 +24,77 @@ ## Installation
 
-Supports Node v8.3+ and modern browsers.
+Supports Node v8.3+.
 
 ## Usage
 
+### CLI
+
+Spectral can be run via the command-line:
+
+```bash
+spectral lint petstore.yaml
+```
+
+Other options include:
+
+``` text
+  -e, --encoding=encoding      [default: utf8] text encoding to use
+  -f, --format=json|stylish    [default: stylish] formatter to use for outputting results
+  -h, --help                   show CLI help
+  -m, --maxResults=maxResults  [default: all] maximum results to show
+  -o, --output=output          output to a file instead of stdout
+  -v, --verbose                increase verbosity
+```
+
+> Note: The Spectral CLI supports both YAML and JSON.
+
+Currently, the CLI supports validation of OpenAPI documents and lints them based on our default ruleset. It does not support custom rulesets at this time. Although if you want to build and run custom rulesets outside of the CLI, see [Customization](#Customization).
+
+### Example: Linting an OpenAPI document
+
+Spectral includes a number of ready made rules and functions for OpenAPI v2 and v3 documents.
+
+This example uses the OpenAPI v3 rules to lint a document.
+
+```javascript
+const { Spectral } = require('@stoplight/spectral');
+const { oas3Functions, oas3Rules } = require('@stoplight/spectral/rulesets/oas3');
+
+// an OASv3 document
+const myOAS = {
+  // ... properties in your document
+  responses: {
+    '200': {
+      description: '',
+      schema: {
+        $ref: '#/definitions/error-response',
+      },
+    },
+  },
+  // ... properties in your document
+};
+
+// create a new instance of spectral with all of the baked in rulesets
+const spectral = new Spectral();
+
+spectral.addFunctions(oas3Functions());
+spectral.addRules(oas3Rules());
+
+spectral.addRules({
+  // .. extend with your own custom rules
+});
+
+// run!
+spectral.run(myOAS).then(results => {
+  console.log(JSON.stringify(results, null, 4));
+});
+```
+
+You can also [add to these rules](#Creating-a-custom-rule) to create a customized linting style guide for your OpenAPI documents.
+
+The existing OAS rules are opinionated. There might be some rules that you prefer to change. We encourage you to create your rules to fit your use case. We welcome additions to the existing rulesets as well!
+
+## Advanced
+
+### Customization
+
 There are two key concepts in Spectral: **Rules** and **Functions**.
@@ -36,3 +107,3 @@
 
-### Creating a custom rule
+#### Creating a custom rule
 
@@ -62,25 +133,21 @@ Spectral has a built-in set of functions which you can reference in your rules. This example uses the `RuleFunction.PATTERN` to create a rule that checks that all property values are in snake case.
 
-const results = spectral.run({
-  name: 'helloWorld',
+// run!
+spectral.run({name: 'helloWorld',}).then(results => {
+  console.log(JSON.stringify(results, null, 4));
 });
 
-console.log(JSON.stringify(results, null, 4));
-
 // => outputs a single result since `helloWorld` is not snake_case
-// {
-//   "results": [
-//     {
-//       "name": "snake_case",
-//       "message": "must match the pattern '^[a-z]+[a-z0-9_]*[a-z0-9]+$'",
-//       "severity": 40,
-//       "severityLabel": "warn",
-//       "path": [
-//         "name"
-//       ]
-//     }
-//   ]
-// }
+// [
+//   {
+//     "code": "snake_case",
+//     "message": "must match the pattern '^[a-z]+[a-z0-9_]*[a-z0-9]+$'",
+//     "severity": 1,
+//     "path": [
+//       "name"
+//     ]
+//   }
+// ]
 ```
 
-### Creating a custom function:
+#### Creating a custom function
 
@@ -132,70 +199,22 @@ Sometimes the built-in functions don't cover your use case. This example creates a custom function, `customNotThatFunction`, and then uses it within a rule, `openapi_not_swagger`. The custom function checks that you are not using a specific string (e.g., "Swagger") and suggests what to use instead (e.g., "OpenAPI").
 
-const results = spectral.run({
-  description: 'Swagger is pretty cool!',
+// run!
+spectral.run({description: 'Swagger is pretty cool!',}).then(results => {
+  console.log(JSON.stringify(results, null, 4));
 });
 
-console.log(JSON.stringify(results, null, 4));
-
 // => outputs a single result since we are using the term `Swagger` in our object
-// {
-//   "results": [
-//     {
-//       "name": "openapi_not_swagger",
-//       "message": "Use OpenAPI instead of Swagger!",
-//       "severity": 40,
-//       "severityLabel": "warn",
-//       "path": [
-//         "description"
-//       ]
-//     }
-//   ]
-// }
+// [
+//   {
+//     "code": "openapi_not_swagger",
+//     "message": "Use OpenAPI instead of Swagger!",
+//     "severity": 1,
+//     "path": [
+//       "description"
+//     ]
+//   }
+// ]
 ```
 
-### Linting an OAS 2 document
 
-Spectral also includes a number of ready made rules and functions for OpenAPI Specification (OAS) 2 and 3 documents. This example uses the OAS 2 rules to lint a document.
 
-You can also add to these rules to create a customized linting style guide for your OAS documents.
-
-```javascript
-const { Spectral } = require('@stoplight/spectral');
-const { oas2Functions, oas2Rules } = require('@stoplight/spectral/rulesets/oas2');
-
-// an OASv2 document
-var myOAS = {
-  // ... properties in your document
-  responses: {
-    '200': {
-      description: '',
-      schema: {
-        $ref: '#/definitions/error-response',
-      },
-    },
-  },
-  // ... properties in your document
-};
-
-// create a new instance of spectral with all of the baked in rulesets
-const spectral = new Spectral();
-
-spectral.addFunctions(oas2Functions());
-spectral.addRules(oas2Rules());
-
-spectral.addRules({
-  // .. extend with your own custom rules
-});
-
-// run!
-const results = spectral.run(myOAS);
-
-console.log(JSON.stringify(results, null, 4));
-```
-
-Note: The existing OAS rules are opinionated. There might be some rules that you prefer to change. We encourage you to create your rules to fit your use case. We welcome additions to the existing rulesets as well!
-
-### Example Implementations
-
-- [Spectral Bot](https://github.com/tbarn/spectral-bot), a GitHub pull request bot that lints your repo's OAS document that uses the [Probot](https://probot.github.io) framework, built by [Taylor Barnett](https://github.com/tbarn)
-
 ## FAQs
@@ -207,3 +226,3 @@
 
-**I want to lint my OpenAPI Specification documents but don't want to implement Spectral right now.**
+**I want to lint my OpenAPI documents but don't want to implement Spectral right now.**
 
@@ -214,7 +233,7 @@ No problem! A hosted version of Spectral comes **free** with the Stoplight platform. Sign up for a free account [here](https://stoplight.io/?utm_source=github&utm_campaign=spectral).
 
-With Spectral, lint rules can be applied to _any_ JSON object, not just OAS 3 documents. The rule structure is different between the two. Spectral uses [JSONPath](http://goessner.net/articles/JsonPath/) `path` parameters instead of the `object` parameters (which are OAS-specific). Rules are also more clearly defined (thanks to TypeScript typings) and now require specifying a `type` parameter. Some rule types have been enhanced to be a little more flexible along with being able to create your own rules based on the built-in and custom functions.
+With Spectral, lint rules can be applied to _any_ JSON object. Speccy is designed to work with OpenAPI v3 only. The rule structure is different between the two. Spectral uses [JSONPath](http://goessner.net/articles/JsonPath/) `path` parameters instead of the `object` parameters (which are OpenAPI specific). Rules are also more clearly defined (thanks to TypeScript typings) and now require specifying a `type` parameter. Some rule types have been enhanced to be a little more flexible along with being able to create your own rules based on the built-in and custom functions.
 
 ## Contributing
 
-If you are interested in contributing to Spectral itself, check out our [contributing docs](CONTRIBUTING.md) [Coming soon!] to get started.
+If you are interested in contributing to Spectral itself, check out our [contributing docs](CONTRIBUTING.md) to get started.
 
@@ -225,2 +244,8 @@ Also, most of the interesting projects are built _with_ Spectral. Please consider using Spectral in a project or contribute to an [existing one](#example-implementations).
 
+### Example Implementations
+
+- [Stoplight's Custom Style and Validation Rules](https://docs.stoplight.io/modeling/modeling-with-openapi/style-validation-rules) uses Spectral to validate and lint OpenAPI documents on the Stoplight platform
+- [Spectral GitHub Bot](https://github.com/tbarn/spectral-bot), a GitHub pull request bot that lints your repo's OpenAPI document that uses the [Probot](https://probot.github.io) framework, built by [Taylor Barnett](https://github.com/tbarn)
+- [Spectral GitHub Action](https://github.com/XVincentX/spectral-action), a GitHub Action that lints your repo's OpenAPI document, built by [Vincenzo Chianese](https://github.com/XVincentX/)
+
 ## Helpful Links
@@ -230,3 +255,3 @@
 - [stoplightio/json](https://github.com/stoplightio/json), a library of useful functions for when working with JSON
-- [stoplightio/yaml](https://github.com/stoplightio/yaml), a library of useful functions for when working with YAML, including parsing YAML into JSON with a source map that includes JSONPath pointers for every property in the result
+- [stoplightio/yaml](https://github.com/stoplightio/yaml), a library of useful functions for when working with YAML, including parsing YAML into JSON, and a few helper functions such as `getJsonPathForPosition` or `getLocationForJsonPath`
 
@@ -236,2 +261,3 @@ ## Thanks :)
 - [Phil Sturgeon](https://github.com/philsturgeon) for collaboration and creating Speccy
+- [Mike Ralphson](https://github.com/MikeRalphson) for kicking off the Spectral CLI
 
@@ -238,0 +264,0 @@ ## Support

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

261

increased by11.06%

Worsened metrics

Total package byte prevSize

22396

decreased by-90.36%

Dependency count

13

increased by160%

Number of package files

4

decreased by-95.35%

Lines of code

4

decreased by-99.92%

Number of medium supply chain risk alerts

3

increased by200%

Dependency changes

• + Added@oclif/command@^1.0

• + Added@oclif/plugin-help@^2.0

• + Added@stoplight/json-ref-resolver@^1.2.2

• + Added@stoplight/yaml@^2.1.1

• + Addedchalk@^2.4.2

• + Addednode-fetch@2.x.x

• + Addedstrip-ansi@^5.2.0

• + Addedtext-table@^0.2.0

• + Added@nodelib/fs.scandir@2.1.5(transitive)

• + Added@nodelib/fs.stat@2.0.5(transitive)

• + Added@nodelib/fs.walk@1.2.8(transitive)

• + Added@oclif/command@1.8.36(transitive)

• + Added@oclif/config@1.18.161.18.17(transitive)

• + Added@oclif/errors@1.3.6(transitive)

• + Added@oclif/help@1.0.15(transitive)

• + Added@oclif/linewrap@1.0.0(transitive)

• + Added@oclif/parser@3.8.17(transitive)

• + Added@oclif/plugin-help@2.2.3(transitive)

• + Added@stoplight/json@2.3.3(transitive)

• + Added@stoplight/json-ref-resolver@1.5.3(transitive)

• + Added@stoplight/types@4.2.09.1.2(transitive)

• + Added@stoplight/yaml@2.8.0(transitive)

• + Added@types/js-yaml@3.12.1(transitive)

• + Added@types/json-schema@7.0.15(transitive)

• + Added@types/urijs@1.19.25(transitive)

• + Addedansi-regex@3.0.14.1.15.0.1(transitive)

• + Addedansi-styles@3.2.14.3.0(transitive)

• + Addedarray-union@2.1.0(transitive)

• + Addedbraces@3.0.3(transitive)

• + Addedchalk@2.4.24.1.2(transitive)

• + Addedclean-stack@3.0.1(transitive)

• + Addedcolor-convert@1.9.32.0.1(transitive)

• + Addedcolor-name@1.1.31.1.4(transitive)

• + Addeddebug@4.4.0(transitive)

• + Addeddependency-graph@0.8.1(transitive)

• + Addeddir-glob@3.0.1(transitive)

• + Addedemoji-regex@7.0.38.0.0(transitive)

• + Addedescape-string-regexp@1.0.54.0.0(transitive)

• + Addedfast-glob@3.3.2(transitive)

• + Addedfast-memoize@2.5.2(transitive)

• + Addedfastq@1.18.0(transitive)

• + Addedfill-range@7.1.1(transitive)

• + Addedfs-extra@8.1.0(transitive)

• + Addedglob-parent@5.1.2(transitive)

• + Addedglobby@11.1.0(transitive)

• + Addedgraceful-fs@4.2.11(transitive)

• + Addedhas-flag@3.0.04.0.0(transitive)

• + Addedignore@5.3.2(transitive)

• + Addedimmer@3.3.0(transitive)

• + Addedindent-string@4.0.0(transitive)

• + Addedis-docker@2.2.1(transitive)

• + Addedis-extglob@2.1.1(transitive)

• + Addedis-fullwidth-code-point@2.0.03.0.0(transitive)

• + Addedis-glob@4.0.3(transitive)

• + Addedis-number@7.0.0(transitive)

• + Addedis-wsl@2.2.0(transitive)

• + Addedjsonfile@4.0.0(transitive)

• + Addedlodash._reinterpolate@3.0.0(transitive)

• + Addedlodash.template@4.5.0(transitive)

• + Addedlodash.templatesettings@4.2.0(transitive)

• + Addedmerge2@1.4.1(transitive)

• + Addedmicromatch@4.0.8(transitive)

• + Addedms@2.1.3(transitive)

• + Addednode-fetch@2.7.0(transitive)

• + Addedpath-type@4.0.0(transitive)

• + Addedpicomatch@2.3.1(transitive)

• + Addedqueue-microtask@1.2.3(transitive)

• + Addedreusify@1.0.4(transitive)

• + Addedrun-parallel@1.2.0(transitive)

• + Addedsemver@7.6.3(transitive)

• + Addedslash@3.0.0(transitive)

• + Addedstring-width@2.1.13.1.04.2.3(transitive)

• + Addedstrip-ansi@4.0.05.2.06.0.1(transitive)

• + Addedsupports-color@5.5.07.2.0(transitive)

• + Addedtext-table@0.2.0(transitive)

• + Addedto-regex-range@5.0.1(transitive)

• + Addedtr46@0.0.3(transitive)

• + Addedtslib@2.8.1(transitive)

• + Addeduniversalify@0.1.2(transitive)

• + Addedurijs@1.19.11(transitive)

• + Addedwebidl-conversions@3.0.1(transitive)

• + Addedwhatwg-url@5.0.0(transitive)

• + Addedwidest-line@2.0.13.1.0(transitive)

• + Addedwrap-ansi@4.0.06.2.07.0.0(transitive)

• + Addedyaml-ast-parser@0.0.43(transitive)

• - Removed@stoplight/types@3.1.0(transitive)

• Updated@stoplight/json@^1.8.0

• Updated@stoplight/types@^4.0.0