Merge branch 'master' into update_browser_export

.github/workflows/issues-prs-notifications.yml

@@ -20,8 +20,6 @@ jobs:
     name: Notify slack on every new issue
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
       - name: Convert markdown to slack markdown for issue
         uses: asyncapi/.github/.github/actions/slackify-markdown@master
         id: issuemarkdown
@@ -40,8 +38,6 @@ jobs:
     name: Notify slack on every new pull request
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
       - name: Convert markdown to slack markdown for pull request
         uses: asyncapi/.github/.github/actions/slackify-markdown@master
         id: prmarkdown
@@ -60,8 +56,6 @@ jobs:
     name: Notify slack on every new pull request
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
       - name: Convert markdown to slack markdown for pull request
         uses: asyncapi/.github/.github/actions/slackify-markdown@master
         id: discussionmarkdown

README.md

@@ -231,7 +231,19 @@ Additionally to all the methods declared in the [Parser-API](https://github.com/
 
 ## Spectral rulesets
 
-[Spectral](https://github.com/stoplightio/spectral) powers the validation of AsyncAPI documents within ParserJS. For this reason, it is possible to use your rulesets/rules or overwrite existing ones, passing the `ruleset` option to the Parser instance: 
+[Spectral](https://github.com/stoplightio/spectral) powers the validation of AsyncAPI documents within ParserJS. 
+The default [built-in rulesets](src/ruleset) are:
+
+- Core ruleset:
+  - Basic and global validation. Apply to all AsyncAPI Spec versions (with some exceptions).
+- Recommended ruleset:
+  - These are good practices. They won't create validation errors but warnings.
+- Specific rulesets per each AsyncAPI Spec version:
+  - Contain particular rulesets that apply only to documents of a particular Spec version:
+    - Core rulesets: Rules that generate validation errors if not fulfilled by a particular Spec version.
+    - Recommended rulesets: Best practices for a particular Spec version
+
+It is possible to use your rulesets/rules or overwrite existing ones, passing the `ruleset` option to the Parser instance: 
 
 ```ts
 import { Parser, stringify, unstringify } from '@asyncapi/parser';

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asyncapi/parser",
-  "version": "3.0.16",
+  "version": "3.1.0",
   "description": "JavaScript AsyncAPI parser.",
   "bugs": {
     "url": "https://github.com/asyncapi/parser-js/issues"
@@ -62,7 +62,7 @@
     "node-fetch": "2.6.7"
   },
   "devDependencies": {
-    "@asyncapi/avro-schema-parser": "^3.0.23",
+    "@asyncapi/avro-schema-parser": "^3.0.24",
     "@jest/types": "^29.0.2",
     "@swc/core": "^1.2.248",
     "@swc/jest": "^0.2.22",

src/ruleset/v2/ruleset.ts

@@ -192,6 +192,7 @@ export const v2CoreRuleset = {
 export const v2SchemasRuleset = (parser: Parser) => {
   return {
     description: 'Schemas AsyncAPI 2.x.x ruleset.',
+    formats: AsyncAPIFormats.filterByMajorVersions(['2']).formats(),
     rules: {
       'asyncapi2-schemas': asyncApi2SchemaParserRule(parser),
       'asyncapi2-schema-default': {

test/validate.spec.ts

@@ -1,3 +1,4 @@
+import { AsyncAPIDocument } from '../src/models/v3/asyncapi';
 import { Parser } from '../src/parser';
 import { hasErrorDiagnostic, hasWarningDiagnostic } from '../src/utils';
 
@@ -91,7 +92,7 @@ describe('validate()', function() {
       }
     };
     const { document, diagnostics } = await parser.parse(documentRaw, { validateOptions: { allowedSeverity: { warning: false } } });
-    console.log(diagnostics);
     expect(diagnostics).toHaveLength(0);
+    expect(document).toBeInstanceOf(AsyncAPIDocument);
   });
 });