Compare commits

..
Author SHA1 Message Date
Yash-Singh1 4e5e2518fb feat: sample diagram and docs for gitgraph 2022-04-16 18:13:10 -07:00
39 changed files with 916 additions and 793 deletions
-1
View File
@@ -11,7 +11,6 @@ module.exports = {
ignorePatterns: [ ignorePatterns: [
'docs/*', 'docs/*',
'*.cjs', '*.cjs',
'*.js',
'*.md', '*.md',
'snapshots.js', 'snapshots.js',
'svelte.config.js', 'svelte.config.js',
+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
+3 -6
View File
@@ -9,6 +9,8 @@ on:
jobs: jobs:
cypress-run: cypress-run:
runs-on: ubuntu-latest runs-on: ubuntu-latest
# Update after https://github.com/cypress-io/cypress-docker-images/issues/487
container: cypress/browsers:node14.16.0-chrome90-ff88
steps: steps:
- name: Checkout - name: Checkout
@@ -25,11 +27,6 @@ jobs:
restore-keys: | restore-keys: |
${{ runner.os }}-node_modules-build- ${{ runner.os }}-node_modules-build-
- uses: actions/setup-node@v3
with:
node-version: 16
cache: 'yarn'
- name: Build & Lint - name: Build & Lint
run: | run: |
yarn install yarn install
@@ -39,7 +36,7 @@ jobs:
# 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:
start: yarn preview start: yarn preview
wait-on: 'http://localhost:3000' wait-on: 'http://localhost:3000'
+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
+1 -1
View File
@@ -8,7 +8,7 @@ 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'
-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
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
+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.4.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.
-31
View File
@@ -1,31 +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,
e2e: {
setupNodeEvents(on, config) {
on('task', {
isFileExist,
findFiles,
deleteFile(path) {
fs.rmSync(path);
return null;
},
readFileMaybe(filename) {
if (fs.existsSync(filename)) {
return fs.readFileSync(filename, 'utf8');
}
return null;
}
});
},
baseUrl: 'http://localhost:3000',
specPattern: 'cypress/e2e/**/*.{js,jsx,ts,tsx}'
}
});
+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
}
-54
View File
@@ -1,54 +0,0 @@
describe('Check actions', () => {
beforeEach(() => {
cy.clearLocalStorage();
cy.visit('/edit');
});
it('should update markdown code', () => {
cy.get('#markdown')
.invoke('val')
.then((oldText) => {
cy.get('#editor').click('bottom').type('{enter}C --> HistoryTest');
cy.get('#markdown')
.invoke('val')
.then((newText) => {
expect(oldText).to.not.eq(newText);
});
});
});
it('should load gists from URL', () => {
cy.get('#gist').type('https://gist.github.com/sidharthv96/6268a23e673a533dcb198f241fd7012a');
cy.contains('Load Gist').click();
cy.contains('Go shopping!!');
});
it('should download png and svg', () => {
const now = new Date(2022, 0, 1).getTime();
cy.clock(now);
const downloadsFolder = Cypress.config('downloadsFolder');
const verifyFileSize = (fileType: string, size: number) => {
cy.get(`#download${fileType.toUpperCase()}`).click();
const fileName = `mermaid-diagram-2022-01-01-000000.${fileType}`;
const filePath = `${downloadsFolder}/${fileName}`;
cy.verifyDownload(fileName);
cy.readFile(filePath, null, {
log: false
}).then((buffer) => expect((buffer as ArrayBuffer).byteLength).to.be.gt(size));
cy.task('deleteFile', filePath);
};
verifyFileSize('png', 21_000);
verifyFileSize('svg', 11_000);
// Verify downloaded file is different for different diagrams
cy.contains('Sample Diagrams').click();
cy.contains('ER Diagram').click();
verifyFileSize('png', 46_000);
verifyFileSize('svg', 12_000);
cy.clock().invoke('restore');
});
});
+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!!');
});
});
@@ -3,7 +3,6 @@ describe('Auto sync tests', () => {
cy.clearLocalStorage(); cy.clearLocalStorage();
cy.visit('/'); cy.visit('/');
}); });
it('should dim diagram when code is edited', () => { it('should dim diagram when code is edited', () => {
cy.contains('Auto sync').click(); cy.contains('Auto sync').click();
cy.get('#view').should('not.have.class', 'outOfSync'); cy.get('#view').should('not.have.class', 'outOfSync');
@@ -41,17 +40,4 @@ describe('Auto sync tests', () => {
cy.get('#editor').type(`{uparrow}{${cmd}}/`); cy.get('#editor').type(`{uparrow}{${cmd}}/`);
cy.get('#view').contains('Car').should('exist'); 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('#editor').type(`{enter}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');
});
}); });
+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.2.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"]
} }
+30 -33
View File
@@ -5,61 +5,60 @@
"dev": "svelte-kit dev --host 0.0.0.0", "dev": "svelte-kit dev --host 0.0.0.0",
"build": "svelte-kit build", "build": "svelte-kit build",
"preview": "svelte-kit 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; cypress cache prune", "postinstall": "husky install",
"test": "cypress run", "test": "cypress run",
"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.34", "@sveltejs/adapter-static": "1.0.0-next.29",
"@sveltejs/kit": "1.0.0-next.354", "@sveltejs/kit": "1.0.0-next.310",
"@types/mermaid": "^8.2.9", "@types/mermaid": "^8.2.9",
"@types/pako": "^1.0.3", "@types/pako": "^1.0.3",
"@typescript-eslint/eslint-plugin": "^4.33.0", "@typescript-eslint/eslint-plugin": "^4.33.0",
"@typescript-eslint/parser": "^4.33.0", "@typescript-eslint/parser": "^4.33.0",
"autoprefixer": "^10.4.7", "autoprefixer": "^10.4.4",
"chai": "^4.3.6", "chai": "^4.3.6",
"cssnano": "^5.1.12", "cssnano": "^5.1.7",
"cy-verify-downloads": "^0.1.8", "cypress": "9.5.3",
"cypress": "10.2.0", "cypress-localstorage-commands": "^1.7.0",
"cypress-localstorage-commands": "^2.1.0",
"eslint": "^7.32.0", "eslint": "^7.32.0",
"eslint-config-prettier": "^8.5.0", "eslint-config-prettier": "^8.5.0",
"eslint-plugin-cypress": "^2.12.1", "eslint-plugin-cypress": "^2.12.1",
"eslint-plugin-es": "^4.1.0", "eslint-plugin-es": "^4.1.0",
"eslint-plugin-mocha": "^10.0.5", "eslint-plugin-mocha": "^10.0.3",
"eslint-plugin-postcss-modules": "^2.0.0", "eslint-plugin-postcss-modules": "^2.0.0",
"eslint-plugin-svelte3": "^3.4.1", "eslint-plugin-svelte3": "^3.4.1",
"eslint-plugin-tailwindcss": "^3.5.2", "eslint-plugin-tailwindcss": "^3.5.0",
"husky": "^8.0.1", "husky": "^7.0.4",
"lint-staged": "13.0.2", "lint-staged": "^12.3.7",
"mocha": "^10.0.0", "mocha": "^9.2.2",
"node-html-parser": "^5.3.3", "node-html-parser": "^5.3.3",
"postcss": "^8.4.14", "postcss": "^8.4.12",
"postcss-load-config": "^4.0.1", "postcss-load-config": "^3.1.4",
"prettier": "~2.7.1", "prettier": "~2.6.2",
"prettier-plugin-svelte": "^2.7.0", "prettier-plugin-svelte": "^2.7.0",
"svelte": "^3.48.0", "svelte": "^3.47.0",
"svelte-preprocess": "4.10.7", "svelte-preprocess": "^4.10.5",
"tailwindcss": "^3.1.4", "tailwindcss": "^3.0.21",
"tslib": "^2.4.0", "tslib": "^2.3.1",
"typescript": "^4.7.3" "typescript": "^4.6.3"
}, },
"type": "module", "type": "module",
"dependencies": { "dependencies": {
"@analytics/google-analytics": "^0.5.3", "@analytics/google-analytics": "^0.5.3",
"@macfja/svelte-persistent-store": "^1.3.0", "@macfja/svelte-persistent-store": "^1.3.0",
"analytics": "^0.8.1", "analytics": "^0.8.1",
"daisyui": "2.17.0", "daisyui": "2.13.6",
"js-base64": "^3.7.2", "js-base64": "^3.7.2",
"mermaid": "9.1.2", "mermaid": "9.0.0",
"moment": "^2.29.3", "moment": "^2.29.2",
"monaco-editor": "^0.33.0", "monaco-editor": "^0.33.0",
"monaco-mermaid": "^1.0.6", "monaco-mermaid": "^1.0.3",
"pako": "2.0.4", "pako": "2.0.4",
"random-word-slugs": "^0.1.6" "random-word-slugs": "^0.1.6"
}, },
@@ -70,10 +69,8 @@
] ]
}, },
"volta": { "volta": {
"node": "16.15.0", "node": "14.16.1",
"yarn": "1.22.10" "yarn": "1.22.10",
}, "npm": "7.11.2"
"engines": {
"node": ">=16.7"
} }
} }
View File
+4 -4
View File
@@ -11,8 +11,8 @@
<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" />
@@ -39,9 +39,9 @@
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>
+26 -50
View File
@@ -4,20 +4,17 @@
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 { 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,22 +50,6 @@
event.preventDefault(); event.preventDefault();
}; };
const getSvgEl = () => {
const svgEl: HTMLElement = document
.querySelector('#container svg')
.cloneNode(true) as HTMLElement;
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;
@@ -81,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')
); );
}; };
@@ -121,7 +102,10 @@
}; };
const onDownloadSVG = () => { const onDownloadSVG = () => {
simulateDownload(getFileName('svg'), `data:image/svg+xml;base64,${getBase64SVG()}`); simulateDownload(
`mermaid-diagram-${moment().format('YYYYMMDDHHmmss')}.svg`,
`data:image/svg+xml;base64,${getBase64SVG()}`
);
}; };
const onCopyMarkdown = () => { const onCopyMarkdown = () => {
@@ -130,10 +114,10 @@
}; };
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;
} }
}); });
@@ -155,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>
@@ -170,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
+4 -3
View File
@@ -1,6 +1,6 @@
<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 type monaco from 'monaco-editor'; import type monaco from 'monaco-editor';
import { createEventDispatcher, onMount } from 'svelte'; import { createEventDispatcher, onMount } from 'svelte';
@@ -21,16 +21,17 @@
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);
$: { $: {
if (text !== oldText) { if (text !== oldText) {
if ($stateStore.updateEditor) { if ($codeStore.updateEditor) {
editor?.setValue(text); editor?.setValue(text);
} }
oldText = text; oldText = text;
} }
editor && Monaco?.editor.setModelMarkers(editor.getModel(), 'test', $stateStore.errorMarkers); editor && Monaco?.editor.setModelMarkers(editor.getModel(), 'test', errorMarkers);
} }
themeStore.subscribe(({ isDark }) => { themeStore.subscribe(({ isDark }) => {
+3 -3
View File
@@ -1,6 +1,6 @@
<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,
@@ -37,7 +37,7 @@
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'
}); });
@@ -54,7 +54,7 @@
}; };
const restoreHistory = (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) => {
+1 -4
View File
@@ -95,10 +95,7 @@
}; };
const loadSampleDiagram = (diagramType: string): void => { const loadSampleDiagram = (diagramType: string): void => {
updateCode(samples[diagramType], { updateCode(samples[diagramType], true, true);
updateDiagram: true,
updateEditor: true
});
}; };
</script> </script>
+15 -16
View File
@@ -1,5 +1,7 @@
<script lang="ts"> <script lang="ts">
import { inputStateStore, stateStore } 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';
@@ -11,16 +13,11 @@
let outOfSync = false; let outOfSync = false;
let manualUpdate = true; let manualUpdate = true;
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;
@@ -34,10 +31,7 @@
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;
console.log(svgCode);
container.innerHTML = svgCode;
}
}); });
view.parentElement.scrollTop = scroll; view.parentElement.scrollTop = scroll;
error = false; error = false;
@@ -51,19 +45,24 @@
error = true; error = true;
} }
}); });
errorStore.subscribe((err) => {
if (typeof err === 'undefined') {
error = false;
} else {
error = true;
console.log('Error: ', err);
}
});
}); });
</script> </script>
{#if error && $stateStore.error instanceof Error}
<div class="p-2 text-red-600" id="errorContainer">{$stateStore.error}</div>
{/if}
<div id="view" bind:this={view} class="p-2" class:error class:outOfSync> <div id="view" bind:this={view} class="p-2" class:error class:outOfSync>
<div id="container" bind:this={container} class="flex-1 overflow-auto" /> <div id="container" bind:this={container} class="flex-1 overflow-auto" />
</div> </div>
<style> <style>
#view { #view {
border: 1px solor darkred;
flex: 1; flex: 1;
} }
.error, .error,
+1 -17
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;
} }
@@ -42,12 +32,6 @@ export interface State {
loader?: LoaderConfig; loader?: LoaderConfig;
} }
export interface ValidatedState extends State {
error: any;
errorMarkers: MarkerData[];
serialized: string;
}
export interface GistLoaderConfig { export interface GistLoaderConfig {
url: string; url: string;
} }
@@ -80,4 +64,4 @@ export interface DocConfig {
}; };
} }
export type Loader = (url: string) => Promise<State>; type Loader = (url: string) => Promise<State>;
+3
View File
@@ -0,0 +1,3 @@
import { writable } from 'svelte/store';
export const errorStore = writable(undefined);
+1
View File
@@ -54,4 +54,5 @@ export const loadDataFromUrl = async (): Promise<void> => {
updateDiagram: true, updateDiagram: true,
updateEditor: true updateEditor: true
}); });
// window.location.search = '';
}; };
+16 -54
View File
@@ -1,11 +1,9 @@
import { writable, get, derived } from 'svelte/store'; import { writable, get, derived } from 'svelte/store';
import type { Readable } from 'svelte/store';
import { persist, localStorage } from '@macfja/svelte-persistent-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 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
@@ -38,42 +36,9 @@ 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), localStorage(), '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 => {
@@ -92,33 +57,30 @@ 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: 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 }: { updateEditor: boolean; updateDiagram?: 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? Click the sync logo to manually sync.' 'Long diagram detected. Turn off Auto Sync? Click the sync logo to manually sync.'
); );
@@ -130,19 +92,19 @@ export const updateCode = (
} }
} }
inputStateStore.update((state) => { codeStore.update((state) => {
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';
@@ -153,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));
}; };
+53 -18
View File
@@ -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 { 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,16 +68,17 @@
let text = ''; let text = '';
let docURL = docURLBase; let docURL = docURLBase;
let language: Languages = 'mermaid'; let language: Languages = 'mermaid';
let errorMarkers: monaco.editor.IMarkerData[] = [];
$: language = languageMap[selectedMode]; $: language = languageMap[selectedMode];
$: { $: {
if (selectedMode === 'code') { if (selectedMode === 'code') {
text = $stateStore.code; text = $codeStore.code;
} else { } else {
text = $stateStore.mermaid; 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;
} }
@@ -85,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[] = [
{ {
@@ -100,26 +106,55 @@
} }
]; ];
const handleCodeUpdate = (code: string): void => {
mermaid.parse(code);
updateCode(code, false);
};
const handleConfigUpdate = (config: string): void => {
JSON.parse(config);
updateConfig(config, false);
};
const updateHandler = (message: CustomEvent<EditorUpdateEvent>) => { const updateHandler = (message: CustomEvent<EditorUpdateEvent>) => {
const code = message.detail.text; try {
if (selectedMode === 'code') { if (selectedMode === 'code') {
updateCode(code, { handleCodeUpdate(message.detail.text);
updateEditor: false } else {
}); handleConfigUpdate(message.detail.text);
} else { }
updateConfig(code, false); errorStore.set(undefined);
errorMarkers = [];
} catch (e) {
errorStore.set(e);
if (e.hash) {
const marker: monaco.editor.IMarkerData = {
severity: 8, //Error
startLineNumber: e.hash.loc.first_line,
startColumn: e.hash.loc.first_column,
endLineNumber: e.hash.loc.last_line,
endColumn: (e.hash.loc.last_column as number) + 1,
message: e.str
};
errorMarkers.push(marker);
// Clear all previous errors before this error.
errorMarkers = errorMarkers.filter(
(m) => m.startLineNumber >= marker.startLineNumber && m.startColumn >= marker.startColumn
);
}
console.error(e);
} }
}; };
const viewDiagram = () => { const viewDiagram = () => {
window.open(`${base}/view#${$stateStore.serialized}`, '_blank').focus(); window.open(`${base}/view#${$serializedState}`, '_blank').focus();
}; };
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`;
@@ -149,13 +184,13 @@
<span> Auto sync</span> <span> Auto sync</span>
<input <input
type="checkbox" type="checkbox"
class="toggle {$stateStore.autoSync ? 'btn-secondary' : 'toggle-primary'} ml-1" class="toggle {$codeStore.autoSync ? 'btn-secondary' : 'toggle-primary'} ml-1"
id="autoSync" id="autoSync"
bind:checked={$inputStateStore.autoSync} /> bind:checked={$codeStore.autoSync} />
</label> </label>
</div> </div>
{#if !$stateStore.autoSync} {#if !$codeStore.autoSync}
<button <button
class="btn btn-secondary btn-xs mr-1" class="btn btn-secondary btn-xs mr-1"
title="Sync Diagram" title="Sync Diagram"
@@ -169,7 +204,7 @@
</div> </div>
</div> </div>
<Editor on:update={updateHandler} {language} bind:text /> <Editor on:update={updateHandler} {language} bind:text {errorMarkers} />
</Card> </Card>
<div class="-mt-2"> <div class="-mt-2">
-3
View File
@@ -23,9 +23,6 @@ const config = {
vite: { vite: {
envPrefix: 'MERMAID_', envPrefix: 'MERMAID_',
optimizeDeps: { include: ['mermaid'] } optimizeDeps: { include: ['mermaid'] }
},
prerender: {
default: true
} }
} }
}; };
-3
View File
@@ -7,8 +7,5 @@
"cypress/**/*.js", "cypress/**/*.js",
"static/**/*.js" "static/**/*.js"
], ],
"compilerOptions": {
"allowSyntheticDefaultImports": true
},
"extends": "./.svelte-kit/tsconfig.json" "extends": "./.svelte-kit/tsconfig.json"
} }
+682 -454
View File
File diff suppressed because it is too large Load Diff