refactor: add migration guide

.eslintignore

@@ -1,7 +1,9 @@
 node_modules
-dist
-lib/browser.js
-scripts
-coverage
-.nyc_output
-test/sample_browser/
+.vscode
+.DS_Store
+/docs
+/coverage
+/lib
+/esm
+/cjs
+/browser

.eslintrc

@@ -1,17 +1,23 @@
+parser: "@typescript-eslint/parser"
+
 env:
  node: true
  es6: true
+ jest: true
  mocha: true
  browser: true
 
 plugins:
+ - "@typescript-eslint"
  - sonarjs
- - mocha
  - security
+ - github
 
 extends:
+ - eslint:recommended
+ - plugin:@typescript-eslint/eslint-recommended
+ - plugin:@typescript-eslint/recommended
  - plugin:sonarjs/recommended
- - plugin:mocha/recommended
  - plugin:security/recommended
 
 parserOptions:
@@ -24,6 +30,7 @@ rules:
  no-mixed-requires: 0
  no-process-exit: 0
  no-warning-comments: 0
+ no-use-before-define: 0
  curly: 0
  no-multi-spaces: 0
  no-alert: 0
@@ -32,6 +39,10 @@ rules:
  func-style: 0
  max-nested-callbacks: 0
  camelcase: 0
+ no-dupe-class-members: 0
+ security/detect-object-injection: 0
+ sonarjs/no-small-switch: 0
+ sonarjs/no-nested-template-literals: 0
 
  # Warnings
  no-debugger: 1
@@ -49,7 +60,6 @@ rules:
  no-empty-character-class: 2
  no-self-compare: 2
  valid-typeof: 2
- no-unused-vars: [2, { "args": "none" }]
  handle-callback-err: 2
  no-shadow-restricted-names: 2
  no-new-require: 2
@@ -61,7 +71,6 @@ rules:
  radix: 2
  wrap-iife: [2, outside]
  no-shadow: 0
- no-use-before-define: [2, nofunc]
  no-path-concat: 2
  valid-jsdoc: [0, {requireReturn: false, requireParamDescription: false, requireReturnDescription: false}]
 
@@ -92,7 +101,6 @@ rules:
  arrow-spacing: [2, {before: true, after: true}]
  no-class-assign: 2
  no-const-assign: 2
- no-dupe-class-members: 2
  no-this-before-super: 2
  no-var: 2
  object-shorthand: [2, always]
@@ -101,10 +109,26 @@ rules:
  prefer-spread: 2
  prefer-template: 2
 
+ # TypeScript
+ "@typescript-eslint/no-empty-interface": "off"
+ "@typescript-eslint/no-use-before-define": ["off"]
+ "@typescript-eslint/no-empty-function": "off"
+ "@typescript-eslint/ban-ts-comment": "off"
+ "@typescript-eslint/no-explicit-any": "off"
+ "@typescript-eslint/explicit-module-boundary-types": "off"
+ "@typescript-eslint/no-this-alias": "off"
+ "@typescript-eslint/no-unnecessary-type-constraint": "off"
+ "@typescript-eslint/ban-types": "off"
+
 overrides:
- - files: "test/**"
+ - files: 
+ - "test/**"
+ - "*.spec.ts"
+ - "*.test.ts"
  rules:
  prefer-arrow-callback: 0
  sonarjs/no-duplicate-string: 0
  security/detect-object-injection: 0
- security/detect-non-literal-fs-filename: 0
+ security/detect-non-literal-fs-filename: 0
+ "@typescript-eslint/no-non-null-assertion": 0
+ "@typescript-eslint/no-unused-vars": 0

.github/workflows/link-check-cron.yml

@@ -0,0 +1,37 @@
+# This workflow is centrally managed in https:/asyncapi/.github/
+# Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in above mentioned repo
+
+name: Check Markdown links (Weekly)
+
+on:
+ workflow_dispatch:
+ schedule:
+ # At 00:00 UTC on every Monday
+ - cron: '0 0 * * 0'
+
+jobs:
+ External-link-validation-weekly:
+ if: startsWith(github.repository, 'asyncapi/')
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+
+ # Checks the status of hyperlinks in .md files
+ - name: Check links
+ uses: gaurav-nelson/github-action-markdown-link-check@v1
+ with:
+ use-quiet-mode: 'yes'
+ use-verbose-mode: 'yes'
+
+ # A configuration file can be included, indicating the properties of the link check action
+ # More information can be found here: https:/tcort/markdown-link-check#config-file-format
+ # Create mlc_config.json file in the root of the directory
+
+ - name: Report workflow run status to Slack
+ uses: 8398a7/action-slack@v3
+ with:
+ status: ${{ job.status }}
+ fields: repo,action,workflow
+ env:
+ SLACK_WEBHOOK_URL: ${{ secrets.SLACK_CI_FAIL_NOTIFY }}
+ if: failure() # Only, on failure, send a message on the 94_bot-failing-ci slack channel

.github/workflows/link-check-pr.yml

@@ -0,0 +1,27 @@
+# This workflow is centrally managed in https:/asyncapi/.github/
+# Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in above mentioned repo
+
+name: Check Markdown links
+
+on: 
+ pull_request_target:
+ types: [synchronize, ready_for_review, opened, reopened]
+ paths:
+ - '**.md'
+
+jobs:
+ External-link-validation-on-PR:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout repo
+ uses: actions/checkout@v3
+ - name: Check links
+ uses: gaurav-nelson/github-action-markdown-link-check@v1
+ with:
+ use-quiet-mode: 'yes'
+ use-verbose-mode: 'yes'
+ check-modified-files-only: 'yes' # Only modified files are checked on PRs
+
+ # A configuration file can be included, indicating the properties of the link check action
+ # More information can be found here: https:/tcort/markdown-link-check#config-file-format
+ # Create mlc_config.json file in the root of the directory

.gitignore

@@ -1,7 +1,10 @@
 node_modules
 .vscode
-.nyc_output
-coverage
 .DS_Store
-test/sample_browser/bundle.js
-dist/bundle.js
+/docs/api.md
+/coverage
+/lib
+/esm
+/cjs
+/browser
+*.tgz

.npmignore

@@ -1,11 +1,9 @@
-test/
 .DS_Store
 *.swp
 .github
 .all-contributorsrc
 .editorconfig
-coverage
-.nyc_output
 assets/logo.png
-scripts
-vscode
+vscode
+coverage
+node_modules

.sonarcloud.properties

@@ -0,0 +1,2 @@
+# Disable specific duplicate code since it would introduce more complexity to reduce it.
+sonar.cpd.exclusions=src/models/**/*.ts