Merge pull request #3 from mermaid-js/develop

sync develop branch

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [knsv]
+#patreon: # Replace with a single Patreon username
+#open_collective: # Replace with a single Open Collective username
+#ko_fi: # Replace with a single Ko-fi username
+#tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+#community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+#liberapay: # Replace with a single Liberapay username
+#issuehunt: # Replace with a single IssueHunt username
+#otechie: # Replace with a single Otechie username
+#custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/pr-labeler.yml

@@ -0,0 +1,3 @@
+'Type: Bug / Error': 'bug/*'
+'Type: Enhancement': 'feature/*'
+'Type: Other': 'other/*'

.github/release-drafter.yml

@@ -0,0 +1,23 @@
+name-template: '$NEXT_PATCH_VERSION'
+tag-template: '$NEXT_PATCH_VERSION'
+categories:
+ - title: '🚀 Features'
+ labels:
+ - 'Type: Enhancement'
+ - title: '🐛 Bug Fixes'
+ labels:
+ - 'Type: Bug / Error'
+ - title: '🧰 Maintenance'
+ label: 'Type: Other'
+change-template: '- $TITLE (#$NUMBER) @$AUTHOR'
+branches:
+ - develop
+exclude-labels:
+ - 'Skip changelog'
+no-changes-template: 'This release contains minor changes and bugfixes.'
+template: |
+ # Release Notes
+
+ $CHANGES
+
+ 🎉 **Thanks to all contributors helping with this release!** 🎉

.github/workflows/build.yml

@@ -0,0 +1,58 @@
+name: Build
+
+on: [push, pull_request]
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ strategy:
+ matrix:
+ node-version: [10.x, 12.x]
+ steps:
+ - uses: actions/checkout@v1
+
+ - name: Setup Node.js ${{ matrix.node-version }}
+ uses: actions/setup-node@v1
+ with:
+ node-version: ${{ matrix.node-version }}
+
+ - name: Install Yarn
+ run: npm i yarn --global
+
+ - name: Cache Node Modules
+ uses: actions/cache@v1
+ with:
+ path: .cache
+ key: ${{ runner.OS }}-build-${{ hashFiles('**/yarn.lock') }}
+
+ - name: Install Packages
+ run: |
+ yarn config set cache-folder $GITHUB_WORKSPACE/.cache/yarn
+ yarn install --frozen-lockfile
+ env:
+ CYPRESS_CACHE_FOLDER: ../../.cache/Cypress
+
+ - name: Run Build
+ run: yarn build
+
+ - name: Run Unit Tests
+ run: |
+ yarn test --coverage
+ 
+ - name: Upload Test Results
+ uses: coverallsapp/github-action@v1.0.1
+ with:
+ github-token: ${{ secrets.GITHUB_TOKEN }}
+ parallel: true
+
+ - name: Run E2E Tests
+ run: yarn e2e
+ env:
+ PERCY_TOKEN: ${{ secrets.PERCY_TOKEN }}
+ CYPRESS_CACHE_FOLDER: .cache/Cypress
+
+ - name: Post Upload Test Results
+ uses: coverallsapp/github-action@master
+ with:
+ github-token: ${{ secrets.GITHUB_TOKEN }}
+ parallel-finished: true

.github/workflows/pr-labeler.yml

@@ -0,0 +1,13 @@
+name: Apply labels to PR
+on:
+ pull_request:
+ types: [opened]
+
+jobs:
+ pr-labeler:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Label PR
+ uses: TimonVS/pr-labeler-action@v3
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release-draft.yml

@@ -0,0 +1,15 @@
+name: Draft Release
+
+on:
+ push:
+ branches:
+ - develop
+
+jobs:
+ draft-release:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Draft Release
+ uses: toolmantim/release-drafter@v5.2.0
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

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

@@ -8,23 +8,20 @@ on:
 jobs:
  publish:
  runs-on: ubuntu-latest
- strategy:
- matrix:
- node-version: [10.x]
  steps:
  - uses: actions/checkout@v1
- - name: Setup Node.js ${{ matrix.node-version }}
+ - name: Setup Node.js
  uses: actions/setup-node@v1
  with:
- node-version: ${{ matrix.node-version }}
+ node-version: 10.x
  - name: Install Yarn
  run: npm i yarn --global
 
  - name: Install Json
  run: npm i json --global
 
  - name: Install Packages
- run: yarn install
+ run: yarn install --frozen-lockfile
 
  - name: Publish
  run: |

.github/workflows/release-publish.yml

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

README.md

@@ -27,7 +27,7 @@ C -->|One| D[Result 1]
 C -->|Two| E[Result 2]
  </pre></td>
  <td align="center">
- <img src="./img/gray-flow.png" />
+ <img src="https://raw.githubusercontent.com/mermaid-js/mermaid/master/img/gray-flow.png" />
  </td>
 </tr>
 <!-- </Flowchart> -->
@@ -49,7 +49,7 @@ John->>Bob: How about you?
 Bob-->>John: Jolly good!
  </pre></td>
  <td align="center">
- <img src="./img/gray-sequence.png" />
+ <img src="https://raw.githubusercontent.com/mermaid-js/mermaid/master/img/gray-sequence.png" />
  </td>
 </tr>
 <!-- </Sequence> -->
@@ -70,7 +70,7 @@ Parallel 3 : des5, after des3, 1d
 Parallel 4 : des6, after des4, 1d
  </pre></td>
  <td align="center">
- <img src="./img/gray-gantt.png" />
+ <img src="https://raw.githubusercontent.com/mermaid-js/mermaid/master/img/gray-gantt.png" />
  </td>
 </tr>
 <!-- </Gantt> -->
@@ -99,7 +99,7 @@ class Class10 {
 }
 </pre></td>
  <td align="center">
- <img src="./img/gray-class.png" />
+ <img src="https://raw.githubusercontent.com/mermaid-js/mermaid/master/img/gray-class.png" />
  </td>
 </tr>
 <!-- </Class> -->
@@ -119,7 +119,7 @@ Moving --> Crash
 Crash --> [*]
 </pre></td>
  <td align="center">
- <img src="./img/gray-state.png" />
+ <img src="https://raw.githubusercontent.com/mermaid-js/mermaid/master/img/gray-state.png" />
  </td>
 </tr>
 <!-- </State> -->
@@ -136,7 +136,7 @@ pie
 "Rats" : 15 
 </pre></td>
  <td align="center">
- <img src="./img/gray-pie.png" />
+ <img src="https://raw.githubusercontent.com/mermaid-js/mermaid/master/img/gray-pie.png" />
  </td>
 </tr>
 <!-- </Pie> -->

babel.config.js

@@ -3,9 +3,7 @@ module.exports = {
  [
  '@babel/preset-env',
  {
- targets: {
- node: 'current'
- }
+ targets: "defaults, ie >= 11, current node"
  }
  ]
  ]

cypress/helpers/util.js

@@ -26,3 +26,9 @@ export const imgSnapshotTest = (graphStr, options, api) => {
  cy.get('svg');
  cy.percySnapshot();
 };
+
+export const renderGraph = (graphStr, options, api) => {
+ const url = mermaidUrl(graphStr, options, api);
+
+ cy.visit(url);
+};

cypress/integration/other/configuration.spec.js

@@ -0,0 +1,100 @@
+import { renderGraph } from '../../helpers/util';
+/* eslint-env jest */
+describe('Configuration', () => {
+ describe('arrowMarkerAbsolute', () => {
+ it('should handle default value false of arrowMarkerAbsolute', () => {
+ renderGraph(
+ `graph TD
+ A[Christmas] -->|Get money| B(Go shopping)
+ B --> C{Let me think}
+ C -->|One| D[Laptop]
+ C -->|Two| E[iPhone]
+ C -->|Three| F[fa:fa-car Car]
+ `,
+ { }
+ );
+
+ // Check the marker-end property to make sure it is properly set to
+ // start with #
+ cy.get('.edgePath path').first().should('have.attr', 'marker-end')
+ .should('exist')
+ .and('include', 'url(#');
+ });
+ it('should handle default value false of arrowMarkerAbsolute', () => {
+ renderGraph(
+ `graph TD
+ A[Christmas] -->|Get money| B(Go shopping)
+ B --> C{Let me think}
+ C -->|One| D[Laptop]
+ C -->|Two| E[iPhone]
+ C -->|Three| F[fa:fa-car Car]
+ `,
+ { }
+ );
+
+ // Check the marker-end property to make sure it is properly set to
+ // start with #
+ cy.get('.edgePath path').first().should('have.attr', 'marker-end')
+ .should('exist')
+ .and('include', 'url(#');
+ });
+ it('should handle arrowMarkerAbsolute excplicitly set to false', () => {
+ renderGraph(
+ `graph TD
+ A[Christmas] -->|Get money| B(Go shopping)
+ B --> C{Let me think}
+ C -->|One| D[Laptop]
+ C -->|Two| E[iPhone]
+ C -->|Three| F[fa:fa-car Car]
+ `,
+ {
+ arrowMarkerAbsolute: false
+ }
+ );
+
+ // Check the marker-end property to make sure it is properly set to
+ // start with #
+ cy.get('.edgePath path').first().should('have.attr', 'marker-end')
+ .should('exist')
+ .and('include', 'url(#');
+ });
+ it('should handle arrowMarkerAbsolute excplicitly set to "false" as false', () => {
+ renderGraph(
+ `graph TD
+ A[Christmas] -->|Get money| B(Go shopping)
+ B --> C{Let me think}
+ C -->|One| D[Laptop]
+ C -->|Two| E[iPhone]
+ C -->|Three| F[fa:fa-car Car]
+ `,
+ {
+ arrowMarkerAbsolute: "false"
+ }
+ );
+
+ // Check the marker-end property to make sure it is properly set to
+ // start with #
+ cy.get('.edgePath path').first().should('have.attr', 'marker-end')
+ .should('exist')
+ .and('include', 'url(#');
+ });
+ it('should handle arrowMarkerAbsolute set to true', () => {
+ renderGraph(
+ `graph TD
+ A[Christmas] -->|Get money| B(Go shopping)
+ B --> C{Let me think}
+ C -->|One| D[Laptop]
+ C -->|Two| E[iPhone]
+ C -->|Three| F[fa:fa-car Car]
+ `,
+ {
+ arrowMarkerAbsolute: true
+ }
+ );
+
+ cy.get('.edgePath path').first().should('have.attr', 'marker-end')
+ .should('exist')
+ .and('include', 'url(http://localhost');
+ });
+ });
+});