Fix test

* master:

.eslintignore

@@ -0,0 +1,8 @@
+docs/**
+.svelte-kit/**
+static/**
+build/**
+node_modules/**
+coverage/**
+__snapshots__/**
+snapshots.js

.eslintrc.cjs

@@ -7,10 +7,11 @@ module.exports = {
 		// 'plugin:@typescript-eslint/recommended-requiring-type-checking',
 		'prettier'
 	],
-	plugins: ['svelte3', 'tailwindcss', '@typescript-eslint', 'es'],
+	plugins: ['svelte3', 'tailwindcss', '@typescript-eslint', 'es', 'vitest'],
 	ignorePatterns: [
 		'docs/*',
 		'*.cjs',
+		'*.js',
 		'*.md',
 		'snapshots.js',
 		'svelte.config.js',
@@ -27,7 +28,8 @@ module.exports = {
 		ecmaVersion: 2019,
 		tsconfigRootDir: __dirname,
 		project: ['./tsconfig.json'],
-		extraFileExtensions: ['.svelte']
+		extraFileExtensions: ['.svelte'],
+		allowAutomaticSingleRunInference: true
 	},
 	env: {
 		browser: true,

.github/workflows/codeql-analysis.yml

@@ -35,11 +35,11 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v1
+        uses: github/codeql-action/init@v2
         with:
           config-file: ./.github/codeql/config.yml
           languages: ${{ matrix.language }}
@@ -65,4 +65,4 @@ jobs:
       #   make release
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v1
+        uses: github/codeql-action/analyze@v2

.github/workflows/deploy.yml

@@ -11,37 +11,22 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/setup-node@v2
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
         with:
           node-version: '16'
-
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Get yarn cache directory path
-        id: yarn-cache-dir-path
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-
-      - uses: actions/cache@v2
-        id: yarn-cache
-        with:
-          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-yarn-
+          cache: yarn
 
       - name: Build & Deploy
         run: |
-          npm i -g yarn
           export DEPLOY=true
-          [ "$GITHUB_EVENT_NAME" == "pull_request" ] && export BETA=true && rm -rf docs/beta/
           [ "$GITHUB_EVENT_NAME" != "pull_request" ] && rm -rf docs/_app/
           yarn install
-          yarn run lint
           version=$(yarn version --patch --no-git-tag-version | grep "New version" | cut -d':' -f 2)
           yarn build
-          cd bin
-          ./fix-path
+          yarn run lint
           cd ..
 
       - name: Deploy

.github/workflows/docker-publish.yml

@@ -24,7 +24,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Run tests
         run: |
@@ -38,7 +38,7 @@ jobs:
     if: github.event_name == 'push'
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Build image
         run: docker build . --file Dockerfile --tag $IMAGE_NAME

.github/workflows/stale.yml

@@ -8,10 +8,13 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v4
+      - uses: actions/stale@v5
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           exempt-issue-labels: 'retained'
           exempt-pr-labels: 'retained'
-          stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days'
-          stale-pr-message: 'This pr is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days'
+          stale-issue-message: 'This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 14 days'
+          stale-pr-message: 'This pr is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 14 days'
+          days-before-stale: 90
+          days-before-close: 14
+          days-before-pr-close: -1

.github/workflows/tests.yml

@@ -1,4 +1,4 @@
-name: Cypress Tests
+name: Tests
 
 on:
   pull_request:
@@ -9,14 +9,12 @@ on:
 jobs:
   cypress-run:
     runs-on: ubuntu-latest
-    # Update after https://github.com/cypress-io/cypress-docker-images/issues/487
-    container: cypress/browsers:node14.16.0-chrome90-ff88
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         id: yarn-and-build-cache
         with:
           path: |
@@ -27,15 +25,21 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-node_modules-build-
 
-      - name: Lint
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: 'yarn'
+
+      - name: Lint & Test
         run: |
           yarn install
-          yarn run lint
+          yarn lint
+          yarn test:unit
 
       # Install NPM dependencies, cache them correctly
       # and run all Cypress tests
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v3
         with:
           build: yarn build
           start: yarn preview

.github/workflows/update-browserlist.yml

@@ -1,15 +1,18 @@
 name: Update Browserslist
 on:
   workflow_dispatch:
+  push:
+    branches:
+      - develop
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - run: npx browserslist@latest --update-db
       - name: Commit changes
-        uses: EndBug/add-and-commit@v8
+        uses: EndBug/add-and-commit@v9
         with:
           author_name: ${{ github.actor }}
           author_email: ${{ github.actor }}@users.noreply.github.com

.github/workflows/update-monaco-editor.yml

@@ -1,8 +1,7 @@
 name: Update Monaco-editor
 on:
   workflow_dispatch:
-  pull_request:
-    types: [opened]
+  push:
     branches:
       - 'dependabot/npm_and_yarn/develop/monaco-editor-**'
 
@@ -10,10 +9,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - run: ./bin/update-monaco
       - name: Commit changes
-        uses: EndBug/add-and-commit@v8
+        uses: EndBug/add-and-commit@v9
         with:
           author_name: ${{ github.actor }}
           author_email: ${{ github.actor }}@users.noreply.github.com

.gitignore

@@ -9,5 +9,6 @@ yarn-error.log
 /build
 /functions
 /snapshots.js
+/cypress/downloads
 /cypress/videos
 /cypress/screenshots

.prettierignore

@@ -3,4 +3,6 @@ docs/**
 static/**
 build/**
 node_modules/**
+coverage/**
+__snapshots__/**
 snapshots.js

.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+	// Use IntelliSense to learn about possible attributes.
+	// Hover to view descriptions of existing attributes.
+	// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"type": "pwa-chrome",
+			"request": "launch",
+			"name": "Launch Chrome against localhost",
+			"url": "http://localhost:3000",
+			"webRoot": "${workspaceFolder}"
+		}
+	]
+}

Dockerfile

@@ -6,11 +6,12 @@
 # Stop               : press ctrl + c 
 #                                     or 
 #                                        docker stop mermaid-live-editor
-FROM node:17.4.0 as mermaid-live-editor-builder 
+FROM node:18.4.0 as mermaid-live-editor-builder 
 COPY --chown=node:node . /home
 WORKDIR /home
 RUN yarn install
 RUN yarn build
 
 FROM nginx:alpine as mermaid-live-editor-runner
+COPY ./nginx.conf /etc/nginx/conf.d/default.conf
 COPY --from=mermaid-live-editor-builder --chown=nginx:nginx /home/docs /usr/share/nginx/html

Dockerfile.dev

@@ -1,4 +1,4 @@
-FROM node:17
+FROM node:18
 WORKDIR /app
 COPY package.json .
 COPY yarn.lock .

SECURITY.md

@@ -0,0 +1,13 @@
+# Security Policy
+
+## Supported Versions
+
+Live editor only has a single version, which will be maintained.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| latest  | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+To report a vulnerability, please e-mail security@mermaid.live with a description of the issue, the steps you took to create the issue, affected versions, and if known, mitigations for the issue.

cypress.config.js

@@ -0,0 +1,31 @@
+import { defineConfig } from 'cypress';
+import fs from 'fs';
+import { isFileExist, findFiles } from 'cy-verify-downloads';
+export default defineConfig({
+	projectId: '2ckppp',
+	viewportWidth: 1440,
+	viewportHeight: 768,
+	snapshotFileName: './cypress/snapshots.js',
+	defaultCommandTimeout: 16000,
+	requestTimeout: 16000,
+	e2e: {
+		setupNodeEvents(on, config) {
+			on('task', {
+				isFileExist,
+				findFiles,
+				deleteFile(path) {
+					fs.rmSync(path);
+					return null;
+				},
+				readFileMaybe(filename) {
+					if (fs.existsSync(filename)) {
+						return fs.readFileSync(filename, 'utf8');
+					}
+					return null;
+				}
+			});
+		},
+		baseUrl: 'http://localhost:3000',
+		specPattern: 'cypress/e2e/**/*.{js,jsx,ts,tsx}'
+	}
+});

cypress.json

@@ -1,11 +0,0 @@
-{
-	"projectId": "2ckppp",
-	"$schema": "https://on.cypress.io/cypress.schema.json",
-	"baseUrl": "http://localhost:3000",
-	"pluginsFile": "./cypress/plugins/index.cjs",
-	"viewportWidth": 1440,
-	"viewportHeight": 768,
-	"snapshotFileName": "./cypress/snapshots.js",
-	"defaultCommandTimeout": 16000,
-	"requestTimeout": 16000
-}

cypress/.eslintrc

@@ -1,12 +1,10 @@
 {
-	"plugins": ["cypress", "mocha"],
-	"extends": ["plugin:cypress/recommended", "plugin:mocha/recommended"],
+	"plugins": ["cypress"],
+	"extends": ["plugin:cypress/recommended"],
 	"rules": {
-		"jest/expect-expect": "off",
-		"mocha/no-mocha-arrows": "off"
+		"jest/expect-expect": "off"
 	},
 	"env": {
-		"cypress/globals": true,
-		"mocha": true
+		"cypress/globals": true
 	}
 }

cypress/e2e/actions.spec.ts

@@ -0,0 +1,54 @@
+describe('Check actions', () => {
+	beforeEach(() => {
+		cy.clearLocalStorage();
+		cy.visit('/edit');
+	});
+
+	it('should update markdown code', () => {
+		cy.get('#markdown')
+			.invoke('val')
+			.then((oldText) => {
+				cy.get('#editor').click('bottom').type('{enter}C --> HistoryTest');
+				cy.get('#markdown')
+					.invoke('val')
+					.then((newText) => {
+						expect(oldText).to.not.eq(newText);
+					});
+			});
+	});
+
+	it('should load gists from URL', () => {
+		cy.get('#gist').type('https://gist.github.com/sidharthv96/6268a23e673a533dcb198f241fd7012a');
+		cy.contains('Load Gist').click();
+		cy.contains('Go shopping!!');
+	});
+
+	it('should download png and svg', () => {
+		const now = new Date(2022, 0, 1).getTime();
+		cy.clock(now);
+		const downloadsFolder = Cypress.config('downloadsFolder');
+
+		const verifyFileSize = (fileType: string, size: number) => {
+			cy.get(`#download${fileType.toUpperCase()}`).click();
+			const fileName = `mermaid-diagram-2022-01-01-000000.${fileType}`;
+			const filePath = `${downloadsFolder}/${fileName}`;
+			cy.verifyDownload(fileName);
+			cy.readFile(filePath, null, {
+				log: false
+			}).then((buffer) => expect((buffer as ArrayBuffer).byteLength).to.be.gt(size));
+			cy.task('deleteFile', filePath);
+		};
+
+		verifyFileSize('png', 21_000);
+		verifyFileSize('svg', 11_000);
+
+		// Verify downloaded file is different for different diagrams
+		cy.contains('Sample Diagrams').click();
+		cy.contains('ER Diagram').click();
+
+		verifyFileSize('png', 46_000);
+		verifyFileSize('svg', 12_000);
+
+		cy.clock().invoke('restore');
+	});
+});

cypress/e2e/diagramUpdate.spec.ts

@@ -1,12 +1,22 @@
 describe('Auto sync tests', () => {
+	const cmd = Cypress.platform === 'darwin' ? 'meta' : 'ctrl';
+	const getEditor = ({ bottom = true, newline = false } = {}) =>
+		cy
+			.get('#editor textarea:first')
+			.click()
+			.focused()
+			.type(`${bottom ? '{pageDown}' : `{${cmd}}`}`)
+			.type(`${newline ? '{enter}' : `{${cmd}}`}`);
+
 	beforeEach(() => {
 		cy.clearLocalStorage();
 		cy.visit('/');
 	});
+
 	it('should dim diagram when code is edited', () => {
 		cy.contains('Auto sync').click();
 		cy.get('#view').should('not.have.class', 'outOfSync');
-		cy.get('#editor').type('  C --> Test');
+		getEditor().type('  C --> Test');
 		cy.get('#view').should('have.class', 'outOfSync');
 		cy.getLocalStorage('codeStore').snapshot();
 	});
@@ -18,26 +28,39 @@ describe('Auto sync tests', () => {
 		cy.get('#autoSync').check();
 		cy.get('[data-cy=sync]').should('not.exist');
 	});
+
 	it('should not dim diagram when code is in sync', () => {
 		cy.contains('Auto sync').click();
 		cy.get('#view').should('not.have.class', 'outOfSync');
-		cy.get('#editor').type('  C --> Test');
+		getEditor().type('  C --> Test');
 		cy.get('#view').should('have.class', 'outOfSync');
 		cy.get('[data-cy=sync]').click();
 		cy.get('#view').should('not.have.class', 'outOfSync');
 		cy.get('#autoSync').check();
-		cy.get('#editor').type('ing');
+		getEditor().type('ing');
 		cy.get('#view').should('not.have.class', 'outOfSync');
 		cy.getLocalStorage('codeStore').snapshot();
 	});
 
 	it('supports commenting code out/in', () => {
-		const cmd = Cypress.platform === 'darwin' ? 'meta' : 'ctrl';
-
-		cy.get('#editor').type(`{uparrow}{${cmd}}/`);
+		getEditor().type(`{uparrow}{${cmd}}/`);
 		cy.get('#view').contains('Car').should('not.exist');
 
-		cy.get('#editor').type(`{uparrow}{${cmd}}/`);
+		getEditor().type(`{uparrow}{${cmd}}/`);
 		cy.get('#view').contains('Car').should('exist');
 	});
+
+	it('supports editing code when code is incorrect', () => {
+		cy.visit(
+			'/edit#pako:eNpljjEKwzAMRa8SNOcEnlt6gK5eVFvYJsgOqkwpIXevg9smEE1PnyfxF3DFExgISW-CczQ2D21cYU7a-SGYXRwyvTp9jUhuKlVP-eHy7zA-leQsMEmg_QOM0BLG5FujZVMsaCQmC6ahR5ks2Lw2r84ela4-aREwKpVGwKrl_s7ut3fnkjAIcg_XDzuaUhs'
+		);
+		cy.get('#errorContainer').should('not.exist');
+		getEditor({ newline: true }).type(`branch test`);
+		cy.get('#editor').contains('branch test').should('exist');
+		cy.get('#errorContainer')
+			.contains(
+				'Error: Trying to checkout branch which is not yet created. (Help try using "branch master")'
+			)
+			.should('exist');
+	});
 });

cypress/e2e/docMap.spec.ts

@@ -0,0 +1,36 @@
+describe('Editor docs tests', () => {
+	beforeEach(() => {
+		cy.on('uncaught:exception', () => {
+			return false;
+		});
+		cy.clearLocalStorage();
+		cy.visit('/edit');
+		cy.contains('Sample Diagrams').click();
+	});
+
+	it('Test default loading', () => {
+		cy.get(`[data-cy=docs][href^="https://mermaid-js.github.io/mermaid"]`).should('exist');
+	});
+
+	it('Test to see if the correct URL loads when changing from one diagram to other', () => {
+		cy.contains('Flow Chart').click();
+		cy.get(`[data-cy=docs][href$="/#/flowchart"]`).should('exist');
+
+		cy.contains('Config').click();
+		cy.get(`[data-cy=docs][href$="/#/flowchart?id=configuration"]`).should('exist');
+
+		cy.contains('Sequence Diagram').click();
+		cy.get(`[data-cy=docs][href$="/#/sequenceDiagram?id=configuration"]`).should('exist');
+
+		cy.contains('Code').click();
+		cy.get(`[data-cy=docs][href$="/#/sequenceDiagram"]`).should('exist');
+	});
+
+	it("Test to check URLs for a case where config URL doesn't exist", () => {
+		cy.contains('State Diagram').click();
+		cy.get(`[data-cy=docs][href$="/#/stateDiagram"]`).should('exist');
+
+		cy.contains('Config').click();
+		cy.get(`[data-cy=docs][href$="/#/stateDiagram"]`).should('exist');
+	});
+});

cypress/e2e/history.spec.ts

@@ -46,7 +46,8 @@ describe('Save History', () => {
 		cy.get('#historyList').contains('No items in History');
 	});
 
-	it('should auto save history', () => {
+	// TODO: Fix #639
+	xit('should auto save history', () => {
 		cy.get('#editor').type('  C --> HistoryTest');
 		cy.tick(70000);
 		cy.contains('Timeline').click();

cypress/e2e/loadSite.spec.ts

@@ -17,7 +17,7 @@ describe('Site Loads', () => {
 		);
 		cy.url().should(
 			'include',
-			'/edit#eyJjb2RlIjoiZ3JhcGggVERcbiAgICBBW0NocmlzdG1hc10gLS0-fEdldCBtb25leXwgQihHbyBzaG9wcGluZylcbiAgICBCIC0tPiBDe0xldCBtZSB0aGlua31cbiAgICBDIC0tPnxPbmV8IERbTGFwdG9wXVxuICAgIEMgLS0-fFR3b3wgRVtpUGhvbmVdXG4gICAgQyAtLT58VGhyZWV8IEZbZmE6ZmEtY2FyIENhcl0iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9LCJ1cGRhdGVFZGl0b3IiOmZhbHNlfQ'
+			'/edit#pako:eNpVkM1qw0AMhF9F6NRC_AI-FBo7zSXQQHLz-iC8cnZJ9oe1TAm2373rmkKrk9B8MwyasAuascRbomjgWisPed6byiQ7iKOhhaJ4m48s4ILn5wz7l2OAwYQYrb-9bvx-haCaTivGIMb6-7JJ1Y__0_MMdXOiKCG2f5XrV5jh0NizyfH_FZM4uz6ansqeio4SVJRa3KHj5MjqXHtaDQrFsGOFZV419zQ-RKHyS0bHqEn4oK2EhDnmMfAOaZRwefoOS0kj_0K1pfwFtx2XbzAdW4g'
 		);
 		cy.contains('History').click();
 		cy.getLocalStorage('codeStore').snapshot();

cypress/e2e/themes.spec.ts

@@ -32,7 +32,6 @@ describe('Test themes', () => {
 	});
 
 	describe('Test dark mode', () => {
-		// eslint-disable-next-line mocha/no-hooks-for-single-case
 		beforeEach(() => {
 			cy.clearLocalStorage();
 			cy.visit('/edit', {

cypress/integration/actions.spec.ts

@@ -1,24 +0,0 @@
-describe('Check actions', () => {
-	beforeEach(() => {
-		cy.clearLocalStorage();
-		cy.visit('/edit');
-	});
-	it('should update markdown code', () => {
-		cy.get('#markdown')
-			.invoke('val')
-			.then((oldText) => {
-				cy.get('#editor').click('bottom').type('{enter}C --> HistoryTest');
-				cy.get('#markdown')
-					.invoke('val')
-					.then((newText) => {
-						expect(oldText).to.not.eq(newText);
-					});
-			});
-	});
-
-	it('should load gists from URL', () => {
-		cy.get('#gist').type('https://gist.github.com/sidharthv96/6268a23e673a533dcb198f241fd7012a');
-		cy.contains('Load Gist').click();
-		cy.contains('Go shopping!!');
-	});
-});

cypress/plugins/index.cjs

@@ -1,31 +0,0 @@
-/// <reference types="cypress" />
-// ***********************************************************
-// This example plugins/index.js can be used to load plugins
-//
-// You can change the location of this file or turn off loading
-// the plugins file with the 'pluginsFile' configuration option.
-//
-// You can read more here:
-// https://on.cypress.io/plugins-guide
-// ***********************************************************
-
-// This function is called when a project is opened or re-opened (e.g. due to
-// the project's config changing)
-
-/**
- * @type {Cypress.PluginConfig}
- */
-// eslint-disable-next-line no-unused-vars
-import * as fs from 'fs';
-
-module.exports = (on, config) => {
-	on('task', {
-		readFileMaybe(filename) {
-			if (fs.existsSync(filename)) {
-				return fs.readFileSync(filename, 'utf8');
-			}
-
-			return null;
-		}
-	});
-};

cypress/snapshots.js

@@ -16,7 +16,7 @@ module.exports = {
       "1": "{\"code\":\"graph TD\\n    A[Party] -->|Get money| B(Go shopping!!)\\n    \",\"mermaid\":\"{\\n  \\\"theme\\\": \\\"forest\\\",\\n  \\\"test\\\": \\\"hello world\\\"\\n}\",\"updateEditor\":false,\"autoSync\":true,\"updateDiagram\":true,\"loader\":{\"type\":\"files\",\"config\":{\"codeURL\":\"https://gist.githubusercontent.com/sidharthv96/6268a23e673a533dcb198f241fd7012a/raw/4eb03887e6a41397e80bdcdbf94017c498f8f1e2/code.mmd\",\"configURL\":\"https://gist.githubusercontent.com/sidharthv96/6268a23e673a533dcb198f241fd7012a/raw/4eb03887e6a41397e80bdcdbf94017c498f8f1e2/config.json\"}}}"
     }
   },
-  "__version": "9.3.1",
+  "__version": "10.3.0",
   "Auto sync tests": {
     "should dim diagram when code is edited": {
       "1": "{\"code\":\"graph TD\\n    A[Christmas] -->|Get money| B(Go shopping)\\n    B --> C{Let me think}\\n    C -->|One| D[Laptop]\\n    C -->|Two| E[iPhone]\\n    C -->|Three| F[fa:fa-car Car]\\n    C --> Test\",\"mermaid\":\"{\\n  \\\"theme\\\": \\\"default\\\"\\n}\",\"updateEditor\":false,\"autoSync\":false,\"updateDiagram\":false}"

cypress/support/e2e.js

@@ -15,6 +15,7 @@
 
 // Import commands.js using ES2015 syntax:
 import './commands';
+require('cy-verify-downloads').addCustomCommand();
 
 // Alternatively you can use CommonJS syntax:
 // require('./commands')

cypress/tsconfig.json

@@ -1,7 +1,7 @@
 {
 	"compilerOptions": {
 		"allowJs": true,
-		"types": ["cypress", "cypress-localstorage-commands"]
+		"types": ["cypress", "cypress-localstorage-commands", "cy-verify-downloads"]
 	},
 	"include": ["**/*.ts"]
 }

nginx.conf

@@ -0,0 +1,9 @@
+server { 
+ listen 80;
+ server_name mermaid;
+ location / {
+   root /usr/share/nginx/html;
+	 # Fallback to index.html for other paths
+   try_files $uri /index.html;
+ }
+}

package.json

@@ -1,66 +1,79 @@
 {
 	"name": "mermaid-live-editor",
 	"version": "2.0.67",
+	"type": "module",
+	"license": "MIT",
 	"scripts": {
-		"dev": "svelte-kit dev --host 0.0.0.0",
-		"build": "svelte-kit build",
-		"preview": "svelte-kit preview",
-		"lint": "prettier --check --plugin-search-dir=. . && eslint --ignore-path .gitignore .",
-		"lint:fix": "prettier --write --plugin-search-dir=. . && eslint --fix --ignore-path .gitignore .",
-		"format": "prettier --write --plugin-search-dir=. .",
+		"dev": "vite dev --host 0.0.0.0",
+		"build": "vite build",
+		"preview": "vite preview",
+		"lint": "prettier --check --cache --plugin-search-dir=. .;eslint --ignore-path .gitignore .",
+		"lint:fix": "prettier --write --cache --plugin-search-dir=. .;eslint --fix --ignore-path .gitignore .",
+		"format": "prettier --write --cache --plugin-search-dir=. .",
 		"pre-commit": "lint-staged",
-		"postinstall": "husky install",
-		"test": "cypress run",
+		"postinstall": "husky install; cypress cache prune; svelte-kit sync",
+		"test:unit": "vitest",
+		"test:ui": "vitest --ui",
+		"test:coverage": "vitest run --coverage",
+		"test:browser": "cypress run",
+		"test": "test:unit && test:browser",
 		"cy": "cypress open"
 	},
 	"devDependencies": {
-		"@cypress/snapshot": "^2.1.7",
-		"@sveltejs/adapter-static": "1.0.0-next.26",
-		"@sveltejs/kit": "1.0.0-next.247",
-		"@types/mermaid": "^8.2.7",
-		"@types/pako": "^1.0.3",
-		"@typescript-eslint/eslint-plugin": "^4.33.0",
-		"@typescript-eslint/parser": "^4.33.0",
-		"autoprefixer": "^10.4.2",
-		"chai": "^4.3.6",
-		"cssnano": "^5.0.16",
-		"cypress": "9.3.1",
-		"cypress-localstorage-commands": "^1.6.1",
-		"eslint": "^7.32.0",
-		"eslint-config-prettier": "^8.1.0",
-		"eslint-plugin-cypress": "^2.12.1",
-		"eslint-plugin-es": "^4.1.0",
-		"eslint-plugin-mocha": "^10.0.3",
-		"eslint-plugin-postcss-modules": "^2.0.0",
-		"eslint-plugin-svelte3": "^3.4.0",
-		"eslint-plugin-tailwindcss": "^3.3.6",
-		"husky": "^7.0.4",
-		"lint-staged": "^12.3.2",
-		"mocha": "^9.2.0",
-		"node-html-parser": "^5.2.0",
-		"postcss": "^8.4.5",
-		"postcss-load-config": "^3.1.1",
-		"prettier": "~2.5.1",
-		"prettier-plugin-svelte": "^2.6.0",
-		"svelte": "^3.46.3",
-		"svelte-preprocess": "^4.10.2",
-		"tailwindcss": "^3.0.17",
-		"tslib": "^2.3.1",
-		"typescript": "^4.5.5"
+		"@cypress/snapshot": "2.1.7",
+		"@sveltejs/adapter-static": "1.0.0-next.34",
+		"@sveltejs/kit": "1.0.0-next.359",
+		"@testing-library/jest-dom": "5.16.4",
+		"@testing-library/svelte": "3.1.3",
+		"@types/mermaid": "8.2.9",
+		"@types/pako": "1.0.3",
+		"@typescript-eslint/eslint-plugin": "5.30.5",
+		"@typescript-eslint/parser": "5.30.5",
+		"@vitest/ui": "0.17.0",
+		"autoprefixer": "10.4.7",
+		"c8": "7.11.3",
+		"chai": "4.3.6",
+		"cssnano": "5.1.12",
+		"cy-verify-downloads": "0.1.8",
+		"cypress": "10.3.0",
+		"cypress-localstorage-commands": "2.1.0",
+		"eslint": "8.19.0",
+		"eslint-config-prettier": "8.5.0",
+		"eslint-plugin-cypress": "2.12.1",
+		"eslint-plugin-es": "4.1.0",
+		"eslint-plugin-postcss-modules": "2.0.0",
+		"eslint-plugin-svelte3": "4.0.0",
+		"eslint-plugin-tailwindcss": "3.6.0",
+		"eslint-plugin-vitest": "0.0.8",
+		"husky": "8.0.1",
+		"jsdom": "20.0.0",
+		"lint-staged": "13.0.3",
+		"node-html-parser": "5.3.3",
+		"postcss": "8.4.14",
+		"postcss-load-config": "4.0.1",
+		"prettier": "2.7.1",
+		"prettier-plugin-svelte": "2.7.0",
+		"svelte": "3.48.0",
+		"svelte-preprocess": "4.10.7",
+		"tailwindcss": "3.1.4",
+		"tslib": "2.4.0",
+		"typescript": "4.7.4",
+		"vite": "2.9.13",
+		"vitest": "0.17.0",
+		"vitest-svelte-kit": "0.0.6"
 	},
-	"type": "module",
 	"dependencies": {
-		"@analytics/google-analytics": "^0.5.3",
-		"@macfja/svelte-persistent-store": "^1.2.0",
-		"analytics": "^0.7.21",
-		"daisyui": "1.25.4",
-		"js-base64": "^3.7.2",
-		"mermaid": "8.13.10",
-		"moment": "^2.29.1",
-		"monaco-editor": "^0.31.1",
-		"monaco-mermaid": "^1.0.3",
+		"@analytics/google-analytics": "0.5.3",
+		"@macfja/svelte-persistent-store": "1.3.0",
+		"analytics": "0.8.1",
+		"daisyui": "2.17.0",
+		"js-base64": "3.7.2",
+		"mermaid": "9.1.3",
+		"moment": "2.29.4",
+		"monaco-editor": "0.33.0",
+		"monaco-mermaid": "1.0.6",
 		"pako": "2.0.4",
-		"random-word-slugs": "^0.1.6"
+		"random-word-slugs": "0.1.6"
 	},
 	"lint-staged": {
 		"*.{ts,svelte,js,css,md,json}": [
@@ -69,8 +82,10 @@
 		]
 	},
 	"volta": {
-		"node": "14.16.1",
-		"yarn": "1.22.10",
-		"npm": "7.11.2"
+		"node": "16.15.0",
+		"yarn": "1.22.10"
+	},
+	"engines": {
+		"node": ">=16.7"
 	}
 }

src/app.html

@@ -11,37 +11,37 @@
 		<meta
 			name="description"
 			content="Simplify documentation and avoid heavy tools. Open source Visio Alternative. Commonly used for explaining your code! Mermaid is a simple markdown-like script language for generating charts from text via javascript." />
-		<link rel="icon" type="image/png" href="/favicon.png" />
-		<link rel="manifest" href="/manifest.json" />
+		<link rel="icon" type="image/png" href="%sveltekit.assets%/favicon.png" />
+		<link rel="manifest" href="%sveltekit.assets%/manifest.json" />
 		<link
 			rel="stylesheet"
 			href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.2/css/all.min.css" />
 		<link
 			rel="stylesheet"
-			href="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.31.1/min/vs/editor/editor.main.min.css"
+			href="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.33.0/min/vs/editor/editor.main.min.css"
 			crossorigin="anonymous"
 			referrerpolicy="no-referrer" />
 		<script>
 			var require = {
-				paths: { vs: 'https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.31.1/min/vs' }
+				paths: { vs: 'https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.33.0/min/vs' }
 			};
 		</script>
 		<script
-			src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.31.1/min/vs/loader.min.js"
+			src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.33.0/min/vs/loader.min.js"
 			crossorigin="anonymous"
 			referrerpolicy="no-referrer"></script>
 		<script
-			src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.31.1/min/vs/editor/editor.main.nls.min.js"
+			src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.33.0/min/vs/editor/editor.main.nls.min.js"
 			crossorigin="anonymous"
 			referrerpolicy="no-referrer"></script>
 		<script
-			src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.31.1/min/vs/editor/editor.main.js"
+			src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.33.0/min/vs/editor/editor.main.js"
 			crossorigin="anonymous"
 			referrerpolicy="no-referrer"></script>
 
-		%svelte.head%
+		%sveltekit.head%
 	</head>
 	<body>
-		<div id="svelte">%svelte.body%</div>
+		<div id="svelte">%sveltekit.body%</div>
 	</body>
 </html>

src/global.d.ts

@@ -1 +1,15 @@
+/* eslint-disable @typescript-eslint/no-empty-interface */
+/* eslint-disable @typescript-eslint/ban-types */
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
 /// <reference types="@sveltejs/kit" />
+import type { TestingLibraryMatchers } from '@testing-library/jest-dom/matchers';
+
+declare global {
+	namespace jest {
+		interface Matchers<R = void>
+			// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+			// @ts-ignore
+			extends TestingLibraryMatchers<typeof expect.stringContaining, R> {}
+	}
+}

src/hooks.ts

@@ -1,4 +1,4 @@
-import type { Handle } from '@sveltejs/kit/types/hooks';
+import type { Handle } from '@sveltejs/kit';
 
 export const handle: Handle = async ({ event, resolve }) => {
 	const response = await resolve(event, {

src/lib/components/actions.svelte

@@ -4,17 +4,20 @@
 	import Card from '$lib/components/card/card.svelte';
 	import { krokiRendererUrl, rendererUrl } from '$lib/util/env';
 	import { pakoSerde } from '$lib/util/serde';
-	import { serializedState, codeStore } from '$lib/util/state';
+	import { stateStore } from '$lib/util/state';
 	import { toBase64 } from 'js-base64';
 	import moment from 'moment';
 
 	type Exporter = (context: CanvasRenderingContext2D, image: HTMLImageElement) => () => void;
 
+	const getFileName = (ext: string) =>
+		`mermaid-diagram-${moment().format('YYYY-MM-DD-HHmmss')}.${ext}`;
+
 	const getBase64SVG = (svg?: HTMLElement, width?: number, height?: number): string => {
 		svg?.setAttribute('height', `${height}px`);
 		svg?.setAttribute('width', `${width}px`); // Workaround https://stackoverflow.com/questions/28690643/firefox-error-rendering-an-svg-image-to-html5-canvas-with-drawimage
 		if (!svg) {
-			svg = document.querySelector('#container svg');
+			svg = getSvgEl();
 		}
 		const svgString = svg.outerHTML
 			.replaceAll('<br>', '<br/>')
@@ -50,6 +53,23 @@
 		event.preventDefault();
 	};
 
+	const getSvgEl = () => {
+		const svgEl: HTMLElement = document
+			.querySelector('#container svg')
+			.cloneNode(true) as HTMLElement;
+		svgEl.setAttribute('xmlns:xlink', 'http://www.w3.org/1999/xlink');
+		const fontAwesomeCdnUrl = Array.from(document.head.getElementsByTagName('link'))
+			.map((l) => l.href)
+			.find((h) => h && h.includes('font-awesome'));
+		if (fontAwesomeCdnUrl == null) {
+			return svgEl;
+		}
+		const styleEl = document.createElement('style');
+		styleEl.innerText = `@import url("${fontAwesomeCdnUrl}");'`;
+		svgEl.prepend(styleEl);
+		return svgEl;
+	};
+
 	const simulateDownload = (download: string, href: string): void => {
 		const a = document.createElement('a');
 		a.download = download;
@@ -62,7 +82,7 @@
 			const { canvas } = context;
 			context.drawImage(image, 0, 0, canvas.width, canvas.height);
 			simulateDownload(
-				`mermaid-diagram-${moment().format('YYYYMMDDHHmmss')}.png`,
+				getFileName('png'),
 				canvas.toDataURL('image/png').replace('image/png', 'image/octet-stream')
 			);
 		};
@@ -102,10 +122,7 @@
 	};
 
 	const onDownloadSVG = () => {
-		simulateDownload(
-			`mermaid-diagram-${moment().format('YYYYMMDDHHmmss')}.svg`,
-			`data:image/svg+xml;base64,${getBase64SVG()}`
-		);
+		simulateDownload(getFileName('svg'), `data:image/svg+xml;base64,${getBase64SVG()}`);
 	};
 
 	const onCopyMarkdown = () => {
@@ -114,10 +131,10 @@
 	};
 
 	let gistURL = '';
-	codeStore.subscribe((state) => {
-		if (state.loader?.type === 'gist') {
+	stateStore.subscribe(({ loader }) => {
+		if (loader?.type === 'gist') {
 			// @ts-ignore Gist will have url
-			gistURL = state.loader.config.url;
+			gistURL = loader.config.url;
 		}
 	});
 
@@ -139,11 +156,11 @@
 	if (browser && ['mermaid.live', 'netlify'].some((path) => window.location.host.includes(path))) {
 		isNetlify = true;
 	}
-	serializedState.subscribe((encodedState: string) => {
-		iUrl = `${rendererUrl}/img/${encodedState}`;
-		svgUrl = `${rendererUrl}/svg/${encodedState}`;
-		krokiUrl = `${krokiRendererUrl}/mermaid/svg/${pakoSerde.serialize($codeStore.code)}`;
-		mdCode = `[![](${iUrl})](${window.location.protocol}//${window.location.host}${window.location.pathname}#${encodedState})`;
+	stateStore.subscribe(({ code, serialized }) => {
+		iUrl = `${rendererUrl}/img/${serialized}`;
+		svgUrl = `${rendererUrl}/svg/${serialized}`;
+		krokiUrl = `${krokiRendererUrl}/mermaid/svg/${pakoSerde.serialize(code)}`;
+		mdCode = `[![](${iUrl})](${window.location.protocol}//${window.location.host}${window.location.pathname}#${serialized})`;
 	});
 </script>
 
@@ -154,21 +171,29 @@
 				><i class="far fa-copy mr-2" /> Copy Image to clipboard
 			</button>
 		{/if}
-		<button class="action-btn flex-auto" on:click={onDownloadPNG}>
+		<button id="downloadPNG" class="action-btn flex-auto" on:click={onDownloadPNG}>
 			<i class="fas fa-download mr-2" /> PNG
 		</button>
-		<button class="action-btn flex-auto" on:click={onDownloadSVG}>
+		<button id="downloadSVG" class="action-btn flex-auto" on:click={onDownloadSVG}>
 			<i class="fas fa-download mr-2" /> SVG
 		</button>
-		<button class="action-btn flex-auto">
-			<a target="_blank" href={iUrl}><i class="fas fa-external-link-alt mr-2" /> PNG</a>
-		</button>
-		<button class="action-btn flex-auto">
-			<a target="_blank" href={svgUrl}><i class="fas fa-external-link-alt mr-2" /> SVG</a>
-		</button>
-		<button class="action-btn flex-auto">
-			<a target="_blank" href={krokiUrl}><i class="fas fa-external-link-alt mr-2" /> Kroki</a>
-		</button>
+		<a target="_blank" href={iUrl}>
+			<button class="action-btn flex-auto">
+				<i class="fas fa-external-link-alt mr-2" /> PNG
+			</button>
+		</a>
+
+		<a target="_blank" href={svgUrl}>
+			<button class="action-btn flex-auto">
+				<i class="fas fa-external-link-alt mr-2" /> SVG
+			</button>
+		</a>
+
+		<a target="_blank" href={krokiUrl}>
+			<button class="action-btn flex-auto">
+				<i class="fas fa-external-link-alt mr-2" /> Kroki
+			</button>
+		</a>
 
 		<div class="flex gap-2 items-center">
 			PNG size

src/lib/components/card/__snapshots__/card.test.ts.snap

@@ -0,0 +1,3 @@
+// Vitest Snapshot v1
+
+exports[`card.svelte > mounts 1`] = `"<div><div class=\\"card rounded overflow-hidden m-2 flex-grow flex flex-col shadow-2xl\\"><div class=\\"bg-primary p-2 pb-0 flex-none cursor-pointer\\"><div class=\\"flex justify-between\\"><div class=\\"flex cursor-default s-_wx1E_JHsCoF\\"><span class=\\"mr-2 font-semibold s-_wx1E_JHsCoF\\"><i class=\\"fas fa-chevron-right icon s-_wx1E_JHsCoF isOpen\\"></i> TabTest</span> <ul class=\\"tabs s-_wx1E_JHsCoF\\"><div class=\\"tab tab-lifted tab-active s-_wx1E_JHsCoF\\"><i class=\\"mr-1 undefined s-_wx1E_JHsCoF\\"></i> title1 </div><div class=\\"tab tab-lifted text-primary-content s-_wx1E_JHsCoF\\"><i class=\\"mr-1 undefined s-_wx1E_JHsCoF\\"></i> title2 </div></ul></div><!--<Tabs>--> <div class=\\"flex gap-x-4 items-center -mt-2\\"></div></div></div> <div class=\\"card-body p-0 flex-grow overflow-auto text-base-content\\"></div></div><!--<Card>--></div>"`;

src/lib/components/card/card.test.ts

@@ -0,0 +1,24 @@
+import { cleanup, render } from '@testing-library/svelte';
+import { describe, expect, it, afterEach } from 'vitest';
+import Card from './card.svelte';
+
+describe('card.svelte', () => {
+	// TODO: @testing-library/svelte claims to add this automatically but it doesn't work without explicit afterEach
+	afterEach(() => cleanup());
+
+	it('mounts', () => {
+		const { container } = render(Card, {
+			title: 'TabTest',
+			tabs: [
+				{ id: 't1', title: 'title1' },
+				{ id: 't2', title: 'title2' }
+			]
+		});
+		expect(container).toBeTruthy();
+		expect(container).toHaveTextContent('TabTest');
+		expect(container).toHaveTextContent('title1');
+		expect(container).toHaveTextContent('title2');
+		expect(container).not.toHaveTextContent('title3');
+		expect(container.innerHTML).toMatchSnapshot();
+	});
+});

src/lib/components/card/tabs.svelte

@@ -26,7 +26,7 @@
 		<ul class="tabs" transition:fade>
 			{#each tabs as tab}
 				<div
-					class="tab tab-lifted text-primary-content {activeTabID === tab.id ? 'tab-active' : ''}"
+					class="tab tab-lifted {activeTabID === tab.id ? 'tab-active' : 'text-primary-content'}"
 					on:click|stopPropagation={() => toggleTabs(tab)}>
 					<i class="mr-1 {tab.icon}" />
 					{tab.title}

src/lib/components/editor.svelte

@@ -1,6 +1,6 @@
 <script lang="ts">
 	import type { EditorEvents } from '$lib/types';
-	import { codeStore } from '$lib/util/state';
+	import { stateStore } from '$lib/util/state';
 	import { themeStore } from '$lib/util/theme';
 	import type monaco from 'monaco-editor';
 	import { createEventDispatcher, onMount } from 'svelte';
@@ -21,17 +21,16 @@
 		theme: 'mermaid',
 		overviewRulerLanes: 0
 	};
-	export let errorMarkers: monaco.editor.IMarkerData[] = [];
 	let oldText = text;
 	$: editor && Monaco?.editor.setModelLanguage(editor.getModel(), language);
 	$: {
 		if (text !== oldText) {
-			if ($codeStore.updateEditor) {
+			if ($stateStore.updateEditor) {
 				editor?.setValue(text);
 			}
 			oldText = text;
 		}
-		editor && Monaco?.editor.setModelMarkers(editor.getModel(), 'test', errorMarkers);
+		editor && Monaco?.editor.setModelMarkers(editor.getModel(), 'test', $stateStore.errorMarkers);
 	}
 
 	themeStore.subscribe(({ isDark }) => {

src/lib/components/history/history.svelte

@@ -1,6 +1,6 @@
 <script lang="ts">
 	import Card from '$lib/components/card/card.svelte';
-	import { codeStore, getStateString } from '$lib/util/state';
+	import { inputStateStore, getStateString } from '$lib/util/state';
 	import {
 		addHistoryEntry,
 		historyModeStore,
@@ -37,7 +37,7 @@
 		const previousState: string = getPreviousState(auto);
 		if (previousState !== currentState) {
 			addHistoryEntry({
-				state: $codeStore,
+				state: $inputStateStore,
 				time: Date.now(),
 				type: auto ? 'auto' : 'manual'
 			});
@@ -54,7 +54,7 @@
 	};
 
 	const restoreHistory = (state: State): void => {
-		codeStore.set({ ...state, updateEditor: true, updateDiagram: true });
+		inputStateStore.set({ ...state, updateEditor: true, updateDiagram: true });
 	};
 
 	const relativeTime = (time: number) => {

src/lib/components/preset.svelte

@@ -79,11 +79,26 @@
     section Go home
       Go downstairs: 5: Me
       Sit down: 3: Me
-      `
+      `,
+		'Git Graph': `    gitGraph
+      commit
+      commit
+      branch develop
+      checkout develop
+      commit
+      commit
+      checkout main
+      merge develop
+      commit
+      commit
+`
 	};
 
 	const loadSampleDiagram = (diagramType: string): void => {
-		updateCode(samples[diagramType], true, true);
+		updateCode(samples[diagramType], {
+			updateDiagram: true,
+			updateEditor: true
+		});
 	};
 </script>
 

src/lib/components/view.svelte

@@ -1,7 +1,5 @@
 <script lang="ts">
-	import { errorStore } from '$lib/util/error';
-
-	import { codeStore } from '$lib/util/state';
+	import { inputStateStore, stateStore } from '$lib/util/state';
 	import { onMount } from 'svelte';
 	import mermaid from 'mermaid';
 
@@ -13,11 +11,16 @@
 	let outOfSync = false;
 	let manualUpdate = true;
 	onMount(() => {
-		codeStore.subscribe((state) => {
+		stateStore.subscribe((state) => {
+			if (state.error !== undefined) {
+				error = true;
+				return;
+			}
+			error = false;
 			try {
 				if (container && state && (state.updateDiagram || state.autoSync)) {
 					if (!state.autoSync) {
-						$codeStore.updateDiagram = false;
+						$inputStateStore.updateDiagram = false;
 					}
 					outOfSync = false;
 					manualUpdate = true;
@@ -31,7 +34,10 @@
 					delete container.dataset.processed;
 					mermaid.initialize(Object.assign({}, JSON.parse(state.mermaid)));
 					mermaid.render('graph-div', code, (svgCode) => {
-						container.innerHTML = svgCode;
+						if (svgCode.length > 0) {
+							console.log(svgCode);
+							container.innerHTML = svgCode;
+						}
 					});
 					view.parentElement.scrollTop = scroll;
 					error = false;
@@ -45,24 +51,19 @@
 				error = true;
 			}
 		});
-		errorStore.subscribe((err) => {
-			if (typeof err === 'undefined') {
-				error = false;
-			} else {
-				error = true;
-				console.log('Error: ', err);
-			}
-		});
 	});
 </script>
 
+{#if error && $stateStore.error instanceof Error}
+	<div class="p-2 text-red-600" id="errorContainer">{$stateStore.error}</div>
+{/if}
+
 <div id="view" bind:this={view} class="p-2" class:error class:outOfSync>
 	<div id="container" bind:this={container} class="flex-1 overflow-auto" />
 </div>
 
 <style>
 	#view {
-		border: 1px solor darkred;
 		flex: 1;
 	}
 	.error,

src/lib/types.d.ts

@@ -6,6 +6,16 @@ export interface Locals {
 	userid: string;
 }
 
+export interface MarkerData {
+	severity: number;
+	message: string;
+	source?: string;
+	startLineNumber: number;
+	startColumn: number;
+	endLineNumber: number;
+	endColumn: number;
+}
+
 export interface EditorUpdateEvent {
 	text: string;
 }
@@ -32,6 +42,12 @@ export interface State {
 	loader?: LoaderConfig;
 }
 
+export interface ValidatedState extends State {
+	error: unknown;
+	errorMarkers: MarkerData[];
+	serialized: string;
+}
+
 export interface GistLoaderConfig {
 	url: string;
 }
@@ -57,4 +73,11 @@ export interface HistoryEntry {
 	url?: string;
 }
 
-type Loader = (url: string) => Promise<State>;
+export interface DocConfig {
+	[key: string]: {
+		code: string;
+		config?: string;
+	};
+}
+
+export type Loader = (url: string) => Promise<State>;

src/lib/util/error.ts

@@ -1,3 +0,0 @@
-import { writable } from 'svelte/store';
-
-export const errorStore = writable(undefined);

src/lib/util/fileLoaders/gist.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-unsafe-return */
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 /* eslint-disable @typescript-eslint/no-explicit-any */
@@ -43,6 +44,7 @@ const getGistData = async (gistURL: string): Promise<GistData> => {
 		}
 		const currentItem = history[0];
 		return {
+			// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
 			url: `${html_url}/${currentItem.version}`,
 			code,
 			config,

src/lib/util/fileLoaders/loader.ts

@@ -23,6 +23,9 @@ export const loadDataFromUrl = async (): Promise<void> => {
 		config = defaultState.mermaid;
 	}
 	if (!code) {
+		// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+		// @ts-ignore
+		// eslint-disable-next-line @typescript-eslint/no-unsafe-call
 		for (const [key, value] of searchParams.entries()) {
 			if (key in loaders) {
 				try {
@@ -54,5 +57,4 @@ export const loadDataFromUrl = async (): Promise<void> => {
 			updateDiagram: true,
 			updateEditor: true
 		});
-	// window.location.search = '';
 };

src/lib/util/serde.test.ts

@@ -0,0 +1,40 @@
+import { describe, expect, it } from 'vitest';
+import { serializeState, deserializeState, type SerdeType } from './serde';
+import { defaultState } from './state';
+import type { State } from '$lib/types';
+
+describe('Serde tests', () => {
+	const verifySerde = (state: State, serde?: SerdeType): string => {
+		const serialized = serializeState(state, serde);
+		const deserialized = deserializeState(serialized);
+		expect(deserialized).to.deep.equal(state);
+		return serialized;
+	};
+
+	it('should serialize and deserialize with default serde', () => {
+		expect(verifySerde(defaultState)).toMatchInlineSnapshot(
+			'"pako:eNpVkM1qw0AMhF9F6JRC_AI-FBo7ySXQQnPz5iC8cnZp9oe1TAm2373rmEKik5j5ZhAasQ2ascRromjgXCsPeT6ayiTbi6P-AkXxPh1ZwAXP9wl2m2OA3oQYrb--rfxugaAaTwvGIMb6n3m1qkf-0_MEdXOiKCFenp3zb5hg39gvk-tfHZM4pw5NR2VHRUsJKkoPBLfoODmyOp8-LopCMexYYZlXzR0NN1Go_JzRIWoS3msrIWGuuvW8RRokfN99i6Wkgf-h2lL-hFvF-Q9-YFyS"'
+		);
+	});
+
+	it('should serialize and deserialize with base64 serde', () => {
+		expect(verifySerde(defaultState, 'base64')).toMatchInlineSnapshot(
+			'"base64:eyJjb2RlIjoiZ3JhcGggVERcbiAgICBBW0NocmlzdG1hc10gLS0-fEdldCBtb25leXwgQihHbyBzaG9wcGluZylcbiAgICBCIC0tPiBDe0xldCBtZSB0aGlua31cbiAgICBDIC0tPnxPbmV8IERbTGFwdG9wXVxuICAgIEMgLS0-fFR3b3wgRVtpUGhvbmVdXG4gICAgQyAtLT58VGhyZWV8IEZbZmE6ZmEtY2FyIENhcl1cbiAgIiwibWVybWFpZCI6IntcbiAgXCJ0aGVtZVwiOiBcImRlZmF1bHRcIlxufSIsInVwZGF0ZUVkaXRvciI6ZmFsc2UsImF1dG9TeW5jIjp0cnVlLCJ1cGRhdGVEaWFncmFtIjp0cnVlfQ"'
+		);
+	});
+
+	it('should serialize and deserialize with pako serde', () => {
+		expect(verifySerde(defaultState, 'pako')).toMatchInlineSnapshot(
+			'"pako:eNpVkM1qw0AMhF9F6JRC_AI-FBo7ySXQQnPz5iC8cnZp9oe1TAm2373rmEKik5j5ZhAasQ2ascRromjgXCsPeT6ayiTbi6P-AkXxPh1ZwAXP9wl2m2OA3oQYrb--rfxugaAaTwvGIMb6n3m1qkf-0_MEdXOiKCFenp3zb5hg39gvk-tfHZM4pw5NR2VHRUsJKkoPBLfoODmyOp8-LopCMexYYZlXzR0NN1Go_JzRIWoS3msrIWGuuvW8RRokfN99i6Wkgf-h2lL-hFvF-Q9-YFyS"'
+		);
+	});
+
+	it('should throw error for unrecognized serde', () => {
+		// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+		// @ts-expect-error
+		expect(() => serializeState(defaultState, 'unknown')).toThrowError(
+			'Unknown serde type: unknown'
+		);
+		expect(() => deserializeState('unknown:hello')).toThrowError('Unknown serde type: unknown');
+	});
+});

src/lib/util/serde.ts

@@ -28,18 +28,20 @@ export const pakoSerde: Serde = {
 	}
 };
 
-const serdes: { [key: string]: Serde } = {
+export type SerdeType = 'base64' | 'pako';
+
+const serdes: { [key in SerdeType]: Serde } = {
 	base64: base64Serde,
 	pako: pakoSerde
 };
 
-type SerdeType = keyof typeof serdes;
-
-export const serializeState = (state: State): string => {
+export const serializeState = (state: State, serde: SerdeType = 'pako'): string => {
+	if (serdes[serde] === undefined) {
+		throw new Error(`Unknown serde type: ${serde}`);
+	}
 	const json = JSON.stringify(state);
-	const defaultSerde: SerdeType = 'pako';
-	const serialized = serdes[defaultSerde].serialize(json);
-	return `${defaultSerde}:${serialized}`;
+	const serialized = serdes[serde].serialize(json);
+	return `${serde}:${serialized}`;
 };
 
 export const deserializeState = (state: string): State => {
@@ -48,7 +50,7 @@ export const deserializeState = (state: string): State => {
 		let tempType: string;
 		[tempType, serialized] = state.split(':');
 		if (tempType in serdes) {
-			type = tempType;
+			type = tempType as SerdeType;
 		} else {
 			throw new Error(`Unknown serde type: ${tempType}`);
 		}

src/lib/util/state.ts

@@ -1,9 +1,11 @@
 import { writable, get, derived } from 'svelte/store';
-import type { Readable } from 'svelte/store';
 import { persist, localStorage } from '@macfja/svelte-persistent-store';
-import type { State } from '$lib/types';
 import { saveStatistics } from './stats';
 import { serializeState, deserializeState } from './serde';
+import mermaid from 'mermaid';
+
+import type { Readable } from 'svelte/store';
+import type { MarkerData, State, ValidatedState } from '$lib/types';
 
 export const defaultState: State = {
 	code: `graph TD
@@ -36,9 +38,42 @@ const urlParseFailedState = `graph TD
     G --> |"No :("| H(Try using the Timeline tab in History <br/>from same browser you used to create the diagram.)
     click D href "https://github.com/mermaid-js/mermaid-live-editor/issues/new?assignees=&labels=bug&template=bug_report.md&title=Broken%20link" "Raise issue"`;
 
-export const codeStore = persist(writable(defaultState), localStorage(), 'codeStore');
-export const serializedState: Readable<string> = derived([codeStore], ([code], set) => {
-	set(serializeState(code));
+// inputStateStore handles all updates and is shared externally when exporting via URL, History, etc.
+export const inputStateStore = persist(writable(defaultState), localStorage(), 'codeStore');
+
+// All internal reads should be done via stateStore, but it should not be persisted/shared externally.
+export const stateStore: Readable<ValidatedState> = derived([inputStateStore], ([state]) => {
+	const processed: ValidatedState = {
+		...state,
+		serialized: '',
+		errorMarkers: [],
+		error: undefined
+	};
+	// No changes should be done to fields part of `state`.
+	try {
+		processed.serialized = serializeState(state);
+		mermaid.parse(state.code);
+		JSON.parse(state.mermaid);
+	} catch (e) {
+		processed.error = e;
+		console.error(e);
+		if (e.hash) {
+			try {
+				const marker: MarkerData = {
+					severity: 8, // Error
+					startLineNumber: e.hash.loc.first_line,
+					startColumn: e.hash.loc.first_column,
+					endLineNumber: e.hash.loc.last_line,
+					endColumn: (e.hash.loc.last_column as number) + 1,
+					message: e.str
+				};
+				processed.errorMarkers = [marker];
+			} catch (err) {
+				console.error('Error without line helper', err);
+			}
+		}
+	}
+	return processed;
 });
 
 export const loadState = (data: string): void => {
@@ -57,30 +92,33 @@ export const loadState = (data: string): void => {
 		) {
 			delete mermaidConfig.securityLevel; // Prevent setting overriding securityLevel when loading state to mitigate possible XSS attack
 		}
-
 		state.mermaid = JSON.stringify(mermaidConfig, null, 2);
 	} catch (e) {
-		state = get(codeStore);
+		state = get(inputStateStore);
 		if (data) {
 			console.error('Init error', e);
 			state.code = urlParseFailedState;
+			state.mermaid = defaultState.mermaid;
 		}
 	}
 	updateCodeStore({ ...state, updateEditor: true });
 };
 
 export const updateCodeStore = (newState: State): void => {
-	codeStore.update((state) => {
+	inputStateStore.update((state) => {
 		return { ...state, ...newState };
 	});
 };
 
 let prompted = false;
-export const updateCode = (code: string, updateEditor: boolean, updateDiagram = false): void => {
+export const updateCode = (
+	code: string,
+	{ updateEditor, updateDiagram = false }: { updateEditor: boolean; updateDiagram?: boolean }
+): void => {
 	saveStatistics(code);
 	const lines = (code.match(/\n/g) || '').length + 1;
 
-	if (lines > 50 && !prompted && get(codeStore).autoSync) {
+	if (lines > 50 && !prompted && get(stateStore).autoSync) {
 		const turnOff = confirm(
 			'Long diagram detected. Turn off Auto Sync? Click the sync logo to manually sync.'
 		);
@@ -92,19 +130,19 @@ export const updateCode = (code: string, updateEditor: boolean, updateDiagram =
 		}
 	}
 
-	codeStore.update((state) => {
+	inputStateStore.update((state) => {
 		return { ...state, code, updateEditor, updateDiagram };
 	});
 };
 
 export const updateConfig = (config: string, updateEditor: boolean): void => {
-	codeStore.update((state) => {
+	inputStateStore.update((state) => {
 		return { ...state, mermaid: config, updateEditor };
 	});
 };
 
 export const toggleDarkTheme = (dark: boolean): void => {
-	codeStore.update((state) => {
+	inputStateStore.update((state) => {
 		const config = JSON.parse(state.mermaid);
 		if (!config.theme || ['dark', 'default'].includes(config.theme)) {
 			config.theme = dark ? 'dark' : 'default';
@@ -115,11 +153,11 @@ export const toggleDarkTheme = (dark: boolean): void => {
 };
 
 export const initURLSubscription = (): void => {
-	serializedState.subscribe((state: string) => {
-		history.replaceState(undefined, undefined, `#${state}`);
+	stateStore.subscribe(({ serialized }) => {
+		history.replaceState(undefined, undefined, `#${serialized}`);
 	});
 };
 
 export const getStateString = (): string => {
-	return JSON.stringify(get(codeStore));
+	return JSON.stringify(get(inputStateStore));
 };

src/routes/edit.svelte

@@ -6,41 +6,86 @@
 	import View from '$lib/components/view.svelte';
 	import Card from '$lib/components/card/card.svelte';
 	import History from '$lib/components/history/history.svelte';
-	import { updateCode, updateConfig, codeStore, serializedState } from '$lib/util/state';
+	import { updateCode, updateConfig, inputStateStore, stateStore } from '$lib/util/state';
 	import { initHandler, syncDiagram } from '$lib/util/util';
-	import { errorStore } from '$lib/util/error';
 	import { onMount } from 'svelte';
-	import mermaid from 'mermaid';
-	import type monaco from 'monaco-editor';
-	import type { EditorUpdateEvent, State, Tab } from '$lib/types';
+	import type { EditorUpdateEvent, State, Tab, DocConfig } from '$lib/types';
 	import { base } from '$app/paths';
 
-	serializedState; // Weird fix for error > serializedState is not defined. Treeshaking?
-	let selectedMode = 'code';
-	const languageMap = {
+	type Modes = 'code' | 'config';
+	type Languages = 'mermaid' | 'json';
+
+	let selectedMode: Modes = 'code';
+	const languageMap: { [key in Modes]: Languages } = {
 		code: 'mermaid',
 		config: 'json'
 	};
+	const docURLBase = 'https://mermaid-js.github.io/mermaid';
+	const docMap: DocConfig = {
+		graph: {
+			code: '/#/flowchart',
+			config: '/#/flowchart?id=configuration'
+		},
+		flowchart: {
+			code: '/#/flowchart',
+			config: '/#/flowchart?id=configuration'
+		},
+		sequenceDiagram: {
+			code: '/#/sequenceDiagram',
+			config: '/#/sequenceDiagram?id=configuration'
+		},
+		classDiagram: {
+			code: '/#/classDiagram',
+			config: '/#/classDiagram?id=configuration'
+		},
+		'stateDiagram-v2': {
+			code: '/#/stateDiagram'
+		},
+		gantt: {
+			code: '/#/gantt',
+			config: '/#/gantt?id=configuration'
+		},
+		pie: {
+			code: '/#/pie'
+		},
+		erDiagram: {
+			code: '/#/entityRelationshipDiagram',
+			config: '/#/entityRelationshipDiagram?id=styling'
+		},
+		journey: {
+			code: '/#/user-journey'
+		},
+		gitGraph: {
+			code: '/#/gitgraph',
+			config: '/#/gitgraph?id=gitgraph-specific-configuration-options'
+		}
+	};
 	let text = '';
-	let language: 'mermaid' | 'json' = 'mermaid';
-	let errorMarkers: monaco.editor.IMarkerData[] = [];
+	let docURL = docURLBase;
+	let language: Languages = 'mermaid';
 	$: language = languageMap[selectedMode];
 	$: {
 		if (selectedMode === 'code') {
-			text = $codeStore.code;
+			text = $stateStore.code;
 		} else {
-			text = $codeStore.mermaid;
+			text = $stateStore.mermaid;
 		}
 	}
 
-	codeStore.subscribe((state: State) => {
+	stateStore.subscribe((state: State) => {
 		if (state.updateEditor) {
 			text = selectedMode === 'code' ? state.code : state.mermaid;
 		}
+		const codeTypeMatch = /([\S]+)[\s\n]/.exec(state.code);
+		if (codeTypeMatch && codeTypeMatch.length > 1) {
+			const docKey = codeTypeMatch[1];
+			const docConfig = docMap[docKey] ?? { code: '' };
+			docURL = docURLBase + (docConfig[selectedMode] ?? docConfig.code ?? '');
+		}
 	});
 	const tabSelectHandler = (message: CustomEvent<Tab>) => {
-		$codeStore.updateEditor = true;
-		selectedMode = message.detail.id;
+		selectedMode = message.detail.id === 'code' ? 'code' : 'config';
+		$inputStateStore.updateEditor = true;
 	};
 	const tabs: Tab[] = [
 		{
@@ -55,55 +100,26 @@
 		}
 	];
 
-	const handleCodeUpdate = (code: string): void => {
-		mermaid.parse(code);
-		updateCode(code, false);
-	};
-
-	const handleConfigUpdate = (config: string): void => {
-		JSON.parse(config);
-		updateConfig(config, false);
-	};
-
 	const updateHandler = (message: CustomEvent<EditorUpdateEvent>) => {
-		try {
-			if (selectedMode === 'code') {
-				handleCodeUpdate(message.detail.text);
-			} else {
-				handleConfigUpdate(message.detail.text);
-			}
-			errorStore.set(undefined);
-			errorMarkers = [];
-		} catch (e) {
-			errorStore.set(e);
-			if (e.hash) {
-				const marker: monaco.editor.IMarkerData = {
-					severity: 8, //Error
-					startLineNumber: e.hash.loc.first_line,
-					startColumn: e.hash.loc.first_column,
-					endLineNumber: e.hash.loc.last_line,
-					endColumn: (e.hash.loc.last_column as number) + 1,
-					message: e.str
-				};
-				errorMarkers.push(marker);
-				// Clear all previous errors before this error.
-				errorMarkers = errorMarkers.filter(
-					(m) => m.startLineNumber >= marker.startLineNumber && m.startColumn >= marker.startColumn
-				);
-			}
-			console.error(e);
+		const code = message.detail.text;
+		if (selectedMode === 'code') {
+			updateCode(code, {
+				updateEditor: false
+			});
+		} else {
+			updateConfig(code, false);
 		}
 	};
 
 	const viewDiagram = () => {
-		window.open(`${base}/view#${$serializedState}`, '_blank').focus();
+		window.open(`${base}/view#${$stateStore.serialized}`, '_blank').focus();
 	};
 
 	onMount(async () => {
 		await initHandler();
 		const resizer = document.getElementById('resizeHandler');
 		const element = document.getElementById('editorPane');
-		const resize = (e) => {
+		const resize = (e: { pageX: number }) => {
 			const newWidth = e.pageX - element.getBoundingClientRect().left;
 			if (newWidth > 50) {
 				element.style.width = `${newWidth}px`;
@@ -128,28 +144,32 @@
 			<Card on:select={tabSelectHandler} {tabs} isCloseable={false} title="Mermaid">
 				<div slot="actions">
 					<div class="flex flex-row items-center">
-						{#if !$codeStore.autoSync}
+						<div class="form-control flex-row items-center">
+							<label class="cursor-pointer label" for="autoSync">
+								<span> Auto sync</span>
+								<input
+									type="checkbox"
+									class="toggle {$stateStore.autoSync ? 'btn-secondary' : 'toggle-primary'} ml-1"
+									id="autoSync"
+									bind:checked={$inputStateStore.autoSync} />
+							</label>
+						</div>
+
+						{#if !$stateStore.autoSync}
 							<button
-								class="btn btn-secondary btn-xs"
+								class="btn btn-secondary btn-xs mr-1"
 								title="Sync Diagram"
 								data-cy="sync"
 								on:click={syncDiagram}><i class="fas fa-sync" /></button>
 						{/if}
 
-						<div class="form-control">
-							<label class="cursor-pointer label" for="autoSync">
-								<input
-									type="checkbox"
-									class="toggle toggle-primary mr-1"
-									id="autoSync"
-									bind:checked={$codeStore.autoSync} />
-								<span> Auto sync</span>
-							</label>
-						</div>
+						<button class="btn btn-secondary btn-xs" title="View documentation">
+							<a target="_blank" href={docURL} data-cy="docs"><i class="fas fa-book mr-1" />Docs</a>
+						</button>
 					</div>
 				</div>
 
-				<Editor on:update={updateHandler} {language} bind:text {errorMarkers} />
+				<Editor on:update={updateHandler} {language} bind:text />
 			</Card>
 
 			<div class="-mt-2">
@@ -163,9 +183,9 @@
 			<Card title="Diagram" isCloseable={false}>
 				<button
 					slot="actions"
-					class="btn btn-primary btn-xs shadow-lg"
+					class="btn btn-secondary btn-xs"
 					title="View diagram in new page"
-					on:click|stopPropagation={() => viewDiagram()}><i class="far fa-eye mr-2" /> View</button>
+					on:click|stopPropagation={() => viewDiagram()}><i class="far fa-eye mr-1" />View</button>
 
 				<div class="flex-1 overflow-auto">
 					<View />

src/tests/setup.ts

@@ -0,0 +1,4 @@
+import matchers from '@testing-library/jest-dom/matchers';
+import { expect } from 'vitest';
+
+expect.extend(matchers);

svelte.config.js

@@ -12,19 +12,16 @@ const config = {
 	],
 	kit: {
 		adapter: adapter({
-			pages: `docs${process.env['BETA'] ? '/beta' : ''}`
+			pages: `docs`
 		}),
 		paths: process.env['DEPLOY']
 			? {
-					base: `/mermaid-live-editor${process.env['BETA'] ? '/beta' : ''}`
+					base: `/mermaid-live-editor`
 			  }
 			: {},
-		// hydrate the <div id="svelte"> element in src/app.html
-		target: '#svelte',
 		trailingSlash: 'ignore',
-		vite: {
-			envPrefix: 'MERMAID_',
-			optimizeDeps: { include: ['mermaid'] }
+		prerender: {
+			default: true
 		}
 	}
 };

tsconfig.json

@@ -1,39 +1,16 @@
 {
-	"compilerOptions": {
-		"moduleResolution": "node",
-		"module": "es2020",
-		"lib": ["es2020", "ESNext", "DOM.Iterable", "DOM"],
-		"target": "es2019",
-		/**
-			svelte-preprocess cannot figure out whether you have a value or a type, so tell TypeScript
-			to enforce using \`import type\` instead of \`import\` for Types.
-			*/
-		"importsNotUsedAsValues": "error",
-		"isolatedModules": true,
-		"resolveJsonModule": true,
-		/**
-			To have warnings/errors of the Svelte compiler at the correct position,
-			enable source maps by default.
-			*/
-		"sourceMap": true,
-		"esModuleInterop": true,
-		"skipLibCheck": true,
-		"forceConsistentCasingInFileNames": true,
-		"baseUrl": ".",
-		"allowJs": true,
-		"checkJs": true,
-		"paths": {
-			"$lib/*": ["src/lib/*"]
-		}
-	},
 	"include": [
 		"src/**/*.d.ts",
-		"src/**/*.js",
 		"src/**/*.ts",
 		"src/**/*.svelte",
 		"cypress/**/*.ts",
 		"cypress/**/*.js",
-		"static/**/*.js",
-		"src/pako.mts"
-	]
+		"static/**/*.js"
+	],
+	"compilerOptions": {
+		"resolveJsonModule": true,
+		"allowSyntheticDefaultImports": true,
+		"types": ["vitest/importMeta"]
+	},
+	"extends": "./.svelte-kit/tsconfig.json"
 }

vite.config.js

@@ -0,0 +1,21 @@
+import { sveltekit } from '@sveltejs/kit/vite';
+/** @type {import('vite').UserConfig} */
+const config = {
+	plugins: [sveltekit()],
+	envPrefix: 'MERMAID_',
+	optimizeDeps: { include: ['mermaid'] },
+	ssr: {
+		noExternal: ['@macfja/svelte-persistent-store']
+	},
+	test: {
+		environment: 'jsdom',
+		// in-source testing
+		includeSource: ['src/**/*.{js,ts,svelte}'],
+		setupFiles: ['./src/tests/setup.ts'],
+		coverage: {
+			exclude: ['src/mocks', '.svelte-kit', 'src/**/*.test.ts'],
+			reporter: ['text', 'json', 'html', 'lcov']
+		}
+	}
+};
+export default config;