@quobix/vacuum 0.2.6 → 0.3.0

package/README.md

@@ -39,6 +39,24 @@ yarn global add @quobix/vacuum
 curl -fsSL https://quobix.com/scripts/install_vacuum.sh | sh
 ```
 
+## Install using [Docker](https://hub.docker.com/r/dshanley/vacuum)
+
+The image is available at: https://hub.docker.com/r/dshanley/vacuum
+
+```
+docker pull dshanley/vacuum
+```
+
+To run, mount the current working dir to the container and use a relative path to your spec, like so
+
+```
+docker run --rm -v $PWD:/work:ro dshanley/vacuum lint <your-openapi-spec.yaml>
+```
+Alternatively, you can pull it from
+[Github packages](https://github.com/daveshanley/vacuum/pkgs/container/vacuum).
+To do that, replace `dshanley/vacuum` with `ghcr.io/daveshanley/vacuum` in the above commands.
+
+
 ---
 
 
@@ -62,7 +80,16 @@ come say hi!
 ## Documentation
 
 ---
-🔥 **New in** `v.2.0` 🔥 : [OWASP API rules](https://quobix.com/vacuum/rules/owasp/) are now available out of the box.
+🔥 **New in** `v0.3.0+` 🔥 : [Custom JavaScript Functions](https://quobix.com/vacuum/api/custom-javascript-functions/) are now available out of the box.
+
+Write custom functions in JavaScript and use them in any ruleset. No need
+to compile golang code to extend vacuum anymore!
+
+[Learn more about building custom JavaScript functions](https://quobix.com/vacuum/api/custom-javascript-functions/).
+
+
+---
+**New in** `v0.2.0+`: [OWASP API rules](https://quobix.com/vacuum/rules/owasp/) are now available out of the box.
 
 [Learn more about enabling OWASP API rules](https://quobix.com/vacuum/rulesets/owasp/).
 
@@ -76,6 +103,7 @@ See all the documentation at https://quobix.com/vacuum
 - [About vacuum](https://quobix.com/vacuum/about/)
 - [Why should you care?](https://quobix.com/vacuum/why/)
 - [Concepts](https://quobix.com/vacuum/concepts/)
+- [FAQ](https://quobix.com/vacuum/faq/)
 - [CLI Commands](https://quobix.com/vacuum/commands/)
   - [lint](https://quobix.com/vacuum/commands/lint/)
   - [vacuum report](https://quobix.com/vacuum/commands/report/)
@@ -86,6 +114,9 @@ See all the documentation at https://quobix.com/vacuum
   - [Using The Index](https://quobix.com/vacuum/api/spec-index/)
   - [RuleResultSet](https://quobix.com/vacuum/api/rule-resultset/)
   - [Loading a RuleSet](https://quobix.com/vacuum/api/loading-ruleset/)
+  - [Linting Non-OpenAPI Files](https://quobix.com/vacuum/api/non-openapi/)
+  - [Custom Golang Functions](https://quobix.com/vacuum/api/custom-functions/)
+  - [Custom JavaScript Functions](https://quobix.com/vacuum/api/custom-javascript-functions/)
 - [Rules](https://quobix.com/vacuum/rules/)
   - [Examples](https://quobix.com/vacuum/rules/examples/)
   - [Tags](https://quobix.com/vacuum/rules/tags/)
@@ -99,6 +130,7 @@ See all the documentation at https://quobix.com/vacuum
 - [Functions](https://quobix.com/vacuum/functions/)
   - [Core Functions](https://quobix.com/vacuum/functions/core/) 
   - [OpenAPI Functions](https://quobix.com/vacuum/functions/openapi/)
+  - [OWASP Functions](https://quobix.com/vacuum/functions/owasp/)
 - [Understanding RuleSets](https://quobix.com/vacuum/rulesets/understanding/)
   - [All Rules](https://quobix.com/vacuum/rulesets/all/)
   - [No Rules](https://quobix.com/vacuum/rulesets/no-rules/)
@@ -138,49 +170,6 @@ No external dependencies, the HTML report will run completely offline.
 
 You can use either **YAML** or **JSON**, vacuum supports both formats.
 
-AsyncAPI support is coming soon!
-
-## Check out the code
-
-```
-git clone https://github.com/daveshanley/vacuum.git
-```
-### Change directory into `vacuum`
-
-```
-cd vacuum
-```
-
-## Build the code
-
-```
-go build vacuum.go
-```
-
-## Run the code
-
-```
-./vacuum lint <your-openapi-spec.yaml>
-```
-
-## Running vacuum via Docker
-
-vacuum is available as a container, you can pull the image from [Docker Hub](https://hub.docker.com/r/dshanley/vacuum)
-
-```
-docker pull dshanley/vacuum
-```
-
-To run, mount the current working dir to the container and use a relative path to your spec, like so
-
-```
-docker run --rm -v $PWD:/work:ro dshanley/vacuum lint <your-openapi-spec.yaml>
-```
-
-Alternatively, you can pull it from
-[Github packages](https://github.com/daveshanley/vacuum/pkgs/container/vacuum).
-To do that, replace `dshanley/vacuum` with `ghcr.io/daveshanley/vacuum` in the above commands.
-
 ## Using vacuum with pre-commit
 
 Vacuum can be used with [pre-commit](https://pre-commit.com).
@@ -246,6 +235,7 @@ The options here are:
 - `security`
 - `tags`
 - `validation`
+- `owasp`
 
 ## Generate a Spectral compatible report
 
@@ -288,10 +278,10 @@ if you're interested in seeing how things are progressing, it's available.
 ```
 
 ---
-## Supply your own Spectral ruleset
+## Supply your own Spectral compatible ruleset
 
 If you're already using Spectral and you have your own [custom ruleset](https://meta.stoplight.io/docs/spectral/e5b9616d6d50c-custom-rulesets#custom-rulesets),
-then you can use it with Vacuum! 
+then you can use it with vacuum! 
 
 The `lint`, `dashboard` and `spectral-report` commands all accept a `-r` or `--ruleset` flag, defining the path to your ruleset file.
 
@@ -324,6 +314,5 @@ The `lint`, `dashboard` and `spectral-report` commands all accept a `-r` or `--r
 
 ---
 
-Let me know what you think.
 
 > Logo gopher is modified, originally from [egonelbre](https://github.com/egonelbre/gophers)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quobix/vacuum",
-  "version": "0.2.6",
+  "version": "0.3.0",
   "description": "The world's fastest, most scalable and complete OpenAPI parser",
   "type": "module",
   "author": "Dave Shanley",