Compare commits

..
Author SHA1 Message Date
Yash-Singh1 4e5e2518fb feat: sample diagram and docs for gitgraph 2022-04-16 18:13:10 -07:00
71 changed files with 1822 additions and 3005 deletions
-8
View File
@@ -1,8 +0,0 @@
docs/**
.svelte-kit/**
static/**
build/**
node_modules/**
coverage/**
__snapshots__/**
snapshots.js
+4 -4
View File
@@ -7,11 +7,10 @@ module.exports = {
// 'plugin:@typescript-eslint/recommended-requiring-type-checking', // 'plugin:@typescript-eslint/recommended-requiring-type-checking',
'prettier' 'prettier'
], ],
plugins: ['svelte3', 'tailwindcss', '@typescript-eslint', 'es', 'vitest'], plugins: ['svelte3', 'tailwindcss', '@typescript-eslint', 'es'],
ignorePatterns: [ ignorePatterns: [
'docs/*', 'docs/*',
'*.cjs', '*.cjs',
'*.js',
'*.md', '*.md',
'snapshots.js', 'snapshots.js',
'svelte.config.js', 'svelte.config.js',
@@ -25,7 +24,7 @@ module.exports = {
}, },
parserOptions: { parserOptions: {
sourceType: 'module', sourceType: 'module',
ecmaVersion: 2020, ecmaVersion: 2019,
tsconfigRootDir: __dirname, tsconfigRootDir: __dirname,
project: ['./tsconfig.json'], project: ['./tsconfig.json'],
extraFileExtensions: ['.svelte'], extraFileExtensions: ['.svelte'],
@@ -33,7 +32,8 @@ module.exports = {
}, },
env: { env: {
browser: true, browser: true,
es2020: true es2017: true,
node: true
}, },
rules: { rules: {
'@typescript-eslint/ban-ts-comment': [ '@typescript-eslint/ban-ts-comment': [
+2 -2
View File
@@ -39,7 +39,7 @@ jobs:
# Initializes the CodeQL tools for scanning. # Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL - name: Initialize CodeQL
uses: github/codeql-action/init@v2 uses: github/codeql-action/init@v1
with: with:
config-file: ./.github/codeql/config.yml config-file: ./.github/codeql/config.yml
languages: ${{ matrix.language }} languages: ${{ matrix.language }}
@@ -65,4 +65,4 @@ jobs:
# make release # make release
- name: Perform CodeQL Analysis - name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2 uses: github/codeql-action/analyze@v1
@@ -1,4 +1,4 @@
name: Tests name: Cypress Tests
on: on:
pull_request: pull_request:
@@ -9,11 +9,8 @@ on:
jobs: jobs:
cypress-run: cypress-run:
runs-on: ubuntu-latest runs-on: ubuntu-latest
strategy: # Update after https://github.com/cypress-io/cypress-docker-images/issues/487
fail-fast: false container: cypress/browsers:node14.16.0-chrome90-ff88
matrix:
# run 3 copies of the current job in parallel
containers: [1, 2, 3]
steps: steps:
- name: Checkout - name: Checkout
@@ -30,21 +27,20 @@ jobs:
restore-keys: | restore-keys: |
${{ runner.os }}-node_modules-build- ${{ runner.os }}-node_modules-build-
- uses: actions/setup-node@v3 - name: Build & Lint
with: run: |
node-version: 16 yarn install
cache: 'yarn' yarn build
yarn lint
# Install NPM dependencies, cache them correctly # Install NPM dependencies, cache them correctly
# and run all Cypress tests # and run all Cypress tests
- name: Cypress run - name: Cypress run
uses: cypress-io/github-action@v3 uses: cypress-io/github-action@v2
with: with:
build: yarn build
start: yarn preview start: yarn preview
wait-on: 'http://localhost:3000' wait-on: 'http://localhost:3000'
record: true record: true
headless: true headless: true
parallel: true
env: env:
CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }} CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
+1
View File
@@ -21,6 +21,7 @@ jobs:
- name: Build & Deploy - name: Build & Deploy
run: | run: |
npm i -g yarn
export DEPLOY=true export DEPLOY=true
[ "$GITHUB_EVENT_NAME" != "pull_request" ] && rm -rf docs/_app/ [ "$GITHUB_EVENT_NAME" != "pull_request" ] && rm -rf docs/_app/
yarn install yarn install
+4 -4
View File
@@ -8,13 +8,13 @@ jobs:
stale: stale:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/stale@v5 - uses: actions/stale@v4
with: with:
repo-token: ${{ secrets.GITHUB_TOKEN }} repo-token: ${{ secrets.GITHUB_TOKEN }}
exempt-issue-labels: 'retained' exempt-issue-labels: 'retained'
exempt-pr-labels: 'retained' exempt-pr-labels: 'retained'
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 30 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 30 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-stale: 90
days-before-close: 30 days-before-close: 14
days-before-pr-close: -1 days-before-pr-close: -1
-36
View File
@@ -1,36 +0,0 @@
name: Unit Tests
on:
pull_request:
branches:
- master
- develop
jobs:
unit-tests:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- uses: actions/cache@v3
id: yarn-and-build-cache
with:
path: |
build
node_modules
key: ${{ runner.os }}-node_modules-build-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-node_modules-build-
- uses: actions/setup-node@v3
with:
node-version: 16
cache: 'yarn'
- name: Lint & Test
run: |
yarn install
yarn lint
yarn test:unit
-3
View File
@@ -1,9 +1,6 @@
name: Update Browserslist name: Update Browserslist
on: on:
workflow_dispatch: workflow_dispatch:
push:
branches:
- develop
jobs: jobs:
build: build:
+1 -7
View File
@@ -10,13 +10,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- uses: actions/setup-node@v2 - run: ./bin/update-monaco
with:
node-version: 18
- name: Update monaco version
run: |
yarn install
node ./bin/update-monaco.js
- name: Commit changes - name: Commit changes
uses: EndBug/add-and-commit@v9 uses: EndBug/add-and-commit@v9
with: with:
-1
View File
@@ -9,6 +9,5 @@ yarn-error.log
/build /build
/functions /functions
/snapshots.js /snapshots.js
/cypress/downloads
/cypress/videos /cypress/videos
/cypress/screenshots /cypress/screenshots
-2
View File
@@ -3,6 +3,4 @@ docs/**
static/** static/**
build/** build/**
node_modules/** node_modules/**
coverage/**
__snapshots__/**
snapshots.js snapshots.js
-15
View File
@@ -1,15 +0,0 @@
{
// 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}"
}
]
}
+1 -1
View File
@@ -6,7 +6,7 @@
# Stop : press ctrl + c # Stop : press ctrl + c
# or # or
# docker stop mermaid-live-editor # docker stop mermaid-live-editor
FROM node:18.8.0 as mermaid-live-editor-builder FROM node:17.8.0 as mermaid-live-editor-builder
COPY --chown=node:node . /home COPY --chown=node:node . /home
WORKDIR /home WORKDIR /home
RUN yarn install RUN yarn install
+1 -1
View File
@@ -1,4 +1,4 @@
FROM node:18 FROM node:17
WORKDIR /app WORKDIR /app
COPY package.json . COPY package.json .
COPY yarn.lock . COPY yarn.lock .
-13
View File
@@ -1,13 +0,0 @@
# 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.
+12
View File
@@ -0,0 +1,12 @@
#!/bin/bash
monacoVersion="$(jq -r '.dependencies."monaco-editor"' package.json)"
monacoVersion="${monacoVersion:1}"
if [[ $(uname) == "Darwin" ]];
then
sed -i '' -E "s/monaco-editor\/[^/]*/monaco-editor\/$monacoVersion/g" ./src/app.html
else
sed -i'' -E "s/monaco-editor\/[^/]*/monaco-editor\/$monacoVersion/g" ./src/app.html
fi
-45
View File
@@ -1,45 +0,0 @@
import fs from 'fs';
import path from 'path';
import { parse } from 'node-html-parser';
import prettier from 'prettier';
// parse monaco version out of package.json
const packageJson = JSON.parse(fs.readFileSync('package.json'));
const monacoVersion = packageJson.dependencies['monaco-editor'].replace('^', '');
// fetch monaco sri info from cdnjs api
const cdnjsAPIResp = await fetch(
`https://api.cdnjs.com/libraries/monaco-editor/${monacoVersion}?fields=sri`
);
if (cdnjsAPIResp.ok) {
const respJson = await cdnjsAPIResp.json();
const htmlPath = path.join('src', 'app.html');
const appHtml = fs
.readFileSync(htmlPath, 'utf8')
// update monaco version of every asset in app.html
.replaceAll(/[0-9.]+\/min\/vs/g, `${monacoVersion}/min/vs`);
const root = parse(appHtml);
const updateIntegrity = (tag, attr) => {
for (const node of root
.getElementsByTagName(tag)
.filter((node) => node.getAttribute(attr)?.includes('monaco-editor'))) {
const file = node.getAttribute(attr).split(`${monacoVersion}/`)[1];
node.setAttribute('integrity', respJson.sri[file]);
}
};
updateIntegrity('script', 'src');
updateIntegrity('link', 'href');
fs.writeFileSync(
htmlPath,
prettier.format(root.toString(), {
singleQuote: false,
parser: 'html',
bracketSameLine: true,
useTabs: true
})
);
} else {
throw Error('Unable to fetch monaco sri data from cdnjs api.');
}
-35
View File
@@ -1,35 +0,0 @@
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,
retries: {
runMode: 4,
openMode: 0
},
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/**/*.spec.ts'
}
});
+11
View File
@@ -0,0 +1,11 @@
{
"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
}
+6 -4
View File
@@ -1,10 +1,12 @@
{ {
"plugins": ["cypress"], "plugins": ["cypress", "mocha"],
"extends": ["plugin:cypress/recommended"], "extends": ["plugin:cypress/recommended", "plugin:mocha/recommended"],
"rules": { "rules": {
"jest/expect-expect": "off" "jest/expect-expect": "off",
"mocha/no-mocha-arrows": "off"
}, },
"env": { "env": {
"cypress/globals": true "cypress/globals": true,
"mocha": true
} }
} }
-49
View File
@@ -1,49 +0,0 @@
import { disableDebounce, verifyFileSize } from './util';
describe('Check actions', () => {
beforeEach(() => {
cy.clearLocalStorage();
cy.visit('/edit');
disableDebounce();
});
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', () => {
cy.clock(new Date(2022, 0, 1).getTime());
cy.get(`#downloadPNG`).click();
verifyFileSize('diagram', 'png', 21_000);
cy.get(`#downloadSVG`).click();
verifyFileSize('diagram', 'svg', 10_000);
// Verify downloaded file is different for different diagrams
cy.contains('Sample Diagrams').click();
cy.contains('ER Diagram').click();
cy.get(`#downloadPNG`).click();
verifyFileSize('diagram', 'png', 46_000);
cy.get(`#downloadSVG`).click();
verifyFileSize('diagram', 'svg', 12_000);
cy.clock().invoke('restore');
});
});
-84
View File
@@ -1,84 +0,0 @@
import { getEditor, cmd, disableDebounce } from './util';
describe('Auto sync tests', () => {
beforeEach(() => {
cy.clearLocalStorage();
cy.visit('/');
disableDebounce();
});
it('should dim diagram when code is edited', () => {
cy.contains('Auto sync').click();
cy.get('#view').should('not.have.class', 'outOfSync');
getEditor().type(' C --> Test');
cy.get('#view').should('have.class', 'outOfSync');
cy.getLocalStorage('codeStore').snapshot();
});
it('should update diagram when shortcut is used', () => {
cy.contains('Auto sync').click();
cy.get('#view').should('not.have.class', 'outOfSync');
getEditor().type(' C --> Test');
cy.get('#view').should('have.class', 'outOfSync');
getEditor().type(`${cmd}{enter}`);
cy.get('#view').should('not.have.class', 'outOfSync');
});
it('should show/hide sync button with auto sync', () => {
cy.get('[data-cy=sync]').should('not.exist');
cy.contains('Auto sync').click();
cy.get('[data-cy=sync]').should('exist');
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');
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();
getEditor().type('ing');
cy.get('#view').should('not.have.class', 'outOfSync');
cy.getLocalStorage('codeStore').snapshot();
});
it('supports commenting code out/in', () => {
getEditor().type(`{uparrow}${cmd}/`);
cy.get('#view').contains('Car').should('not.exist');
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');
});
});
describe.only('Pan and Zoom', () => {
beforeEach(() => {
cy.clearLocalStorage();
cy.visit('/');
disableDebounce();
});
it('should toggle pan and zoom', () => {
cy.get('#svg-pan-zoom-reset-pan-zoom').should('not.exist');
cy.contains('Pan & Zoom').click();
cy.get('#svg-pan-zoom-reset-pan-zoom').should('exist');
cy.contains('Pan & Zoom').click();
cy.get('#svg-pan-zoom-reset-pan-zoom').should('not.exist');
});
});
-105
View File
@@ -1,105 +0,0 @@
import { getEditor, disableDebounce, verifyFileSnapshot } from './util';
describe('Save History', () => {
beforeEach(() => {
cy.clock(new Date(2022, 0, 1).getTime());
cy.clearLocalStorage();
cy.visit('/edit');
disableDebounce();
cy.contains('Actions').click();
cy.contains('History').click();
});
afterEach(() => {
cy.clock().invoke('restore');
});
it('should load history from localstorage', () => {
cy.setLocalStorage(
'manualHistoryStore',
'[{"state":{"code":"graph TD\\n A[Halloween] -->|Get money| B(Go shopping)","mermaid":"{\\n \\"theme\\": \\"dark\\"\\n}","updateEditor":false,"autoSync":true,"updateDiagram":false},"time":0,"type":"manual","id":"d7ea820e-21dd-418a-b984-fd58acde09df","name":"hollow-art"},{"state":{"code":"graph TD\\n A[Christmas] -->|Get money| B(Go shopping)","mermaid":"{\\n \\"theme\\": \\"dark\\"\\n}","updateEditor":true,"autoSync":true,"updateDiagram":true},"time":0,"type":"manual","id":"b749ffc6-522b-4a44-86cf-7c1ffc3146b3","name":"helpful-ocean"}]'
);
cy.setLocalStorage(
'autoHistoryStore',
'[{"state":{"code":"graph TD\\n A[New Year] -->|Get money| B(Go shopping)","mermaid":"{\\n \\"theme\\": \\"dark\\"\\n}","updateEditor":false,"autoSync":true,"updateDiagram":false},"time":0,"type":"auto","id":"69ea820e-522b-4a44-86cf-fd58acde09df","name":"barking-dog"},{"state":{"code":"graph TD\\n A[Christmas] -->|Get money| B(Go shopping)","mermaid":"{\\n \\"theme\\": \\"dark\\"\\n}","updateEditor":true,"autoSync":true,"updateDiagram":true},"time":0,"type":"manual","id":"x749ffc6-21dd-418a-b984-7c1ffc3146b3","name":"needy-mosquito"}]'
);
cy.reload();
cy.contains('Actions').click();
cy.contains('History').click();
cy.get('#historyList').find('li').should('have.length', 2);
cy.get('#historyList').find('No items in History').should('not.exist');
cy.get('#historyList').contains('helpful-ocean');
cy.get('#historyList').contains('hollow-art');
cy.contains('Restore').click();
cy.contains('Halloween');
cy.contains('Timeline').click();
cy.get('#historyList').find('li').should('have.length', 2);
cy.get('#historyList').find('No items in History').should('not.exist');
cy.get('#historyList').contains('needy-mosquito');
cy.get('#historyList').contains('barking-dog');
cy.contains('Restore').click();
cy.contains('New Year');
});
it('should save when clicked', () => {
cy.get('#historyList').find('li').should('have.length', 0);
cy.get('#historyList').contains('No items in History');
cy.get('#saveHistory').click();
cy.get('#historyList').find('No items in History').should('not.exist');
cy.get('#historyList').find('li').should('have.length', 1);
cy.get('#saveHistory').click();
cy.on('window:alert', (str) => {
expect(str).to.equal('State already saved.');
});
cy.on('window:confirm', () => true);
getEditor().type(' C --> HistoryTest');
cy.get('#saveHistory').click();
cy.get('#historyList').find('li').should('have.length', 2);
});
it('should be able to restore and delete', () => {
cy.get('#saveHistory').click();
getEditor().type(' C --> HistoryTest');
cy.get('#historyList').find('No items in History').should('not.exist');
cy.get('#historyList').find('li').should('have.length', 1);
cy.contains('HistoryTest');
cy.contains('Restore').click();
cy.contains('HistoryTest').should('not.exist');
cy.contains('Delete').click();
cy.get('#historyList').find('li').should('have.length', 0);
cy.get('#historyList').contains('No items in History');
cy.get('#saveHistory').click();
getEditor().type(' C --> HistoryTest');
cy.get('#saveHistory').click();
cy.get('#editor').type('ing');
cy.get('#clearHistory').click();
cy.on('window:alert', (str) => {
expect(str).to.equal('Clear all saved items?');
});
cy.on('window:confirm', () => true);
cy.get('#historyList').contains('No items in History');
});
// TODO: Fix #639
xit('should auto save history', () => {
getEditor().type(' C --> HistoryTest');
cy.tick(70000);
cy.contains('Timeline').click();
cy.get('#historyList').find('li').should('have.length', 1);
cy.get('#editor').type('ing');
cy.tick(70000);
cy.get('#historyList').find('li').should('have.length', 2);
for (let i = 0; i < 31; i++) {
cy.get('#editor').type('.');
cy.tick(70000);
}
cy.get('#historyList').find('li').should('have.length', 30);
});
it('should download history', () => {
cy.get('#saveHistory').click();
cy.get(`#downloadHistory`).click();
verifyFileSnapshot('history', 'json', 'A[Christmas] -->|Get money| B(Go shopping)');
});
});
-43
View File
@@ -1,43 +0,0 @@
export const cmd = `{${Cypress.platform === 'darwin' ? 'meta' : 'ctrl'}}`;
export const getEditor = ({ bottom = true, newline = false } = {}) =>
cy
.get('#editor textarea:first')
.click()
.focused()
.type(`${bottom ? '{pageDown}' : cmd}`)
.type(`${newline ? '{enter}' : cmd}`);
export const disableDebounce = () => cy.setLocalStorage('noDebounce', 'true');
const downloadsFolder = Cypress.config('downloadsFolder');
export const verifyFileSize = (
fileType: 'history' | 'diagram',
extension: string,
size: number
) => {
const fileName = `mermaid-${fileType}-2022-01-01-000000.${extension}`;
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);
};
export const verifyFileSnapshot = (
fileType: 'history' | 'diagram',
extension: string,
content: string
) => {
const fileName = `mermaid-${fileType}-2022-01-01-000000.${extension}`;
const filePath = `${downloadsFolder}/${fileName}`;
cy.verifyDownload(fileName);
cy.readFile(filePath, null, {
log: false
}).then((buffer) =>
expect(new TextDecoder('utf-8').decode(buffer as ArrayBuffer)).to.contain(content)
);
cy.task('deleteFile', filePath);
};
+24
View File
@@ -0,0 +1,24 @@
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!!');
});
});
+43
View File
@@ -0,0 +1,43 @@
describe('Auto sync tests', () => {
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');
cy.get('#view').should('have.class', 'outOfSync');
cy.getLocalStorage('codeStore').snapshot();
});
it('should show/hide sync button with auto sync', () => {
cy.get('[data-cy=sync]').should('not.exist');
cy.contains('Auto sync').click();
cy.get('[data-cy=sync]').should('exist');
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');
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');
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}}/`);
cy.get('#view').contains('Car').should('not.exist');
cy.get('#editor').type(`{uparrow}{${cmd}}/`);
cy.get('#view').contains('Car').should('exist');
});
});
+65
View File
@@ -0,0 +1,65 @@
describe('Save History', () => {
beforeEach(() => {
cy.clock();
cy.clearLocalStorage();
cy.visit('/edit');
cy.contains('Actions').click();
cy.contains('History').click();
});
it('should save when clicked', () => {
cy.get('#historyList').find('li').should('have.length', 0);
cy.get('#historyList').contains('No items in History');
cy.get('#saveHistory').click();
cy.get('#historyList').find('No items in History').should('not.exist');
cy.get('#historyList').find('li').should('have.length', 1);
cy.get('#saveHistory').click();
cy.on('window:alert', (str) => {
expect(str).to.equal('State already saved.');
});
cy.on('window:confirm', () => true);
cy.get('#editor').type(' C --> HistoryTest');
cy.get('#saveHistory').click();
cy.get('#historyList').find('li').should('have.length', 2);
});
it('should be able to restore and delete', () => {
cy.get('#saveHistory').click();
cy.get('#editor').type(' C --> HistoryTest');
cy.get('#historyList').find('No items in History').should('not.exist');
cy.get('#historyList').find('li').should('have.length', 1);
cy.contains('HistoryTest');
cy.contains('Restore').click();
cy.contains('HistoryTest').should('not.exist');
cy.contains('Delete').click();
cy.get('#historyList').find('li').should('have.length', 0);
cy.get('#historyList').contains('No items in History');
cy.get('#saveHistory').click();
cy.get('#editor').type(' C --> HistoryTest');
cy.get('#saveHistory').click();
cy.get('#editor').type('ing');
cy.get('#clearHistory').click();
cy.on('window:alert', (str) => {
expect(str).to.equal('Clear all saved items?');
});
cy.on('window:confirm', () => true);
cy.get('#historyList').contains('No items in History');
});
// TODO: Fix #639
// eslint-disable-next-line mocha/no-skipped-tests
xit('should auto save history', () => {
cy.get('#editor').type(' C --> HistoryTest');
cy.tick(70000);
cy.contains('Timeline').click();
cy.get('#historyList').find('li').should('have.length', 1);
cy.get('#editor').type('ing');
cy.tick(70000);
cy.get('#historyList').find('li').should('have.length', 2);
for (let i = 0; i < 31; i++) {
cy.get('#editor').type('.');
cy.tick(70000);
}
cy.get('#historyList').find('li').should('have.length', 30);
});
});
@@ -1,13 +1,11 @@
import { toBase64 } from 'js-base64'; import { toBase64 } from 'js-base64';
import { disableDebounce } from './util';
describe('Site Loads', () => { describe('Site Loads', () => {
beforeEach(() => { beforeEach(() => {
cy.clearLocalStorage(); cy.clearLocalStorage();
cy.visit('/');
disableDebounce();
}); });
it('Check Home page load', () => { it('Check Home page load', () => {
cy.visit('/');
cy.url().should('include', '/edit'); cy.url().should('include', '/edit');
cy.contains('History').click(); cy.contains('History').click();
cy.getLocalStorage('codeStore').snapshot(); cy.getLocalStorage('codeStore').snapshot();
@@ -17,7 +15,12 @@ describe('Site Loads', () => {
cy.visit( cy.visit(
'/#/edit/eyJjb2RlIjoiZ3JhcGggVERcbiAgICBBW0NocmlzdG1hc10gLS0-fEdldCBtb25leXwgQihHbyBzaG9wcGluZylcbiAgICBCIC0tPiBDe0xldCBtZSB0aGlua31cbiAgICBDIC0tPnxPbmV8IERbTGFwdG9wXVxuICAgIEMgLS0-fFR3b3wgRVtpUGhvbmVdXG4gICAgQyAtLT58VGhyZWV8IEZbZmE6ZmEtY2FyIENhcl0iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9LCJ1cGRhdGVFZGl0b3IiOmZhbHNlfQ' '/#/edit/eyJjb2RlIjoiZ3JhcGggVERcbiAgICBBW0NocmlzdG1hc10gLS0-fEdldCBtb25leXwgQihHbyBzaG9wcGluZylcbiAgICBCIC0tPiBDe0xldCBtZSB0aGlua31cbiAgICBDIC0tPnxPbmV8IERbTGFwdG9wXVxuICAgIEMgLS0-fFR3b3wgRVtpUGhvbmVdXG4gICAgQyAtLT58VGhyZWV8IEZbZmE6ZmEtY2FyIENhcl0iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9LCJ1cGRhdGVFZGl0b3IiOmZhbHNlfQ'
); );
cy.url().should('include', '/edit#pako:eNp'); cy.url().should(
'include',
'/edit#pako:eNpVkM1qw0AMhF9F6NRC_AI-FBo7zSXQQHLz-iC8cnZJ9oe1TAm2373rmkKrk9B8MwyasAuascRbomjgWisPed6byiQ7iKOhhaJ4m48s4ILn5wz7l2OAwYQYrb-9bvx-haCaTivGIMb6-7JJ1Y__0_MMdXOiKCG2f5XrV5jh0NizyfH_FZM4uz6ansqeio4SVJRa3KHj5MjqXHtaDQrFsGOFZV419zQ-RKHyS0bHqEn4oK2EhDnmMfAOaZRwefoOS0kj_0K1pfwFtx2XbzAdW4g'
);
cy.contains('History').click();
cy.getLocalStorage('codeStore').snapshot();
}); });
it('should load sample diagrams when clicked', () => { it('should load sample diagrams when clicked', () => {
@@ -75,7 +78,7 @@ describe('Site Loads', () => {
it('should allow persisting "securityLevel" using confirm dialogue', () => { it('should allow persisting "securityLevel" using confirm dialogue', () => {
const b64State = toBase64( const b64State = toBase64(
`{"code":"graph TD\\nA[\\"<img src='https://dummyimage.com/64' width=64/>\\"]","mermaid":"{\\"securityLevel\\": \\"loose\\", \\"theme\\": \\"forest\\"}","updateEditor":true,"autoSync":true,"updateDiagram":true}`, `{"code":"graph TD\\nA[\\"<img src='https://via.placeholder.com/64' width=64/>\\"]","mermaid":"{\\"securityLevel\\": \\"loose\\", \\"theme\\": \\"forest\\"}","updateEditor":true,"autoSync":true,"updateDiagram":true}`,
true true
); );
cy.on('window:confirm', () => false); cy.on('window:confirm', () => false);
@@ -88,7 +91,6 @@ describe('Site Loads', () => {
it('should show troubleshooting steps if loading fails', () => { it('should show troubleshooting steps if loading fails', () => {
cy.visit('/#/edit/eyJjb2RlIjoiZ3JhcGggVERcbiAg'); cy.visit('/#/edit/eyJjb2RlIjoiZ3JhcGggVERcbiAg');
cy.reload(true);
cy.contains('Please Click here to Raise an issue in github.'); cy.contains('Please Click here to Raise an issue in github.');
}); });
@@ -115,6 +117,7 @@ describe('Site Loads', () => {
cy.visit( cy.visit(
'/edit#pako:eNptkU1PwzAMhv9K5BOI9Q9EXBDbJA477YYqITcxndV8QD40weh_Jy1rGR0-OY_tV2_sEyivCSQogzGuGduAtnaixINji0bcf1WVWGfVXdMtx8M1faYm4B8sxR27JLClJd6nwK4VLTlN4bI4jMQd2pLe3C4KFhNNcLQ92jv9ADGLNoTdozc-zIV4ZDsNlud7RtVN7_5Sb_jYrFcN3iN_0pPbEqUZK3QbTP_Ojyv4NdR4bwTHlyMbPcOQ3WJ2CliBpWCRdbnLqFJDOpClGmRJNYauhtr1pS-_6bKMjebkA8hXNJFWgDn5_YdTIFPINDWdb3vu6r8BaWOZRQ' '/edit#pako:eNptkU1PwzAMhv9K5BOI9Q9EXBDbJA477YYqITcxndV8QD40weh_Jy1rGR0-OY_tV2_sEyivCSQogzGuGduAtnaixINji0bcf1WVWGfVXdMtx8M1faYm4B8sxR27JLClJd6nwK4VLTlN4bI4jMQd2pLe3C4KFhNNcLQ92jv9ADGLNoTdozc-zIV4ZDsNlud7RtVN7_5Sb_jYrFcN3iN_0pPbEqUZK3QbTP_Ojyv4NdR4bwTHlyMbPcOQ3WJ2CliBpWCRdbnLqFJDOpClGmRJNYauhtr1pS-_6bKMjebkA8hXNJFWgDn5_YdTIFPINDWdb3vu6r8BaWOZRQ'
); );
cy.reload();
cy.contains('Animal'); cy.contains('Animal');
}); });
}); });
@@ -32,6 +32,7 @@ describe('Test themes', () => {
}); });
describe('Test dark mode', () => { describe('Test dark mode', () => {
// eslint-disable-next-line mocha/no-hooks-for-single-case
beforeEach(() => { beforeEach(() => {
cy.clearLocalStorage(); cy.clearLocalStorage();
cy.visit('/edit', { cy.visit('/edit', {
+31
View File
@@ -0,0 +1,31 @@
/// <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;
}
});
};
+1 -1
View File
@@ -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\"}}}" "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": "10.6.0", "__version": "9.5.1",
"Auto sync tests": { "Auto sync tests": {
"should dim diagram when code is edited": { "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}" "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}"
@@ -15,7 +15,6 @@
// Import commands.js using ES2015 syntax: // Import commands.js using ES2015 syntax:
import './commands'; import './commands';
require('cy-verify-downloads').addCustomCommand();
// Alternatively you can use CommonJS syntax: // Alternatively you can use CommonJS syntax:
// require('./commands') // require('./commands')
+1 -1
View File
@@ -1,7 +1,7 @@
{ {
"compilerOptions": { "compilerOptions": {
"allowJs": true, "allowJs": true,
"types": ["cypress", "cypress-localstorage-commands", "cy-verify-downloads"] "types": ["cypress", "cypress-localstorage-commands"]
}, },
"include": ["**/*.ts"] "include": ["**/*.ts"]
} }
+55 -74
View File
@@ -1,83 +1,66 @@
{ {
"name": "mermaid-live-editor", "name": "mermaid-live-editor",
"version": "2.0.67", "version": "2.0.67",
"type": "module",
"license": "MIT",
"scripts": { "scripts": {
"dev": "vite dev", "dev": "svelte-kit dev --host 0.0.0.0",
"build": "vite build", "build": "svelte-kit build",
"preview": "vite preview", "preview": "svelte-kit preview",
"lint": "prettier --check --cache --plugin-search-dir=. .;eslint --ignore-path .gitignore .", "lint": "prettier --check --plugin-search-dir=. .;eslint --ignore-path .gitignore .",
"lint:fix": "prettier --write --cache --plugin-search-dir=. .;eslint --fix --ignore-path .gitignore .", "lint:fix": "prettier --write --plugin-search-dir=. .;eslint --fix --ignore-path .gitignore .",
"format": "prettier --write --cache --plugin-search-dir=. .", "format": "prettier --write --plugin-search-dir=. .",
"pre-commit": "lint-staged", "pre-commit": "lint-staged",
"postinstall": "husky install; svelte-kit sync", "postinstall": "husky install",
"test:unit": "vitest", "test": "cypress run",
"test:ui": "vitest --ui",
"test:coverage": "vitest run --coverage",
"test:browser": "cypress run",
"test": "test:unit && test:browser",
"cy": "cypress open" "cy": "cypress open"
}, },
"devDependencies": { "devDependencies": {
"@cypress/snapshot": "2.1.7", "@cypress/snapshot": "^2.1.7",
"@sveltejs/adapter-static": "1.0.0-next.39", "@sveltejs/adapter-static": "1.0.0-next.29",
"@sveltejs/kit": "1.0.0-next.442", "@sveltejs/kit": "1.0.0-next.310",
"@testing-library/jest-dom": "5.16.5", "@types/mermaid": "^8.2.9",
"@testing-library/svelte": "3.2.1", "@types/pako": "^1.0.3",
"@types/mermaid": "8.2.9", "@typescript-eslint/eslint-plugin": "^4.33.0",
"@types/pako": "1.0.3", "@typescript-eslint/parser": "^4.33.0",
"@types/uuid": "^8.3.4", "autoprefixer": "^10.4.4",
"@typescript-eslint/eslint-plugin": "5.35.1", "chai": "^4.3.6",
"@typescript-eslint/parser": "5.34.0", "cssnano": "^5.1.7",
"@vitest/ui": "0.22.1", "cypress": "9.5.3",
"autoprefixer": "10.4.8", "cypress-localstorage-commands": "^1.7.0",
"c8": "7.12.0", "eslint": "^7.32.0",
"chai": "4.3.6", "eslint-config-prettier": "^8.5.0",
"cssnano": "5.1.13", "eslint-plugin-cypress": "^2.12.1",
"cy-verify-downloads": "0.1.8", "eslint-plugin-es": "^4.1.0",
"cypress": "10.6.0", "eslint-plugin-mocha": "^10.0.3",
"cypress-localstorage-commands": "2.2.0", "eslint-plugin-postcss-modules": "^2.0.0",
"eslint": "8.22.0", "eslint-plugin-svelte3": "^3.4.1",
"eslint-config-prettier": "8.5.0", "eslint-plugin-tailwindcss": "^3.5.0",
"eslint-plugin-cypress": "2.12.1", "husky": "^7.0.4",
"eslint-plugin-es": "4.1.0", "lint-staged": "^12.3.7",
"eslint-plugin-postcss-modules": "2.0.0", "mocha": "^9.2.2",
"eslint-plugin-svelte3": "4.0.0", "node-html-parser": "^5.3.3",
"eslint-plugin-tailwindcss": "3.6.0", "postcss": "^8.4.12",
"eslint-plugin-vitest": "0.0.8", "postcss-load-config": "^3.1.4",
"husky": "8.0.1", "prettier": "~2.6.2",
"jsdom": "20.0.0", "prettier-plugin-svelte": "^2.7.0",
"lint-staged": "13.0.3", "svelte": "^3.47.0",
"node-html-parser": "5.4.1", "svelte-preprocess": "^4.10.5",
"postcss": "8.4.16", "tailwindcss": "^3.0.21",
"postcss-load-config": "4.0.1", "tslib": "^2.3.1",
"prettier": "2.7.1", "typescript": "^4.6.3"
"prettier-plugin-svelte": "2.7.0",
"svelte": "3.49.0",
"svelte-preprocess": "4.10.7",
"tailwindcss": "3.1.8",
"tslib": "2.4.0",
"typescript": "4.8.2",
"vite": "3.0.9",
"vitest": "0.22.1",
"vitest-svelte-kit": "0.0.7"
}, },
"type": "module",
"dependencies": { "dependencies": {
"@analytics/google-analytics": "1.0.3", "@analytics/google-analytics": "^0.5.3",
"@macfja/svelte-persistent-store": "2.0.0", "@macfja/svelte-persistent-store": "^1.3.0",
"analytics": "0.8.1", "analytics": "^0.8.1",
"analytics-plugin-plausible": "^0.0.6", "daisyui": "2.13.6",
"daisyui": "2.24.0", "js-base64": "^3.7.2",
"js-base64": "3.7.2", "mermaid": "9.0.0",
"mermaid": "9.1.6", "moment": "^2.29.2",
"moment": "2.29.4", "monaco-editor": "^0.33.0",
"monaco-editor": "0.34.0", "monaco-mermaid": "^1.0.3",
"monaco-mermaid": "1.0.6",
"pako": "2.0.4", "pako": "2.0.4",
"random-word-slugs": "0.1.6", "random-word-slugs": "^0.1.6"
"svg-pan-zoom": "^3.6.1",
"uuid": "^8.3.2"
}, },
"lint-staged": { "lint-staged": {
"*.{ts,svelte,js,css,md,json}": [ "*.{ts,svelte,js,css,md,json}": [
@@ -86,10 +69,8 @@
] ]
}, },
"volta": { "volta": {
"node": "18.5.0", "node": "14.16.1",
"yarn": "1.22.10" "yarn": "1.22.10",
}, "npm": "7.11.2"
"engines": {
"node": ">=16.7"
} }
} }
View File
+11 -19
View File
@@ -11,45 +11,37 @@
<meta <meta
name="description" 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." /> 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="%sveltekit.assets%/favicon.png" /> <link rel="icon" type="image/png" href="%svelte.assets%/favicon.png" />
<link rel="manifest" href="%sveltekit.assets%/manifest.json" /> <link rel="manifest" href="%svelte.assets%/manifest.json" />
<link <link
rel="stylesheet" rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.2/css/all.min.css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.2/css/all.min.css" />
integrity="sha512-HK5fgLBL+xu6dm/Ii3z4xhlSUyZgTT9tuc/hSrtw6uzJOvgRr2a9jyxxT1ely+B+xFAmJKVSTbpM/CuL7qxO8w=="
crossorigin="anonymous"
referrerpolicy="no-referrer" />
<link <link
rel="stylesheet" rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.34.0/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"
integrity="sha512-iQEIc0rsSDujsfjtD+lfyJ1W23Bh/lbgriubKDAym6VlEIDRj9rrbSIyJRyshOrl8s0yRcQ0+gyrZfSLyjJGWQ=="
crossorigin="anonymous" crossorigin="anonymous"
referrerpolicy="no-referrer" /> referrerpolicy="no-referrer" />
<script> <script>
var require = { var require = {
paths: { paths: { vs: 'https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.33.0/min/vs' }
vs: "https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.34.0/min/vs",
},
}; };
</script> </script>
<script <script
src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.34.0/min/vs/loader.min.js" src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.33.0/min/vs/loader.min.js"
integrity="sha512-6bIYsGqvLpAiEBXPdRQeFf5cueeBECtAKJjIHer3BhBZNTV3WLcLA8Tm3pDfxUwTMIS+kAZwTUvJ1IrMdX8C5w=="
crossorigin="anonymous" crossorigin="anonymous"
referrerpolicy="no-referrer"></script> referrerpolicy="no-referrer"></script>
<script <script
src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.34.0/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"
integrity="sha512-CCv+DKWw+yZhxf4Z+ExT6HC5G+3S45TeMTYcJyYbdrv4BpK2vyALJ4FoVR/KGWDIPu7w4tNCOC9MJQIkYPR5FA=="
crossorigin="anonymous" crossorigin="anonymous"
referrerpolicy="no-referrer"></script> referrerpolicy="no-referrer"></script>
<script <script
src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.34.0/min/vs/editor/editor.main.js" src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.33.0/min/vs/editor/editor.main.js"
integrity="sha512-TTPQbVI87mnVMV+1KbkKJ8vdQ4QqqbKyuTtJ9wQD8CqnwQLSQgXH7MWOQ88VO7pRzxWhqI1vYDeEV651sAH4ig=="
crossorigin="anonymous" crossorigin="anonymous"
referrerpolicy="no-referrer"></script> referrerpolicy="no-referrer"></script>
%sveltekit.head%
%svelte.head%
</head> </head>
<body> <body>
<div id="svelte">%sveltekit.body%</div> <div id="svelte">%svelte.body%</div>
</body> </body>
</html> </html>
-14
View File
@@ -1,15 +1 @@
/* eslint-disable @typescript-eslint/no-empty-interface */
/* eslint-disable @typescript-eslint/ban-types */
/* eslint-disable @typescript-eslint/no-unused-vars */
/// <reference types="@sveltejs/kit" /> /// <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> {}
}
}
+1 -1
View File
@@ -1,4 +1,4 @@
import type { Handle } from '@sveltejs/kit'; import type { Handle } from '@sveltejs/kit/types/hooks';
export const handle: Handle = async ({ event, resolve }) => { export const handle: Handle = async ({ event, resolve }) => {
const response = await resolve(event, { const response = await resolve(event, {
+27 -61
View File
@@ -1,23 +1,20 @@
<script lang="ts"> <script lang="ts">
import { browser } from '$app/env'; import { browser } from '$app/env';
import Card from '$lib/components/card/card.svelte'; import Card from '$lib/components/card/card.svelte';
import { krokiRendererUrl, rendererUrl } from '$lib/util/env'; import { krokiRendererUrl, rendererUrl } from '$lib/util/env';
import { pakoSerde } from '$lib/util/serde'; import { pakoSerde } from '$lib/util/serde';
import { stateStore } from '$lib/util/state'; import { serializedState, codeStore } from '$lib/util/state';
import { logEvent } from '$lib/util/stats';
import { toBase64 } from 'js-base64'; import { toBase64 } from 'js-base64';
import moment from 'moment'; import moment from 'moment';
type Exporter = (context: CanvasRenderingContext2D, image: HTMLImageElement) => () => void; 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 => { const getBase64SVG = (svg?: HTMLElement, width?: number, height?: number): string => {
svg?.setAttribute('height', `${height}px`); 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 svg?.setAttribute('width', `${width}px`); // Workaround https://stackoverflow.com/questions/28690643/firefox-error-rendering-an-svg-image-to-html5-canvas-with-drawimage
if (!svg) { if (!svg) {
svg = getSvgEl(); svg = document.querySelector('#container svg');
} }
const svgString = svg.outerHTML const svgString = svg.outerHTML
.replaceAll('<br>', '<br/>') .replaceAll('<br>', '<br/>')
@@ -53,23 +50,6 @@
event.preventDefault(); 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 simulateDownload = (download: string, href: string): void => {
const a = document.createElement('a'); const a = document.createElement('a');
a.download = download; a.download = download;
@@ -82,7 +62,7 @@
const { canvas } = context; const { canvas } = context;
context.drawImage(image, 0, 0, canvas.width, canvas.height); context.drawImage(image, 0, 0, canvas.width, canvas.height);
simulateDownload( simulateDownload(
getFileName('png'), `mermaid-diagram-${moment().format('YYYYMMDDHHmmss')}.png`,
canvas.toDataURL('image/png').replace('image/png', 'image/octet-stream') canvas.toDataURL('image/png').replace('image/png', 'image/octet-stream')
); );
}; };
@@ -115,34 +95,29 @@
const onCopyClipboard = (event: Event) => { const onCopyClipboard = (event: Event) => {
exportImage(event, clipboardCopy); exportImage(event, clipboardCopy);
void logEvent('copyClipboard');
}; };
const onDownloadPNG = (event: Event) => { const onDownloadPNG = (event: Event) => {
exportImage(event, downloadImage); exportImage(event, downloadImage);
void logEvent('download', {
type: 'png'
});
}; };
const onDownloadSVG = () => { const onDownloadSVG = () => {
simulateDownload(getFileName('svg'), `data:image/svg+xml;base64,${getBase64SVG()}`); simulateDownload(
void logEvent('download', { `mermaid-diagram-${moment().format('YYYYMMDDHHmmss')}.svg`,
type: 'svg' `data:image/svg+xml;base64,${getBase64SVG()}`
}); );
}; };
const onCopyMarkdown = () => { const onCopyMarkdown = () => {
(document.getElementById('markdown') as HTMLInputElement).select(); (document.getElementById('markdown') as HTMLInputElement).select();
document.execCommand('Copy'); document.execCommand('Copy');
void logEvent('copyMarkdown');
}; };
let gistURL = ''; let gistURL = '';
stateStore.subscribe(({ loader }) => { codeStore.subscribe((state) => {
if (loader?.type === 'gist') { if (state.loader?.type === 'gist') {
// @ts-ignore Gist will have url // @ts-ignore Gist will have url
gistURL = loader.config.url; gistURL = state.loader.config.url;
} }
}); });
@@ -151,7 +126,6 @@
alert('Please enter a Gist URL first'); alert('Please enter a Gist URL first');
} }
window.location.href = `${window.location.pathname}?gist=${gistURL}`; window.location.href = `${window.location.pathname}?gist=${gistURL}`;
void logEvent('loadGist');
}; };
let iUrl: string; let iUrl: string;
@@ -165,11 +139,11 @@
if (browser && ['mermaid.live', 'netlify'].some((path) => window.location.host.includes(path))) { if (browser && ['mermaid.live', 'netlify'].some((path) => window.location.host.includes(path))) {
isNetlify = true; isNetlify = true;
} }
stateStore.subscribe(({ code, serialized }) => { serializedState.subscribe((encodedState: string) => {
iUrl = `${rendererUrl}/img/${serialized}`; iUrl = `${rendererUrl}/img/${encodedState}`;
svgUrl = `${rendererUrl}/svg/${serialized}`; svgUrl = `${rendererUrl}/svg/${encodedState}`;
krokiUrl = `${krokiRendererUrl}/mermaid/svg/${pakoSerde.serialize(code)}`; krokiUrl = `${krokiRendererUrl}/mermaid/svg/${pakoSerde.serialize($codeStore.code)}`;
mdCode = `[![](${iUrl})](${window.location.protocol}//${window.location.host}${window.location.pathname}#${serialized})`; mdCode = `[![](${iUrl})](${window.location.protocol}//${window.location.host}${window.location.pathname}#${encodedState})`;
}); });
</script> </script>
@@ -180,29 +154,21 @@
><i class="far fa-copy mr-2" /> Copy Image to clipboard ><i class="far fa-copy mr-2" /> Copy Image to clipboard
</button> </button>
{/if} {/if}
<button id="downloadPNG" class="action-btn flex-auto" on:click={onDownloadPNG}> <button class="action-btn flex-auto" on:click={onDownloadPNG}>
<i class="fas fa-download mr-2" /> PNG <i class="fas fa-download mr-2" /> PNG
</button> </button>
<button id="downloadSVG" class="action-btn flex-auto" on:click={onDownloadSVG}> <button class="action-btn flex-auto" on:click={onDownloadSVG}>
<i class="fas fa-download mr-2" /> SVG <i class="fas fa-download mr-2" /> SVG
</button> </button>
<a target="_blank" href={iUrl}> <button class="action-btn flex-auto">
<button class="action-btn flex-auto"> <a target="_blank" href={iUrl}><i class="fas fa-external-link-alt mr-2" /> PNG</a>
<i class="fas fa-external-link-alt mr-2" /> PNG </button>
</button> <button class="action-btn flex-auto">
</a> <a target="_blank" href={svgUrl}><i class="fas fa-external-link-alt mr-2" /> SVG</a>
</button>
<a target="_blank" href={svgUrl}> <button class="action-btn flex-auto">
<button class="action-btn flex-auto"> <a target="_blank" href={krokiUrl}><i class="fas fa-external-link-alt mr-2" /> Kroki</a>
<i class="fas fa-external-link-alt mr-2" /> SVG </button>
</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"> <div class="flex gap-2 items-center">
PNG size PNG size
@@ -1,3 +0,0 @@
// 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>"`;
-24
View File
@@ -1,24 +0,0 @@
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();
});
});
+11 -26
View File
@@ -1,12 +1,10 @@
<script lang="ts"> <script lang="ts">
import type { EditorEvents } from '$lib/types'; import type { EditorEvents } from '$lib/types';
import { stateStore } from '$lib/util/state'; import { codeStore } from '$lib/util/state';
import { themeStore } from '$lib/util/theme'; import { themeStore } from '$lib/util/theme';
import { syncDiagram } from '$lib/util/util';
import type monaco from 'monaco-editor'; import type monaco from 'monaco-editor';
import { createEventDispatcher, onMount } from 'svelte'; import { createEventDispatcher, onMount } from 'svelte';
import initEditor from 'monaco-mermaid'; import initEditor from 'monaco-mermaid';
import { logEvent } from '$lib/util/stats';
let divEl: HTMLDivElement = null; let divEl: HTMLDivElement = null;
let editor: monaco.editor.IStandaloneCodeEditor; let editor: monaco.editor.IStandaloneCodeEditor;
@@ -23,20 +21,18 @@
theme: 'mermaid', theme: 'mermaid',
overviewRulerLanes: 0 overviewRulerLanes: 0
}; };
export let errorMarkers: monaco.editor.IMarkerData[] = [];
let oldText = text; let oldText = text;
$: editor && Monaco?.editor.setModelLanguage(editor.getModel(), language); $: editor && Monaco?.editor.setModelLanguage(editor.getModel(), language);
$: {
const handleTextUpdate = (newText: string) => { if (text !== oldText) {
if (newText !== oldText) { if ($codeStore.updateEditor) {
if ($stateStore.updateEditor) { editor?.setValue(text);
editor?.setValue(newText);
} }
oldText = newText; oldText = text;
} }
editor && Monaco?.editor.setModelMarkers(editor.getModel(), 'test', $stateStore.errorMarkers); editor && Monaco?.editor.setModelMarkers(editor.getModel(), 'test', errorMarkers);
}; }
$: handleTextUpdate(text);
themeStore.subscribe(({ isDark }) => { themeStore.subscribe(({ isDark }) => {
editor && Monaco?.editor.setTheme(isDark ? 'mermaid-dark' : 'mermaid'); editor && Monaco?.editor.setTheme(isDark ? 'mermaid-dark' : 'mermaid');
@@ -66,22 +62,11 @@
initEditor(Monaco); initEditor(Monaco);
editor = Monaco.editor.create(divEl, editorOptions); editor = Monaco.editor.create(divEl, editorOptions);
editor.onDidChangeModelContent(() => { editor.onDidChangeModelContent(() => {
oldText = editor.getValue(); text = editor.getValue();
dispatch('update', { dispatch('update', {
text: oldText text
}); });
}); });
editor.addAction({
id: 'mermaid-render-diagram',
label: 'Render Diagram',
keybindings: [Monaco.KeyMod.CtrlCmd | Monaco.KeyCode.Enter],
run: function () {
syncDiagram();
void logEvent('renderDiagram', {
method: 'keyboadShortcut'
});
}
});
Monaco?.editor.setTheme($themeStore.isDark ? 'mermaid-dark' : 'mermaid'); Monaco?.editor.setTheme($themeStore.isDark ? 'mermaid-dark' : 'mermaid');
const resizeObserver = new ResizeObserver((entries) => { const resizeObserver = new ResizeObserver((entries) => {
editor.layout({ editor.layout({
+11 -60
View File
@@ -1,21 +1,18 @@
<script lang="ts"> <script lang="ts">
import Card from '$lib/components/card/card.svelte'; import Card from '$lib/components/card/card.svelte';
import { inputStateStore, getStateString } from '$lib/util/state'; import { codeStore, getStateString } from '$lib/util/state';
import { import {
addHistoryEntry, addHistoryEntry,
historyModeStore, historyModeStore,
clearHistoryData, clearHistoryData,
getPreviousState, getPreviousState,
historyStore, historyStore,
loaderHistoryStore, loaderHistoryStore
restoreHistory
} from './history'; } from './history';
import { notify, prompt } from '$lib/util/notify'; import { notify, prompt } from '$lib/util/notify';
import { onMount } from 'svelte'; import { onMount } from 'svelte';
import { get } from 'svelte/store';
import moment from 'moment'; import moment from 'moment';
import type { HistoryType, State, Tab } from '$lib/types'; import type { HistoryType, State, Tab } from '$lib/types';
import { logEvent } from '$lib/util/stats';
const HISTORY_SAVE_INTERVAL = 60000; const HISTORY_SAVE_INTERVAL = 60000;
@@ -35,45 +32,12 @@
} }
]; ];
const downloadHistory = () => {
const data = get(historyStore);
const blob = new Blob([JSON.stringify(data)], { type: 'application/json' });
const url = URL.createObjectURL(blob);
const a = document.createElement('a');
a.href = url;
a.download = `mermaid-history-${moment().format('YYYY-MM-DD-HHmmss')}.json`;
a.click();
URL.revokeObjectURL(url);
logEvent('history', {
action: 'download'
});
};
const uploadHistory = () => {
const input = document.createElement('input');
input.type = 'file';
input.accept = 'application/json';
input.addEventListener('change', ({ target }: Event) => {
const file = (<HTMLInputElement>target).files[0];
if (!file) {
return;
}
const reader = new FileReader();
reader.onload = (e) => {
const data = JSON.parse(e.target.result as string);
restoreHistory(data);
};
reader.readAsText(file);
});
input.click();
};
const saveHistory = (auto = false) => { const saveHistory = (auto = false) => {
const currentState: string = getStateString(); const currentState: string = getStateString();
const previousState: string = getPreviousState(auto); const previousState: string = getPreviousState(auto);
if (previousState !== currentState) { if (previousState !== currentState) {
addHistoryEntry({ addHistoryEntry({
state: $inputStateStore, state: $codeStore,
time: Date.now(), time: Date.now(),
type: auto ? 'auto' : 'manual' type: auto ? 'auto' : 'manual'
}); });
@@ -82,15 +46,15 @@
} }
}; };
const clearHistory = (id?: string): void => { const clearHistory = (date?: number): void => {
if (!id && !prompt('Clear all saved items?')) { if (!date && !prompt('Clear all saved items?')) {
return; return;
} }
clearHistoryData(id); clearHistoryData(date);
}; };
const restoreHistoryItem = (state: State): void => { const restoreHistory = (state: State): void => {
inputStateStore.set({ ...state, updateEditor: true, updateDiagram: true }); codeStore.set({ ...state, updateEditor: true, updateDiagram: true });
}; };
const relativeTime = (time: number) => { const relativeTime = (time: number) => {
@@ -124,19 +88,6 @@
<Card on:select={tabSelectHandler} bind:isOpen {tabs} title="History"> <Card on:select={tabSelectHandler} bind:isOpen {tabs} title="History">
<div slot="actions"> <div slot="actions">
<button
id="uploadHistory"
class="btn btn-xs btn-secondary w-12"
on:click|stopPropagation={() => uploadHistory()}
title="Upload history"><i class="fa fa-upload" /></button>
{#if $historyStore.length > 0}
<button
id="downloadHistory"
class="btn btn-xs btn-secondary w-12"
on:click|stopPropagation={() => downloadHistory()}
title="Download history"><i class="fa fa-download" /></button>
{/if}
|
<button <button
id="saveHistory" id="saveHistory"
class="btn btn-xs btn-success w-12" class="btn btn-xs btn-success w-12"
@@ -152,7 +103,7 @@
</div> </div>
<ul class="p-2 space-y-2 overflow-auto h-56" id="historyList"> <ul class="p-2 space-y-2 overflow-auto h-56" id="historyList">
{#if $historyStore.length > 0} {#if $historyStore.length > 0}
{#each $historyStore as { id, state, time, name, url, type }} {#each $historyStore as { state, time, name, url, type }}
<li class="rounded p-2 shadow flex-col"> <li class="rounded p-2 shadow flex-col">
<div class="flex"> <div class="flex">
<div class="flex-1"> <div class="flex-1">
@@ -170,10 +121,10 @@
</div> </div>
</div> </div>
<div class="flex gap-2 content-center"> <div class="flex gap-2 content-center">
<button class="btn btn-success" on:click={() => restoreHistoryItem(state)} <button class="btn btn-success" on:click={() => restoreHistory(state)}
><i class="fas fa-undo mr-1" />Restore</button> ><i class="fas fa-undo mr-1" />Restore</button>
{#if type !== 'loader'} {#if type !== 'loader'}
<button class="btn btn-error" on:click={() => clearHistory(id)} <button class="btn btn-error" on:click={() => clearHistory(time)}
><i class="fas fa-trash-alt mr-1" />Delete</button> ><i class="fas fa-trash-alt mr-1" />Delete</button>
{/if} {/if}
</div> </div>
+17 -81
View File
@@ -1,28 +1,26 @@
import { derived, writable, get } from 'svelte/store'; import { derived, writable, get } from 'svelte/store';
import type { Readable, Writable } from 'svelte/store'; import type { Readable, Writable } from 'svelte/store';
import { persist, createLocalStorage } from '@macfja/svelte-persistent-store'; import { persist, localStorage } from '@macfja/svelte-persistent-store';
import { generateSlug } from 'random-word-slugs'; import { generateSlug } from 'random-word-slugs';
import type { HistoryEntry, HistoryType, Optional } from '$lib/types'; import type { HistoryEntry, HistoryType } from '$lib/types';
import { v4 as uuidV4 } from 'uuid';
import { logEvent } from '$lib/util/stats';
const MAX_AUTO_HISTORY_LENGTH = 30; const MAX_AUTO_HISTORY_LENGTH = 30;
export const historyModeStore: Writable<HistoryType> = persist( export const historyModeStore: Writable<HistoryType> = persist(
writable('manual'), writable('manual'),
createLocalStorage(), localStorage(),
'autoHistoryMode' 'autoHistoryMode'
); );
const autoHistoryStore: Writable<HistoryEntry[]> = persist( const autoHistoryStore: Writable<HistoryEntry[]> = persist(
writable([]), writable([]),
createLocalStorage(), localStorage(),
'autoHistoryStore' 'autoHistoryStore'
); );
const manualHistoryStore: Writable<HistoryEntry[]> = persist( const manualHistoryStore: Writable<HistoryEntry[]> = persist(
writable([]), writable([]),
createLocalStorage(), localStorage(),
'manualHistoryStore' 'manualHistoryStore'
); );
@@ -43,39 +41,28 @@ export const historyStore: Readable<HistoryEntry[]> = derived(
} }
); );
export const addHistoryEntry = (entryToAdd: Optional<HistoryEntry, 'id'>): void => { export const addHistoryEntry = (entry: HistoryEntry): void => {
const entry: HistoryEntry = {
...entryToAdd,
id: uuidV4()
};
if (entry.type === 'loader') { if (entry.type === 'loader') {
loaderHistoryStore.update((entries) => [entry, ...entries]); loaderHistoryStore.update((entries) => [entry, ...entries]);
return; return;
} }
entry.name = generateSlug(2);
if (!entry.name) { if (entry.type !== 'auto') {
entry.name = generateSlug(2);
}
if (entry.type === 'auto') {
autoHistoryStore.update((entries) => {
if (entries.length >= MAX_AUTO_HISTORY_LENGTH) {
entries = entries.slice(0, MAX_AUTO_HISTORY_LENGTH - 1);
}
return [entry, ...entries];
});
} else if (entry.type === 'manual') {
manualHistoryStore.update((entries) => [entry, ...entries]); manualHistoryStore.update((entries) => [entry, ...entries]);
logEvent('history', { action: 'save' }); return;
} }
autoHistoryStore.update((entries) => {
if (entries.length === MAX_AUTO_HISTORY_LENGTH) {
entries.pop();
}
return [entry, ...entries];
});
}; };
export const clearHistoryData = (idToClear?: string): void => { export const clearHistoryData = (time?: number): void => {
(get(historyModeStore) === 'auto' ? autoHistoryStore : manualHistoryStore).update((entries) => { (get(historyModeStore) === 'auto' ? autoHistoryStore : manualHistoryStore).update((entries) => {
if (get(historyModeStore) !== 'loader') { if (get(historyModeStore) !== 'loader') {
entries = entries.filter(({ id }) => idToClear && id != idToClear); entries = entries.filter((entry) => time && entry.time != time);
logEvent('history', { action: 'clear', type: idToClear ? 'single' : 'all' });
} }
return entries; return entries;
}); });
@@ -88,54 +75,3 @@ export const getPreviousState = (auto: boolean): string => {
} }
return ''; return '';
}; };
export const restoreHistory = (data: HistoryEntry[]) => {
const entries = data.filter(validateEntry);
const invalidEntryCount = data.length - entries.length;
if (invalidEntryCount > 0) {
console.error(`${invalidEntryCount} invalid history entries were removed.`);
console.error(data);
}
if (entries.length > 0) {
let entryCount = 0;
(entries[0].type === 'auto' ? autoHistoryStore : manualHistoryStore).update((existing) => {
const existingIDs = new Set(existing.map(({ id }) => id));
const newEntries = entries.filter(({ id }) => !existingIDs.has(id));
entryCount = newEntries.length;
const combined = [...existing, ...newEntries];
combined.sort((a, b) => b.time - a.time);
return combined;
});
alert(
`${entryCount} entries restored. ${invalidEntryCount} invalid, ${
entries.length - entryCount
} duplicates.`
);
logEvent('history', {
action: 'restore',
success: entryCount,
invalid: invalidEntryCount,
duplicates: entries.length - entryCount
});
} else {
alert('No valid entries found.');
}
};
export const injectHistoryIDs = (): void => {
const setIDs = (entries: HistoryEntry[]) => {
for (const entry of entries) {
if (!entry.id) {
entry.id = uuidV4();
}
}
return entries;
};
autoHistoryStore.update(setIDs);
manualHistoryStore.update(setIDs);
};
const validateEntry = (entry: HistoryEntry): boolean => {
return entry.type && entry.state && entry.time && true;
};
+1 -7
View File
@@ -1,7 +1,6 @@
<script lang="ts"> <script lang="ts">
import { updateCode } from '$lib/util/state'; import { updateCode } from '$lib/util/state';
import Card from '$lib/components/card/card.svelte'; import Card from '$lib/components/card/card.svelte';
import { logEvent } from '$lib/util/stats';
const samples = { const samples = {
'Flow Chart': `graph TD 'Flow Chart': `graph TD
@@ -96,12 +95,7 @@
}; };
const loadSampleDiagram = (diagramType: string): void => { const loadSampleDiagram = (diagramType: string): void => {
updateCode(samples[diagramType], { updateCode(samples[diagramType], true, true);
updateDiagram: true,
updateEditor: true,
resetPanZoom: true
});
void logEvent('loadSampleDiagram', { diagramType });
}; };
</script> </script>
+18 -80
View File
@@ -1,10 +1,9 @@
<script lang="ts"> <script lang="ts">
import { inputStateStore, stateStore, updateCodeStore } from '$lib/util/state'; import { errorStore } from '$lib/util/error';
import { codeStore } from '$lib/util/state';
import { onMount } from 'svelte'; import { onMount } from 'svelte';
import mermaid from 'mermaid'; import mermaid from 'mermaid';
import panzoom from 'svg-pan-zoom';
import type { State } from '$lib/types';
import { logEvent } from '$lib/util/stats';
let code = ''; let code = '';
let config = ''; let config = '';
@@ -12,85 +11,33 @@
let view: HTMLDivElement; let view: HTMLDivElement;
let error = false; let error = false;
let outOfSync = false; let outOfSync = false;
let hide = false;
let manualUpdate = true; let manualUpdate = true;
let panZoomEnabled = $stateStore.panZoom;
let pzoom: SvgPanZoom.Instance;
let debounce: number;
const handlePanZoomChange = () => {
const pan = pzoom.getPan();
const zoom = pzoom.getZoom();
clearTimeout(debounce);
debounce = window.setTimeout(() => {
updateCodeStore({ pan, zoom });
void logEvent('panZoom');
}, 200);
};
const handlePanZoom = (state: State) => {
if (!state.panZoom) {
return;
}
hide = true;
pzoom?.destroy();
pzoom = undefined;
Promise.resolve().then(() => {
const graphDiv = document.getElementById('graph-div');
pzoom = panzoom(graphDiv, {
onPan: handlePanZoomChange,
onZoom: handlePanZoomChange,
controlIconsEnabled: true,
fit: true,
center: true
});
const { pan, zoom } = state;
if (pan !== undefined && zoom !== undefined && Number.isFinite(zoom)) {
pzoom.zoom(zoom);
pzoom.pan(pan);
}
hide = false;
});
};
onMount(() => { onMount(() => {
stateStore.subscribe((state) => { codeStore.subscribe((state) => {
if (state.error !== undefined) {
error = true;
return;
}
error = false;
try { try {
if (container && state && (state.updateDiagram || state.autoSync)) { if (container && state && (state.updateDiagram || state.autoSync)) {
if (!state.autoSync) { if (!state.autoSync) {
$inputStateStore.updateDiagram = false; $codeStore.updateDiagram = false;
} }
outOfSync = false; outOfSync = false;
manualUpdate = true; manualUpdate = true;
if (code === state.code && config === state.mermaid && panZoomEnabled === state.panZoom) { if (code === state.code && config === state.mermaid) {
// Do not render if there is no change in Code/Config/PanZoom // Do not render if there is no change in Code/Config
return; return;
} }
code = state.code; code = state.code;
config = state.mermaid; config = state.mermaid;
panZoomEnabled = state.panZoom;
const scroll = view.parentElement.scrollTop; const scroll = view.parentElement.scrollTop;
delete container.dataset.processed; delete container.dataset.processed;
mermaid.initialize(Object.assign({}, JSON.parse(state.mermaid))); mermaid.initialize(Object.assign({}, JSON.parse(state.mermaid)));
mermaid.render('graph-div', code, (svgCode) => { mermaid.render('graph-div', code, (svgCode) => {
if (svgCode.length > 0) { container.innerHTML = svgCode;
handlePanZoom(state);
container.innerHTML = svgCode;
const graphDiv = document.getElementById('graph-div');
graphDiv.setAttribute('height', '100%');
graphDiv.style.maxWidth = '100%';
}
}); });
view.parentElement.scrollTop = scroll; view.parentElement.scrollTop = scroll;
error = false; error = false;
} else if (manualUpdate) { } else if (manualUpdate) {
manualUpdate = false; manualUpdate = false;
} else if (code !== state.code || config !== state.mermaid) { } else {
outOfSync = true; outOfSync = true;
} }
} catch (e) { } catch (e) {
@@ -98,37 +45,28 @@
error = true; error = true;
} }
}); });
window.addEventListener('resize', () => { errorStore.subscribe((err) => {
if ($stateStore.panZoom && pzoom) { if (typeof err === 'undefined') {
pzoom.resize(); error = false;
} else {
error = true;
console.log('Error: ', err);
} }
}); });
}); });
</script> </script>
{#if error && $stateStore.error instanceof Error} <div id="view" bind:this={view} class="p-2" class:error class:outOfSync>
<div class="p-2 text-red-600" id="errorContainer">{$stateStore.error}</div> <div id="container" bind:this={container} class="flex-1 overflow-auto" />
{/if}
<div id="view" bind:this={view} class="p-2 h-full" class:error class:outOfSync>
<div id="container" bind:this={container} class="h-full overflow-auto" class:hide />
</div> </div>
<style> <style>
#view { #view {
border: 1px solor darkred;
flex: 1; flex: 1;
} }
#container {
transition: visibility 0.3s;
}
.error, .error,
.outOfSync { .outOfSync {
opacity: 0.5; opacity: 0.5;
} }
.hide {
visibility: hidden;
}
</style> </style>
+8 -31
View File
@@ -6,16 +6,6 @@ export interface Locals {
userid: string; userid: string;
} }
export interface MarkerData {
severity: number;
message: string;
source?: string;
startLineNumber: number;
startColumn: number;
endLineNumber: number;
endColumn: number;
}
export interface EditorUpdateEvent { export interface EditorUpdateEvent {
text: string; text: string;
} }
@@ -39,18 +29,9 @@ export interface State {
updateEditor: boolean; updateEditor: boolean;
updateDiagram: boolean; updateDiagram: boolean;
autoSync: boolean; autoSync: boolean;
panZoom?: boolean;
pan?: { x: number; y: number };
zoom?: number;
loader?: LoaderConfig; loader?: LoaderConfig;
} }
export interface ValidatedState extends State {
error: unknown;
errorMarkers: MarkerData[];
serialized: string;
}
export interface GistLoaderConfig { export interface GistLoaderConfig {
url: string; url: string;
} }
@@ -68,16 +49,13 @@ export interface LoaderConfig {
config: GistLoaderConfig | FileLoaderConfig; config: GistLoaderConfig | FileLoaderConfig;
} }
export type HistoryType = 'auto' | 'manual' | 'loader'; export type HistoryType = 'auto' | 'manual' | 'loader';
export type HistoryEntry = { id: string; state: State; time: number; url?: string } & ( export interface HistoryEntry {
| { state: State;
type: 'loader'; time: number;
name: string; name?: string;
} type: HistoryType;
| { url?: string;
type: HistoryType; }
name?: string;
}
);
export interface DocConfig { export interface DocConfig {
[key: string]: { [key: string]: {
@@ -86,5 +64,4 @@ export interface DocConfig {
}; };
} }
export type Loader = (url: string) => Promise<State>; type Loader = (url: string) => Promise<State>;
export type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
+3
View File
@@ -0,0 +1,3 @@
import { writable } from 'svelte/store';
export const errorStore = writable(undefined);
-2
View File
@@ -1,4 +1,3 @@
/* eslint-disable @typescript-eslint/no-unsafe-return */
/* eslint-disable @typescript-eslint/no-unsafe-assignment */ /* eslint-disable @typescript-eslint/no-unsafe-assignment */
/* eslint-disable @typescript-eslint/no-unsafe-member-access */ /* eslint-disable @typescript-eslint/no-unsafe-member-access */
/* eslint-disable @typescript-eslint/no-explicit-any */ /* eslint-disable @typescript-eslint/no-explicit-any */
@@ -44,7 +43,6 @@ const getGistData = async (gistURL: string): Promise<GistData> => {
} }
const currentItem = history[0]; const currentItem = history[0];
return { return {
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
url: `${html_url}/${currentItem.version}`, url: `${html_url}/${currentItem.version}`,
code, code,
config, config,
+3 -5
View File
@@ -7,7 +7,7 @@ const loaders: Record<string, Loader> = {
export const loadDataFromUrl = async (): Promise<void> => { export const loadDataFromUrl = async (): Promise<void> => {
const searchParams = new URLSearchParams(window.location.search); const searchParams = new URLSearchParams(window.location.search);
let state: Partial<State> = defaultState; let state: State = defaultState;
let code: string, config: string; let code: string, config: string;
let loaded = false; let loaded = false;
const codeURL: string = searchParams.get('code'); const codeURL: string = searchParams.get('code');
@@ -23,9 +23,6 @@ export const loadDataFromUrl = async (): Promise<void> => {
config = defaultState.mermaid; config = defaultState.mermaid;
} }
if (!code) { 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()) { for (const [key, value] of searchParams.entries()) {
if (key in loaders) { if (key in loaders) {
try { try {
@@ -48,7 +45,7 @@ export const loadDataFromUrl = async (): Promise<void> => {
configURL configURL
} }
} }
}; } as State;
} }
loaded && loaded &&
updateCodeStore({ updateCodeStore({
@@ -57,4 +54,5 @@ export const loadDataFromUrl = async (): Promise<void> => {
updateDiagram: true, updateDiagram: true,
updateEditor: true updateEditor: true
}); });
// window.location.search = '';
}; };
-35
View File
@@ -1,35 +0,0 @@
import { writable, get, type Writable } from 'svelte/store';
import { persist, createLocalStorage } from '@macfja/svelte-persistent-store';
import { injectHistoryIDs } from '$lib/components/history/history';
import { logEvent } from './stats';
interface MigrationState {
version: number;
}
const migrations: { [key: string]: () => void } = {
injectHistoryIDs
};
const migrationStore: Writable<MigrationState> = persist(
writable({ version: -1 }),
createLocalStorage(),
'migrations'
);
export const applyMigrations = (): void => {
const { version }: MigrationState = get(migrationStore);
const allMigrations = Object.entries(migrations);
if (version === allMigrations.length - 1) {
return;
}
console.log(`Current migration version: v${version}. Migrating to v${allMigrations.length - 1}.`);
for (let i = version + 1; i < allMigrations.length; i++) {
const [key, fn] = allMigrations[i];
console.log(`Applying migration ${i}: ${key}.`);
fn();
logEvent('migration', { key });
migrationStore.set({ version: i });
}
logEvent('migration', { status: 'complete', from: version, to: allMigrations.length - 1 });
};
-40
View File
@@ -1,40 +0,0 @@
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');
});
});
+8 -10
View File
@@ -28,20 +28,18 @@ export const pakoSerde: Serde = {
} }
}; };
export type SerdeType = 'base64' | 'pako'; const serdes: { [key: string]: Serde } = {
const serdes: { [key in SerdeType]: Serde } = {
base64: base64Serde, base64: base64Serde,
pako: pakoSerde pako: pakoSerde
}; };
export const serializeState = (state: State, serde: SerdeType = 'pako'): string => { type SerdeType = keyof typeof serdes;
if (serdes[serde] === undefined) {
throw new Error(`Unknown serde type: ${serde}`); export const serializeState = (state: State): string => {
}
const json = JSON.stringify(state); const json = JSON.stringify(state);
const serialized = serdes[serde].serialize(json); const defaultSerde: SerdeType = 'pako';
return `${serde}:${serialized}`; const serialized = serdes[defaultSerde].serialize(json);
return `${defaultSerde}:${serialized}`;
}; };
export const deserializeState = (state: string): State => { export const deserializeState = (state: string): State => {
@@ -50,7 +48,7 @@ export const deserializeState = (state: string): State => {
let tempType: string; let tempType: string;
[tempType, serialized] = state.split(':'); [tempType, serialized] = state.split(':');
if (tempType in serdes) { if (tempType in serdes) {
type = tempType as SerdeType; type = tempType;
} else { } else {
throw new Error(`Unknown serde type: ${tempType}`); throw new Error(`Unknown serde type: ${tempType}`);
} }
+21 -68
View File
@@ -1,12 +1,9 @@
import { writable, get, derived } from 'svelte/store'; import { writable, get, derived } from 'svelte/store';
import { persist, createLocalStorage } from '@macfja/svelte-persistent-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 { saveStatistics } from './stats';
import { serializeState, deserializeState } from './serde'; import { serializeState, deserializeState } from './serde';
import { cmdKey } from './util';
import mermaid from 'mermaid';
import type { Readable } from 'svelte/store';
import type { MarkerData, State, ValidatedState } from '$lib/types';
export const defaultState: State = { export const defaultState: State = {
code: `graph TD code: `graph TD
@@ -39,47 +36,14 @@ const urlParseFailedState = `graph TD
G --> |"No :("| H(Try using the Timeline tab in History <br/>from same browser you used to create the diagram.) 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"`; 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"`;
// inputStateStore handles all updates and is shared externally when exporting via URL, History, etc. export const codeStore = persist(writable(defaultState), localStorage(), 'codeStore');
export const inputStateStore = persist(writable(defaultState), createLocalStorage(), 'codeStore'); export const serializedState: Readable<string> = derived([codeStore], ([code], set) => {
set(serializeState(code));
// 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 => { export const loadState = (data: string): void => {
let state: State; let state: State;
console.log(`Loading '${data}'`); console.log('Loading', data);
try { try {
state = deserializeState(data); state = deserializeState(data);
const mermaidConfig: { [key: string]: string } = const mermaidConfig: { [key: string]: string } =
@@ -93,65 +57,54 @@ export const loadState = (data: string): void => {
) { ) {
delete mermaidConfig.securityLevel; // Prevent setting overriding securityLevel when loading state to mitigate possible XSS attack delete mermaidConfig.securityLevel; // Prevent setting overriding securityLevel when loading state to mitigate possible XSS attack
} }
state.mermaid = JSON.stringify(mermaidConfig, null, 2); state.mermaid = JSON.stringify(mermaidConfig, null, 2);
} catch (e) { } catch (e) {
state = get(inputStateStore); state = get(codeStore);
if (data) { if (data) {
console.error('Init error', e); console.error('Init error', e);
state.code = urlParseFailedState; state.code = urlParseFailedState;
state.mermaid = defaultState.mermaid;
} }
} }
updateCodeStore({ ...state, updateEditor: true }); updateCodeStore({ ...state, updateEditor: true });
}; };
export const updateCodeStore = (newState: Partial<State>): void => { export const updateCodeStore = (newState: State): void => {
inputStateStore.update((state) => { codeStore.update((state) => {
return { ...state, ...newState }; return { ...state, ...newState };
}); });
}; };
let prompted = false; let prompted = false;
export const updateCode = ( export const updateCode = (code: string, updateEditor: boolean, updateDiagram = false): void => {
code: string,
{
updateEditor,
updateDiagram = false,
resetPanZoom = false
}: { updateEditor: boolean; updateDiagram?: boolean; resetPanZoom?: boolean }
): void => {
saveStatistics(code); saveStatistics(code);
const lines = (code.match(/\n/g) || '').length + 1; const lines = (code.match(/\n/g) || '').length + 1;
if (lines > 50 && !prompted && get(stateStore).autoSync) { if (lines > 50 && !prompted && get(codeStore).autoSync) {
const turnOff = confirm( const turnOff = confirm(
`Long diagram detected. Turn off Auto Sync? Use ${cmdKey} + Enter or click the sync logo to manually sync.` 'Long diagram detected. Turn off Auto Sync? Click the sync logo to manually sync.'
); );
prompted = true; prompted = true;
if (turnOff) { if (turnOff) {
updateCodeStore({ updateCodeStore({
autoSync: false autoSync: false
}); } as State);
} }
} }
inputStateStore.update((state) => { codeStore.update((state) => {
if (resetPanZoom) {
state.pan = undefined;
state.zoom = undefined;
}
return { ...state, code, updateEditor, updateDiagram }; return { ...state, code, updateEditor, updateDiagram };
}); });
}; };
export const updateConfig = (config: string, updateEditor: boolean): void => { export const updateConfig = (config: string, updateEditor: boolean): void => {
inputStateStore.update((state) => { codeStore.update((state) => {
return { ...state, mermaid: config, updateEditor }; return { ...state, mermaid: config, updateEditor };
}); });
}; };
export const toggleDarkTheme = (dark: boolean): void => { export const toggleDarkTheme = (dark: boolean): void => {
inputStateStore.update((state) => { codeStore.update((state) => {
const config = JSON.parse(state.mermaid); const config = JSON.parse(state.mermaid);
if (!config.theme || ['dark', 'default'].includes(config.theme)) { if (!config.theme || ['dark', 'default'].includes(config.theme)) {
config.theme = dark ? 'dark' : 'default'; config.theme = dark ? 'dark' : 'default';
@@ -162,11 +115,11 @@ export const toggleDarkTheme = (dark: boolean): void => {
}; };
export const initURLSubscription = (): void => { export const initURLSubscription = (): void => {
stateStore.subscribe(({ serialized }) => { serializedState.subscribe((state: string) => {
history.replaceState(undefined, undefined, `#${serialized}`); history.replaceState(undefined, undefined, `#${state}`);
}); });
}; };
export const getStateString = (): string => { export const getStateString = (): string => {
return JSON.stringify(get(inputStateStore)); return JSON.stringify(get(codeStore));
}; };
+10 -23
View File
@@ -8,28 +8,18 @@ export const initAnalytics = async (): Promise<void> => {
try { try {
const { Analytics } = await import('analytics'); const { Analytics } = await import('analytics');
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
const googleAnalytics = (await import('@analytics/google-analytics')).default; const googleAnalytics = await import('@analytics/google-analytics');
const plausible = (await import('analytics-plugin-plausible')).default;
analytics = Analytics({ analytics = Analytics({
app: 'mermaid-live-editor', app: 'mermaid-live-editor',
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
plugins: [ plugins: [
// eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access // eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
googleAnalytics({ googleAnalytics.init({
measurementIds: ['UA-153180559-1'] trackingId: 'UA-153180559-1'
}),
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
plausible({
domain: 'mermaid.live',
hashMode: false,
trackLocalhost: false, // By default 'false'
apiHost: 'https://plausible.io'
}) })
] ]
}); });
} catch (e) { } catch {
console.log(e);
console.info('Analytics blocked ;)'); console.info('Analytics blocked ;)');
} }
} }
@@ -43,20 +33,17 @@ const detectType = (text: string): string => {
}; };
// manual debounce // manual debounce
let timeout: number; let timeout;
export const saveStatistics = (graph: string): void => { export const saveStatistics = (graph: string): void => {
if (analytics) { if (analytics) {
clearTimeout(timeout); clearTimeout(timeout);
// Only save statistics after a 5 sec delay // Only save statistics after a 5 sec delay
timeout = window.setTimeout(() => { timeout = setTimeout(function () {
const graphType = detectType(graph); const graphType = detectType(graph);
console.debug(`ga: send event: render ${graphType}`); console.debug('ga:', 'send', 'event', 'render', graphType);
void logEvent('render', { graphType }); void analytics.track('render', {
graphType
});
}, 5000); }, 5000);
} }
}; };
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export const logEvent = async (name: string, data?: any): Promise<void> => {
await analytics?.track(name, data);
};
+2 -4
View File
@@ -1,7 +1,6 @@
import { writable } from 'svelte/store'; import { writable } from 'svelte/store';
import type { Writable } from 'svelte/store'; import type { Writable } from 'svelte/store';
import { persist, createLocalStorage } from '@macfja/svelte-persistent-store'; import { persist, localStorage } from '@macfja/svelte-persistent-store';
import { logEvent } from './stats';
export interface ThemeConfig { export interface ThemeConfig {
isDark: boolean; isDark: boolean;
@@ -12,7 +11,7 @@ export const themeStore: Writable<ThemeConfig> = persist(
writable({ writable({
isDark: false isDark: false
}), }),
createLocalStorage(), localStorage(),
'themeStore' 'themeStore'
); );
@@ -34,5 +33,4 @@ export const setTheme = (theme: string): void => {
const isDark = darkThemes.includes(theme); const isDark = darkThemes.includes(theme);
console.log('Setting theme', theme); console.log('Setting theme', theme);
themeStore.set({ theme, isDark }); themeStore.set({ theme, isDark });
void logEvent('themeChange', { theme, isDark });
}; };
+2 -6
View File
@@ -1,3 +1,4 @@
import type { State } from '$lib/types';
import { initURLSubscription, loadState, updateCodeStore } from './state'; import { initURLSubscription, loadState, updateCodeStore } from './state';
import { analytics, initAnalytics } from './stats'; import { analytics, initAnalytics } from './stats';
import { loadDataFromUrl } from './fileLoaders/loader'; import { loadDataFromUrl } from './fileLoaders/loader';
@@ -10,7 +11,7 @@ export const loadStateFromURL = (): void => {
export const syncDiagram = (): void => { export const syncDiagram = (): void => {
updateCodeStore({ updateCodeStore({
updateDiagram: true updateDiagram: true
}); } as State);
}; };
export const initHandler = async (): Promise<void> => { export const initHandler = async (): Promise<void> => {
@@ -21,8 +22,3 @@ export const initHandler = async (): Promise<void> => {
await initAnalytics(); await initAnalytics();
analytics?.page(); analytics?.page();
}; };
export const isMac = navigator.platform.toUpperCase().indexOf('MAC') >= 0;
export const cmdKey = isMac ? 'Cmd' : 'Ctrl';
export const debounceEnabled = window.localStorage.getItem('noDebounce') !== 'true';
+2
View File
@@ -0,0 +1,2 @@
import { get as manifestGet } from '../manifest.json';
export const get = manifestGet;
@@ -1,4 +0,0 @@
import type { RequestHandler } from './$types';
import { GET as manifestGet } from '../../manifest.json/+server';
export const GET: RequestHandler = manifestGet;
@@ -5,16 +5,10 @@
import { loadingStateStore } from '$lib/util/loading'; import { loadingStateStore } from '$lib/util/loading';
import { setTheme, themeStore } from '$lib/util/theme'; import { setTheme, themeStore } from '$lib/util/theme';
import { toggleDarkTheme } from '$lib/util/state'; import { toggleDarkTheme } from '$lib/util/state';
import { initHandler } from '$lib/util/util';
import { applyMigrations } from '$lib/util/migrations';
// This can be removed once https://github.com/sveltejs/kit/issues/1612 is fixed. // This can be removed once https://github.com/sveltejs/kit/issues/1612 is fixed.
// Then move it into src and vite will bundle it automatically. // Then move it into src and vite will bundle it automatically.
onMount(() => { onMount(() => {
applyMigrations();
window.addEventListener('hashchange', async (ev) => {
await initHandler();
});
if ('serviceWorker' in navigator) { if ('serviceWorker' in navigator) {
navigator.serviceWorker navigator.serviceWorker
.register(`${base}/service-worker.js`, { .register(`${base}/service-worker.js`, {
@@ -6,12 +6,17 @@
import View from '$lib/components/view.svelte'; import View from '$lib/components/view.svelte';
import Card from '$lib/components/card/card.svelte'; import Card from '$lib/components/card/card.svelte';
import History from '$lib/components/history/history.svelte'; import History from '$lib/components/history/history.svelte';
import { updateCode, updateConfig, inputStateStore, stateStore } from '$lib/util/state'; import { updateCode, updateConfig, codeStore, serializedState } from '$lib/util/state';
import { cmdKey, debounceEnabled, initHandler, syncDiagram } from '$lib/util/util'; import { initHandler, syncDiagram } from '$lib/util/util';
import { errorStore } from '$lib/util/error';
import { onMount } from 'svelte'; import { onMount } from 'svelte';
import mermaid from 'mermaid';
import type monaco from 'monaco-editor';
import type { EditorUpdateEvent, State, Tab, DocConfig } from '$lib/types'; import type { EditorUpdateEvent, State, Tab, DocConfig } from '$lib/types';
import { base } from '$app/paths'; import { base } from '$app/paths';
serializedState; // Weird fix for error > serializedState is not defined. Treeshaking?
type Modes = 'code' | 'config'; type Modes = 'code' | 'config';
type Languages = 'mermaid' | 'json'; type Languages = 'mermaid' | 'json';
@@ -63,17 +68,17 @@
let text = ''; let text = '';
let docURL = docURLBase; let docURL = docURLBase;
let language: Languages = 'mermaid'; let language: Languages = 'mermaid';
const handleModeUpdate = (mode: Modes) => { let errorMarkers: monaco.editor.IMarkerData[] = [];
if (mode === 'code') {
text = $stateStore.code;
} else {
text = $stateStore.mermaid;
}
};
$: language = languageMap[selectedMode]; $: language = languageMap[selectedMode];
$: handleModeUpdate(selectedMode); $: {
if (selectedMode === 'code') {
text = $codeStore.code;
} else {
text = $codeStore.mermaid;
}
}
stateStore.subscribe((state: State) => { codeStore.subscribe((state: State) => {
if (state.updateEditor) { if (state.updateEditor) {
text = selectedMode === 'code' ? state.code : state.mermaid; text = selectedMode === 'code' ? state.code : state.mermaid;
} }
@@ -86,7 +91,7 @@
}); });
const tabSelectHandler = (message: CustomEvent<Tab>) => { const tabSelectHandler = (message: CustomEvent<Tab>) => {
selectedMode = message.detail.id === 'code' ? 'code' : 'config'; selectedMode = message.detail.id === 'code' ? 'code' : 'config';
$inputStateStore.updateEditor = true; $codeStore.updateEditor = true;
}; };
const tabs: Tab[] = [ const tabs: Tab[] = [
{ {
@@ -101,33 +106,55 @@
} }
]; ];
const handleUpdate = (text: string) => { const handleCodeUpdate = (code: string): void => {
if (selectedMode === 'code') { mermaid.parse(code);
updateCode(text, { updateCode(code, false);
updateEditor: false };
});
} else { const handleConfigUpdate = (config: string): void => {
updateConfig(text, false); 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);
} }
}; };
let debounce: { [key: string]: number } = {}; const viewDiagram = () => {
const updateHandler = ({ detail: { text } }: CustomEvent<EditorUpdateEvent>) => { window.open(`${base}/view#${$serializedState}`, '_blank').focus();
if (debounceEnabled) {
clearTimeout(debounce[selectedMode]);
debounce[selectedMode] = window.setTimeout(() => {
handleUpdate(text);
}, 300);
} else {
handleUpdate(text);
}
}; };
onMount(async () => { onMount(async () => {
await initHandler(); await initHandler();
const resizer = document.getElementById('resizeHandler'); const resizer = document.getElementById('resizeHandler');
const element = document.getElementById('editorPane'); const element = document.getElementById('editorPane');
const resize = (e: { pageX: number }) => { const resize = (e) => {
const newWidth = e.pageX - element.getBoundingClientRect().left; const newWidth = e.pageX - element.getBoundingClientRect().left;
if (newWidth > 50) { if (newWidth > 50) {
element.style.width = `${newWidth}px`; element.style.width = `${newWidth}px`;
@@ -150,32 +177,34 @@
<div class="flex-1 flex overflow-hidden"> <div class="flex-1 flex overflow-hidden">
<div class="hidden md:flex flex-col" id="editorPane" style="width: 40%"> <div class="hidden md:flex flex-col" id="editorPane" style="width: 40%">
<Card on:select={tabSelectHandler} {tabs} isCloseable={false} title="Mermaid"> <Card on:select={tabSelectHandler} {tabs} isCloseable={false} title="Mermaid">
<div slot="actions" class="flex flex-row items-center"> <div slot="actions">
<div class="form-control flex-row items-center"> <div class="flex flex-row items-center">
<label class="cursor-pointer label" for="autoSync"> <div class="form-control flex-row items-center">
<span> Auto sync</span> <label class="cursor-pointer label" for="autoSync">
<input <span> Auto sync</span>
type="checkbox" <input
class="toggle {$stateStore.autoSync ? 'btn-secondary' : 'toggle-primary'} ml-1" type="checkbox"
id="autoSync" class="toggle {$codeStore.autoSync ? 'btn-secondary' : 'toggle-primary'} ml-1"
bind:checked={$inputStateStore.autoSync} /> id="autoSync"
</label> bind:checked={$codeStore.autoSync} />
</label>
</div>
{#if !$codeStore.autoSync}
<button
class="btn btn-secondary btn-xs mr-1"
title="Sync Diagram"
data-cy="sync"
on:click={syncDiagram}><i class="fas fa-sync" /></button>
{/if}
<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>
{#if !$stateStore.autoSync}
<button
class="btn btn-secondary btn-xs mr-1"
title="Sync Diagram ({cmdKey} + Enter)"
data-cy="sync"
on:click={syncDiagram}><i class="fas fa-sync" /></button>
{/if}
<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} {text} /> <Editor on:update={updateHandler} {language} bind:text {errorMarkers} />
</Card> </Card>
<div class="-mt-2"> <div class="-mt-2">
@@ -187,22 +216,11 @@
<div id="resizeHandler" class="hidden md:block" /> <div id="resizeHandler" class="hidden md:block" />
<div class="flex-1 flex flex-col overflow-hidden"> <div class="flex-1 flex flex-col overflow-hidden">
<Card title="Diagram" isCloseable={false}> <Card title="Diagram" isCloseable={false}>
<div slot="actions" class="flex flex-row items-center"> <button
<label class="cursor-pointer label py-0" for="panZoom"> slot="actions"
<span>Pan & Zoom</span> class="btn btn-secondary btn-xs"
<input title="View diagram in new page"
type="checkbox" on:click|stopPropagation={() => viewDiagram()}><i class="far fa-eye mr-1" />View</button>
class="toggle {$stateStore.panZoom ? 'btn-secondary' : 'toggle-primary'} ml-1"
id="panZoom"
bind:checked={$inputStateStore.panZoom} />
</label>
<a
href={`${base}/view#${$stateStore.serialized}`}
target="_blank"
class="btn btn-secondary btn-xs"
title="View diagram in new page"
><i class="fas fa-external-link-alt mr-1" />Full screen</a>
</div>
<div class="flex-1 overflow-auto"> <div class="flex-1 overflow-auto">
<View /> <View />
+28
View File
@@ -0,0 +1,28 @@
import { base } from '$app/paths';
export const get = (): { body: unknown } => {
return {
body: {
short_name: 'Mermaid',
name: 'Mermaid Live Editor',
icons: [
{
src: `${base}/icon-192.png`,
type: 'image/png',
sizes: '192x192'
},
{
src: `${base}/icon-512.png`,
type: 'image/png',
sizes: '512x512'
}
],
start_url: `${base}/edit/`,
background_color: '#6366F1',
display: 'standalone',
scope: `${base}/edit/`,
theme_color: '#6366F1',
description: 'FlowChart & Diagrams Editor.',
orientation: 'landscape'
}
};
};
-29
View File
@@ -1,29 +0,0 @@
import { json } from '@sveltejs/kit';
import { base } from '$app/paths';
import type { RequestHandler } from './$types';
export const GET: RequestHandler = () => {
return json({
short_name: 'Mermaid',
name: 'Mermaid Live Editor',
icons: [
{
src: `${base}/icon-192.png`,
type: 'image/png',
sizes: '192x192'
},
{
src: `${base}/icon-512.png`,
type: 'image/png',
sizes: '512x512'
}
],
start_url: `${base}/edit/`,
background_color: '#6366F1',
display: 'standalone',
scope: `${base}/edit/`,
theme_color: '#6366F1',
description: 'FlowChart & Diagrams Editor.',
orientation: 'landscape'
});
};
-11
View File
@@ -1,11 +0,0 @@
import matchers from '@testing-library/jest-dom/matchers';
import { expect, beforeAll, vi } from 'vitest';
expect.extend(matchers);
// TODO: Remove once https://github.com/sveltejs/kit/issues/6259 is closed.
beforeAll(() => {
vi.mock('$app/env', () => ({
browser: 'window' in globalThis
}));
});
+3 -2
View File
@@ -20,8 +20,9 @@ const config = {
} }
: {}, : {},
trailingSlash: 'ignore', trailingSlash: 'ignore',
prerender: { vite: {
default: true envPrefix: 'MERMAID_',
optimizeDeps: { include: ['mermaid'] }
} }
} }
}; };
-5
View File
@@ -7,10 +7,5 @@
"cypress/**/*.js", "cypress/**/*.js",
"static/**/*.js" "static/**/*.js"
], ],
"compilerOptions": {
"resolveJsonModule": true,
"allowSyntheticDefaultImports": true,
"types": ["vitest/importMeta"]
},
"extends": "./.svelte-kit/tsconfig.json" "extends": "./.svelte-kit/tsconfig.json"
} }
-29
View File
@@ -1,29 +0,0 @@
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']
},
server: {
port: 3000,
host: true
},
preview: {
port: 3000,
host: true
},
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;
+1266 -1692
View File
File diff suppressed because it is too large Load Diff