317 Commits

Author SHA1 Message Date
Sidharth Vinod
13ef403921
chore: Update dagre-d3-es 2022-11-21 08:16:15 +05:30
Sidharth Vinod
f687abb165
chore: Use graphlib from dagre-d3-es 2022-11-21 08:16:08 +05:30
Sidharth Vinod
931661ed67
fix: Add types to memoized functions 2022-11-21 08:13:44 +05:30
Sidharth Vinod
7d3a0577d2
chore: Replace lodash with lodash-es 2022-11-21 08:13:44 +05:30
Sidharth Vinod
4890999206
Merge branch 'sidv/viz' into sidv/dagre-es-viz
* sidv/viz:
  Fix Lodash import
  fix: Viz build
  feat: Add package visualization
  Ignore stats.html
  feat: Add bundle visualization
  style(docs): use `github-dark` hightlight theme
  refactor(docs): use default vitepress highlighter
  fix: Move redirection to router
  chore: Add docs to redirect.ts
  feat: Redirect old documentation links.
  comments in states are skipped now
  Remove extra arrow and adjust cross position
2022-11-21 08:13:43 +05:30
Sidharth Vinod
8a2d3a400c
Fix Lodash import 2022-11-20 19:12:52 +05:30
Alois Klink
fd76e0e270 chore: replace dagre/dagre-d3 with dagre-d3-es
Replace the dagre and dagre-d3 libraries with dagre-d3-es.

Both dagre and dagre-d3 are deprecated and unmaintained,
and haven't been updated for more than 3 years.

Since dagre-d3 still requires an old version of d3, this causes
a bunch of security warnings,
e.g. https://github.com/advisories/GHSA-36jr-mh4h-2g58

The [dagre-d3-es](https://github.com/tbo47/dagre-es) package is a fork
that contains support for `"d3": "^7.6.1"`. Also, it's ESM, so we will
hopefully get smaller bundle sizes too. The only issue is that this
fork isn't very well used (only has 3000 weekly downloads),
compared to `dagre-d3`'s 250,000 weekly downloads.

(although to be fair, a large proportion of dagre-d3's downloads
 probably come from mermaid)

Since it's is a less popular package,
**I've pinned `dagre-d3-es` to `"7.0.2"` instead of `"^7.0.2"`**.
This does mean if there is a bug in `dagre-d3-es`, we will have to
manually bump it ourselves, but it also means we won't accidentally
be sending a buggy version of `dagre-d3-es` out to users in cases
something changes (it might be worth disabling renovate for this
if we're feeling paranoid!)
2022-11-18 18:33:05 +00:00
Sidharth Vinod
09ed41b7d2
Merge pull request #3807 from aloisklink/docs/update-code-highlighting-theme
Use `github-dark` to highlight fence blocks in vitepress docs
2022-11-18 23:09:59 +05:30
pbrolin47
804a23595d
Merge pull request #3797 from mermaid-js/sidv/redirectOldDocs
feat: Redirect old documentation links.
2022-11-18 10:46:34 +01:00
Knut Sveidqvist
8655db371e
Merge pull request #3762 from avijit1258/bug/3728_comments_not_ignored_composite_states
comments in states are skipped now
2022-11-18 10:45:01 +01:00
Knut Sveidqvist
9b8d5c1b3b
Merge pull request #3641 from ishuen/bug/3637_extra_arrow
Remove extra arrow and adjust cross position
2022-11-18 10:38:57 +01:00
Alois Klink
c30aa6f9cf
style(docs): use github-dark hightlight theme
Use the `github-dark` highlight theme for fence blocks in vitepress,
instead of the default `material-palenight` theme.

This increases the contrast ratio of `#comments` from 2.75:1 to 4.43:1,
which is a lot more visible.

It still doesn't reach WCAG 2.0 level AA contrast standards,
which requires 4.5:1 as a minimum constrast ratio, but 4.43:1 is
pretty close, and we don't need to manually modify the theme's colours.
2022-11-17 19:05:41 +00:00
Alois Klink
6da6edfc01
refactor(docs): use default vitepress highlighter
Use the default vitepress highlighter instead of making our own
highlighter using shiki.

The benefits are:
  - We don't need to directly depend on shiki
  - `mermaid-example` code-blocks will use the same highlighting
    as other languages (e.g. `html`/`js`).
  - We can control the theme from the global `vitepress` config.
  - Darkmode/lightmode themes are supported
  - Escaping is already handled by the default highlight function
2022-11-17 19:05:38 +00:00
Sidharth Vinod
461236030c
Merge pull request #3798 from weedySeaDragon/bug/1952-stateDiagram--classDef-fix-classes-type
bug: State diagram  fix classes type
2022-11-17 22:01:09 +05:30
Sidharth Vinod
b83ba4d293
fix: Move redirection to router 2022-11-17 11:14:15 +05:30
Alois Klink
476917bda9 Revert "chore(deps): pin dependencies"
This reverts commit 17b72d565de595c94c1e339da37fc81676c4b200.
2022-11-16 20:00:16 +00:00
Ashley Engelund (weedySeaDragon @ github)
717aca6824 change shiki getHighlighter import 2022-11-15 13:09:16 -08:00
Ashley Engelund (weedySeaDragon @ github)
2cbf6110a6 create separate spec for stateRenderer-v2 2022-11-15 12:30:10 -08:00
Ashley Engelund (weedySeaDragon @ github)
fcec9adbcd diagramStates should not be global; pass it into functions; minor comment fixes 2022-11-15 09:19:27 -08:00
Ashley Engelund (weedySeaDragon @ github)
13f3008f82 diagramClasses no longer needs to be cached; mermaidAPI no longer calls it repeatedly 2022-11-15 09:18:10 -08:00
Ashley Engelund (weedySeaDragon @ github)
6090a1f65a (minor) import expectTypeOf in spec 2022-11-15 09:14:00 -08:00
Ashley Engelund (weedySeaDragon @ github)
1ecd4a551d (minor) fix JSdoc tag 2022-11-15 09:13:27 -08:00
Ashley Engelund (weedySeaDragon @ github)
c6db0524bd + spec stateRenderer-v2.js getClasses() to verify it returns a {} 2022-11-15 09:01:34 -08:00
Ashley Engelund (weedySeaDragon @ github)
d3f5474f38 (minor) fix JSdoc types in comments 2022-11-15 08:59:01 -08:00
Ashley Engelund (weedySeaDragon @ github)
9996e53e24 (minor) add comments, remove duplicated line 2022-11-15 08:50:20 -08:00
Knut Sveidqvist
3b79ee35e0
Merge pull request #3780 from mermaid-js/sidv/mergeMaster
chore: Merge master to develop
2022-11-15 12:47:32 +01:00
Sidharth Vinod
b202b539bf
Merge pull request #3765 from spier/feature/check-links-in-docs
Add GHA that will check links + Fix broken links
2022-11-15 14:17:18 +05:30
Sidharth Vinod
18c27c6f1d
chore: Add docs to redirect.ts 2022-11-15 11:13:54 +05:30
Ashley Engelund (weedySeaDragon @ github)
345eaade22 stateDB classes must be a {} not [] 2022-11-14 11:39:58 -08:00
Sidharth Vinod
82f63b056f
feat: Redirect old documentation links. 2022-11-15 01:06:04 +05:30
Ashley Engelund (weedySeaDragon @ github)
ccd55a0bde add stateDiagram-v2 to list of graphs with classDefs 2022-11-14 11:24:59 -08:00
Sidharth Vinod
846a03663c
fix(docs): ClassDiagram table 2022-11-14 22:15:34 +05:30
Sidharth Vinod
eae88c51d2
Cleanup 2022-11-14 16:42:08 +05:30
Sidharth Vinod
051b4271d3
Cleanup docs 2022-11-14 15:24:47 +05:30
Sidharth Vinod
4decaf0308
chore: Fix tsdoc 2022-11-14 15:17:13 +05:30
Sidharth Vinod
9144fa390f
cleanup 2022-11-14 15:05:58 +05:30
Sidharth Vinod
77a326dedf
Merge Master 2022-11-14 14:51:23 +05:30
Sidharth Vinod
2d9bdedaf5
Merge branch 'develop' into sidv/mergeMaster
* develop:
  chore(deps): update all non-major dependencies
  fix(deps): update all non-major dependencies
  fix: `sourceLinkTemplate` in typedoc
  only call getClasses if the diagram renderer supports it
  fix typo
  merge fix: get classDefs only if diagram is in CLASSDEF_DIAGRAMS
  use lodash isEmpty instead of method defined in utils
  chore: Fix cspell
  fix: Type of DiagramStyleClassDef, general cleanup
  change spec descriptions to active voice (= shorter b/c 'should' isn't needed)
  functions and specs: removeExistingElements
  functions and specs: createUserstyles; minor changes
  functions and specs: createCssStyles, appendDivSvgG,cleanUpSvgCode, putIntoIFrame [for render]
  add MockedD3.ts
  const isSandboxed, isLooseSecurityLevel, fontFamily; a few more CONSTs
  more meaningful var names; move related lines together; const idSelector
  comment the main steps (prepare to break into functions that can be tested)
  render: define const iFrameId, enclosingDivID and _selector to use in function
  specs: encodeEntities, decodeEntities
  render: constants
2022-11-14 13:57:09 +05:30
Sidharth Vinod
0763590c24
Merge pull request #3791 from mermaid-js/renovate/all-minor-patch
chore(deps): update all non-major dependencies (minor)
2022-11-14 13:18:10 +05:30
Knut Sveidqvist
dfb1440ae0
Merge pull request #3684 from weedySeaDragon/chore/3648-mermaidAPI-render--dry-cleanup-specs
chore: clean up code in mermaidAPI render() and write specs/tests
2022-11-14 08:42:25 +01:00
renovate[bot]
a1e2df8466
chore(deps): update all non-major dependencies 2022-11-14 05:28:23 +00:00
renovate[bot]
20613beb8a fix(deps): update all non-major dependencies 2022-11-14 05:25:07 +00:00
Sidharth Vinod
a83f88bdf1
chore: Merge master to develop 2022-11-10 13:51:53 +05:30
Sidharth Vinod
791dbe01a2
fix: sourceLinkTemplate in typedoc 2022-11-09 23:48:26 +05:30
Ashley Engelund (weedySeaDragon @ github)
750029f557 merge MERMAID/develop 2022-11-09 07:45:22 -08:00
Sebastian Spier
6543ece92c Fix display label/path for explaining where the docs are located 2022-11-08 13:53:18 +01:00
Sebastian Spier
013ff182c9 Run Prettier 2022-11-07 20:35:00 +01:00
Sebastian Spier
b5d335711f Fixing link to d3 time formatting 2022-11-07 20:23:24 +01:00
Sebastian Spier
5e41b68a3a Remove link to chrome web store app that doesn't exist any more 2022-11-07 17:46:26 +01:00
Sebastian Spier
3b901c4459 More consistent linking: Use the full filename README.md (in config/setup) 2022-11-07 17:00:54 +01:00