Merge branch 'develop' into other/3339_forbid-console-in-src-code

Fixes merge conflict in:
  - .eslintrc.json due to 6167eda6b6
  - lint.yml due to 5674f8e675

.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,7 +4,6 @@ about: Create a report to help us improve
 title: ''
 labels: 'Status: Triage, Type: Bug / Error'
 assignees: ''
-
 ---
 
 **Describe the bug**
@@ -12,6 +11,7 @@ A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -27,15 +27,17 @@ If applicable, add screenshots to help explain your problem.
 If applicable, add the code sample or a link to the [live editor](https://mermaid.live).
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
 
 **Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -4,7 +4,6 @@ about: Suggest an idea for this project
 title: ''
 labels: 'Status: Triage, Type: Enhancement'
 assignees: ''
-
 ---
 
 **Is your feature request related to a problem? Please describe.**

.github/ISSUE_TEMPLATE/question.md

@@ -4,12 +4,13 @@ about: Get some help from the community.
 title: ''
 labels: 'Help wanted!, Type: Other'
 assignees: ''
-
 ---
 
 ## Help us help you!
+
 You want an answer. Here are some ways to get it quicker:
-* Use a clear and concise title.
-* Try to pose a clear and concise question.
-* Include as much, or as little, code as necessary.
-* Don't be shy to give us some screenshots, if it helps!
+
+- Use a clear and concise title.
+- Try to pose a clear and concise question.
+- Include as much, or as little, code as necessary.
+- Don't be shy to give us some screenshots, if it helps!

.github/codeql/codeql-config.yml

@@ -1,4 +1,4 @@
-name: "CodeQL config"
+name: 'CodeQL config'
 paths-ignore:
   - dist
   - cypress

.github/dependabot.yml

@@ -1,18 +1,18 @@
 version: 2
 updates:
-- package-ecosystem: npm
-  open-pull-requests-limit: 10
-  directory: /
-  target-branch: develop
-  versioning-strategy: increase
-  schedule:
-    interval: weekly
-    day: monday
-    time: "07:00"
-- package-ecosystem: github-actions
-  directory: /
-  target-branch: develop
-  schedule:
-    interval: weekly
-    day: monday
-    time: "07:00"
+  - package-ecosystem: npm
+    open-pull-requests-limit: 10
+    directory: /
+    target-branch: develop
+    versioning-strategy: increase
+    schedule:
+      interval: weekly
+      day: monday
+      time: '07:00'
+  - package-ecosystem: github-actions
+    directory: /
+    target-branch: develop
+    schedule:
+      interval: weekly
+      day: monday
+      time: '07:00'

.github/pull_request_template.md

@@ -1,13 +1,17 @@
 ## :bookmark_tabs: Summary
+
 Brief description about the content of your PR.
 
 Resolves #<your issue id here>
 
 ## :straight_ruler: Design Decisions
+
 Describe the way your implementation works or what design decisions you made if applicable.
 
 ### :clipboard: Tasks
+
 Make sure you
-- [ ] :book: have read the [contribution guidelines](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md) 
-- [ ] :computer: have added unit/e2e tests (if appropriate) 
-- [ ] :bookmark: targeted `develop` branch 
+
+- [ ] :book: have read the [contribution guidelines](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md)
+- [ ] :computer: have added unit/e2e tests (if appropriate)
+- [ ] :bookmark: targeted `develop` branch

.github/stale.yml

@@ -16,4 +16,4 @@ markComment: >
 # Comment to post when closing a stale issue. Set to `false` to disable
 closeComment: >
   This issue has been been automatically closed due to a lack of activity. 
-  This is done to maintain a clean list of issues that the community is interested in developing. 
+  This is done to maintain a clean list of issues that the community is interested in developing.

.github/workflows/build.yml

@@ -18,28 +18,28 @@ jobs:
       matrix:
         node-version: [16.x]
     steps:
-    - uses: actions/checkout@v3
+      - uses: actions/checkout@v3
 
-    - name: Setup Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
-      with:
-        cache: yarn
-        node-version: ${{ matrix.node-version }}
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          cache: yarn
+          node-version: ${{ matrix.node-version }}
 
-    - name: Install Yarn
-      run: npm i yarn --global
+      - name: Install Yarn
+        run: npm i yarn --global
 
-    - name: Install Packages
-      run: |
-        yarn install --frozen-lockfile
-      env:
-        CYPRESS_CACHE_FOLDER: .cache/Cypress
+      - name: Install Packages
+        run: |
+          yarn install --frozen-lockfile
+        env:
+          CYPRESS_CACHE_FOLDER: .cache/Cypress
 
-    - name: Run Build
-      run: yarn build
+      - name: Run Build
+        run: yarn build
 
-    - name: Upload Build as Artifact
-      uses: actions/upload-artifact@v3
-      with:
-        name: dist
-        path: dist
+      - name: Upload Build as Artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: dist
+          path: dist

.github/workflows/checks.yml

@@ -14,12 +14,12 @@ jobs:
     name: check tests
     if: github.repository_owner == 'mermaid-js'
     steps:
-    - uses: actions/checkout@v2
-      with:
-        fetch-depth: 0
-    - uses: testomatio/check-tests@stable
-      with:
-        framework: cypress
-        tests: "./cypress/e2e/**/**.spec.js"
-        token: ${{ secrets.GITHUB_TOKEN }}
-        has-tests-label: true
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: testomatio/check-tests@stable
+        with:
+          framework: cypress
+          tests: './cypress/e2e/**/**.spec.js'
+          token: ${{ secrets.GITHUB_TOKEN }}
+          has-tests-label: true

.github/workflows/codeql.yml

@@ -1,12 +1,11 @@
-
-name: "CodeQL"
+name: 'CodeQL'
 
 on:
   push:
-    branches: [ develop ]
+    branches: [develop]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ develop ]
+    branches: [develop]
     types:
       - opened
       - synchronize
@@ -24,40 +23,40 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript' ]
+        language: ['javascript']
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
         # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v3
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        config-file: ./.github/codeql/codeql-config.yml
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          config-file: ./.github/codeql/codeql-config.yml
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
 
-    #- run: |
-    #   make bootstrap
-    #   make release
+      #- run: |
+      #   make bootstrap
+      #   make release
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

.github/workflows/issue-triage.yml

@@ -1,6 +1,6 @@
 name: Apply triage label to new issue
 
-on: 
+on:
   issues:
     types: [opened]
 
@@ -8,7 +8,7 @@ jobs:
   triage:
     runs-on: ubuntu-latest
     steps:
-    - uses: andymckay/labeler@1.0.4
-      with:
-        repo-token: "${{ secrets.GITHUB_TOKEN }}"
-        add-labels: "Status: Triage"
+      - uses: andymckay/labeler@1.0.4
+        with:
+          repo-token: '${{ secrets.GITHUB_TOKEN }}'
+          add-labels: 'Status: Triage'

.github/workflows/lint.yml

@@ -18,36 +18,40 @@ jobs:
       matrix:
         node-version: [16.x]
     steps:
-    - uses: actions/checkout@v3
+      - uses: actions/checkout@v3
 
-    - name: Setup Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
-      with:
-        cache: yarn
-        node-version: ${{ matrix.node-version }}
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          cache: yarn
+          node-version: ${{ matrix.node-version }}
 
-    - name: Install Yarn
-      run: npm i yarn --global
+      - name: Install Yarn
+        run: npm i yarn --global
 
-    - name: Install Packages
-      run: |
-        yarn install --frozen-lockfile
-      env:
-        CYPRESS_CACHE_FOLDER: .cache/Cypress
+      - name: Install Packages
+        run: |
+          yarn install --frozen-lockfile
+        env:
+          CYPRESS_CACHE_FOLDER: .cache/Cypress
 
-    - name: Run Linting
-      run: yarn lint
-    - name: Check no `console.log()` in .jison files
-      # ESLint can't parse .jison files directly
-      # In the future, it might be worth making a `eslint-plugin-jison`, so
-      # that this will be built into the `yarn lint` command.
-      run: |
-        shopt -s globstar
-        mkdir -p tmp/
-        for jison_file in src/**/*.jison; do
-          outfile="tmp/$(basename -- "$jison_file" .jison)-jison.js"
-          echo "Converting $jison_file to $outfile"
-          # default module-type (CJS) always adds a console.log()
-          yarn jison "$jison_file" --outfile "$outfile" --module-type "amd"
-        done
-        yarn eslint --no-eslintrc --rule no-console:error --parser "@babel/eslint-parser" "./tmp/*-jison.js"
+      - name: Run Linting
+        run: yarn lint
+
+      - name: Verify Docs
+        run: yarn docs:verify
+
+      - name: Check no `console.log()` in .jison files
+        # ESLint can't parse .jison files directly
+        # In the future, it might be worth making a `eslint-plugin-jison`, so
+        # that this will be built into the `yarn lint` command.
+        run: |
+          shopt -s globstar
+          mkdir -p tmp/
+          for jison_file in src/**/*.jison; do
+            outfile="tmp/$(basename -- "$jison_file" .jison)-jison.js"
+            echo "Converting $jison_file to $outfile"
+            # default module-type (CJS) always adds a console.log()
+            yarn jison "$jison_file" --outfile "$outfile" --module-type "amd"
+          done
+          yarn eslint --no-eslintrc --rule no-console:error --parser "@babel/eslint-parser" "./tmp/*-jison.js"

.github/workflows/release-preview-publish.yml

@@ -9,29 +9,28 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - name: Setup Node.js
-      uses: actions/setup-node@v3
-      with:
-        node-version: 16.x
-    - name: Install Yarn
-      run: npm i yarn --global
+      - uses: actions/checkout@v3
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+      - name: Install Yarn
+        run: npm i yarn --global
 
-    - name: Install Json
-      run: npm i json --global
+      - name: Install Json
+        run: npm i json --global
 
-    - name: Install Packages
-      run: yarn install --frozen-lockfile
-
-    - name: Publish
-      run: |
-        PREVIEW_VERSION=8
-        VERSION=$(echo ${{github.ref}} | tail -c +20)-preview.$PREVIEW_VERSION
-        echo $VERSION
-        npm version --no-git-tag-version --allow-same-version $VERSION
-        npm set //npm.pkg.github.com/:_authToken ${{ secrets.GITHUB_TOKEN }}
-        npm set registry https://npm.pkg.github.com/mermaid-js
-        json -I -f package.json -e 'this.name="@mermaid-js/mermaid"' # Package name needs to be set to a scoped one because GitHub registry requires this
-        json -I -f package.json -e 'this.repository="git://github.com/mermaid-js/mermaid"' # Repo url needs to have a specific format too
-        npm publish
+      - name: Install Packages
+        run: yarn install --frozen-lockfile
 
+      - name: Publish
+        run: |
+          PREVIEW_VERSION=8
+          VERSION=$(echo ${{github.ref}} | tail -c +20)-preview.$PREVIEW_VERSION
+          echo $VERSION
+          npm version --no-git-tag-version --allow-same-version $VERSION
+          npm set //npm.pkg.github.com/:_authToken ${{ secrets.GITHUB_TOKEN }}
+          npm set registry https://npm.pkg.github.com/mermaid-js
+          json -I -f package.json -e 'this.name="@mermaid-js/mermaid"' # Package name needs to be set to a scoped one because GitHub registry requires this
+          json -I -f package.json -e 'this.repository="git://github.com/mermaid-js/mermaid"' # Repo url needs to have a specific format too
+          npm publish

.github/workflows/release-publish.yml

@@ -8,37 +8,37 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: fregante/setup-git-user@v1
+      - uses: actions/checkout@v3
+      - uses: fregante/setup-git-user@v1
 
-    - name: Setup Node.js
-      uses: actions/setup-node@v3
-      with:
-        node-version: 16.x
-    - name: Install Yarn
-      run: npm i yarn --global
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+      - name: Install Yarn
+        run: npm i yarn --global
 
-    - name: Install Json
-      run: npm i json --global
+      - name: Install Json
+        run: npm i json --global
 
-    - name: Install Packages
-      run: yarn install --frozen-lockfile
+      - name: Install Packages
+        run: yarn install --frozen-lockfile
 
-    - name: Prepare release
-      run: |
-        VERSION=${GITHUB_REF:10}
-        echo "Preparing release $VERSION"
-        git checkout -t origin/release/$VERSION
-        npm version --no-git-tag-version --allow-same-version $VERSION
-        git add package.json
-        git commit -m "Bump version $VERSION"
-        git checkout -t origin/master
-        git merge -m "Release $VERSION" --no-ff release/$VERSION
-        git push --no-verify
+      - name: Prepare release
+        run: |
+          VERSION=${GITHUB_REF:10}
+          echo "Preparing release $VERSION"
+          git checkout -t origin/release/$VERSION
+          npm version --no-git-tag-version --allow-same-version $VERSION
+          git add package.json
+          git commit -m "Bump version $VERSION"
+          git checkout -t origin/master
+          git merge -m "Release $VERSION" --no-ff release/$VERSION
+          git push --no-verify
 
-    - name: Publish
-      run: |
-        npm set //registry.npmjs.org/:_authToken $NPM_TOKEN
-        npm publish
-      env:
-        NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Publish
+        run: |
+          npm set //registry.npmjs.org/:_authToken $NPM_TOKEN
+          npm publish
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -12,23 +12,23 @@ jobs:
       matrix:
         node-version: [16.x]
     steps:
-    - uses: actions/checkout@v3
+      - uses: actions/checkout@v3
 
-    - name: Setup Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
-      with:
-        cache: yarn
-        node-version: ${{ matrix.node-version }}
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          cache: yarn
+          node-version: ${{ matrix.node-version }}
 
-    - name: Install Yarn
-      run: npm i yarn --global
+      - name: Install Yarn
+        run: npm i yarn --global
 
-    - name: Install Packages
-      run: |
-        yarn install --frozen-lockfile
-      env:
-        CYPRESS_CACHE_FOLDER: .cache/Cypress
+      - name: Install Packages
+        run: |
+          yarn install --frozen-lockfile
+        env:
+          CYPRESS_CACHE_FOLDER: .cache/Cypress
 
-    - name: Run Unit Tests
-      run: |
-        yarn ci --coverage
+      - name: Run Unit Tests
+        run: |
+          yarn ci --coverage

.github/workflows/unlock-reopened-issues.yml

@@ -1,6 +1,6 @@
 name: Unlock reopened issue
 
-on: 
+on:
   issues:
     types: [reopened]
 
@@ -8,6 +8,6 @@ jobs:
   triage:
     runs-on: ubuntu-latest
     steps:
-    - uses: Dunning-Kruger/unlock-issues@v1
-      with:
-        repo-token: "${{ secrets.GITHUB_TOKEN }}"
+      - uses: Dunning-Kruger/unlock-issues@v1
+        with:
+          repo-token: '${{ secrets.GITHUB_TOKEN }}'