Introducing TypeScript #3336

sidharthv96 · 2022-08-21T03:11:27Z

📑 Summary

Gradual introduction of typescript.

Feels like this is big enough now. Rest can be done incrementally.

TODO:

Discuss all TODO Q:
Fix all TODO:
Add typings to package
Create a similar PR to remove typings from DT. https://github.com/DefinitelyTyped/DefinitelyTyped/pull/61387/files

📋 Tasks

Make sure you

📖 have read the contribution guidelines
💻 have added unit/e2e tests (if appropriate)
🔖 targeted develop branch

src/diagrams/common/common.ts

+      window.location.search;
+    // TODO Q: Why is this necessary?
+    url = url.replaceAll(/\(/g, '\\(');
+    url = url.replaceAll(/\)/g, '\\)');


sidharthv96 · 2022-08-21T06:18:23Z

src/diagrams/common/common.ts

+ * @returns {string} The safer text
+ */
+export const removeScript = (txt: string): string => {
+  return DOMPurify.sanitize(txt);


@knsv The old code was throwing multiple github codescanner issues.
DOMPurify passed all tests, and we're able to remove a lot of custom logic.

Yes we are applying DOMPurify at the end now which makes this redundant.

So, the previous logic was to remove script based on level.

But now, we just sanitize it regardless of level. Wouldn't that remove scripts the user actually wants?

src/diagrams/common/common.ts

src/diagrams/common/common.spec.js

sidharthv96 · 2022-08-21T07:08:55Z

src/@types/config.d.ts

+// TODO: More configs needs to be moved in here
+export interface BaseDiagramConfig extends BaseDiagramConfig {
+  useWidth?: number;
+  useMaxWidth?: boolean;
+}


@knsv we should move all the common configs that diagrams share here.

Can you help figure out what the eligible configs are?

sidharthv96 · 2022-08-21T07:12:35Z

src/diagrams/common/common.ts

+
+const sanitizeMore = (text: string, config: MermaidConfig) => {
+  // TODO Q: Should this check really be here? Feels like we should be sanitizing it regardless.
+  if (config.flowchart?.htmlLabels !== false) {


htmlLabels should be moved up from flowchart to config.
Will make this a separate issue and handle it there.

Yes, we have several of those. When we change them we need to keep track of them perhaps we can make compatibility mode for easy upgrade.

We can skip the check. But a warning, sometimes we get too rigid like brs in tool tips showing as the tag instead of a new line.

* develop: Fix #3009 Update main #3243 Adding disabled testcase for diagram with leading \n

knsv

This looks good! A great step forward! Good job!

… into sidv/typescript * 'sidv/typescript' of https://github.com/mermaid-js/mermaid: Update src/config.ts

sidharthv96

Marking all TODO Qs.

src/mermaidAPI.ts

src/styles.ts

src/diagram-api/diagramAPI.spec.ts

src/diagrams/common/common.ts

* develop: (22 commits) Fix for build by revering jsdoc Revert "chore(deps-dev): bump documentation from 13.2.0 to 14.0.0" Review comments. Add test for handling parameter names that are "default" Add test for handling parameter names that are keywords Add test for handling trailing whitespaces Add first C4 parser test chore(deps-dev): bump eslint-plugin-jest from 26.8.2 to 26.8.7 chore(deps-dev): bump documentation from 13.2.0 to 14.0.0 chore(deps-dev): bump terser-webpack-plugin from 5.3.4 to 5.3.5 chore(deps-dev): bump prettier-plugin-jsdoc from 0.3.38 to 0.4.1 test(e2e): add array and generic attributes erDiagram test test(common): add generic parser test test(parser): add tests for generics and arrays in erDiagram feat: add array and generic symbols for erDiagram Lint markdown Fix prettier formatting in vscode Prettier Fix `securityLevel` docs Update README.md ...

Yash-Singh1

Overall LGTM, I found a few @ts-ignores so I left a few reviews on how we could use some other workaround typescript errors because @ts-ignore can cause problems if we break some other part of that line.

src/config.ts

src/Diagram.ts

src/errorRenderer.ts

src/mermaid.ts

src/diagrams/mindmap/mindamapDetector.ts

src/diagrams/git/gitGraphDetector.ts

src/diagrams/common/common.ts

sidharthv96 · 2022-08-25T16:05:22Z

Overall LGTM, I found a few @ts-ignores so I left a few reviews on how we could use some other workaround typescript errors because @ts-ignore can cause problems if we break some other part of that line.

Thanks for help @Yash-Singh1!
I was planning to address the @ts-ignores and @ts-nochecks separately once we merge this in.
Will push the suggested changes now 😄

Co-authored-by: Yash Singh <saiansh2525@gmail.com>

* develop: chore(deps-dev): bump @commitlint/cli from 17.0.3 to 17.1.1 (#3376) chore(deps-dev): bump eslint from 8.22.0 to 8.23.0 (#3378) chore(deps): bump dompurify from 2.3.10 to 2.4.0 (#3375) chore(deps-dev): bump @commitlint/config-conventional (#3370) chore(deps-dev): bump @babel/core from 7.18.10 to 7.18.13 (#3373) chore(deps-dev): bump eslint-plugin-jest from 26.8.7 to 27.0.1 (#3372) chore(deps-dev): bump jest-environment-jsdom from 28.1.3 to 29.0.1 (#3369) chore(deps-dev): bump babel-jest from 28.1.3 to 29.0.1 (#3368) Updating docs to latest mermaid version build: add eslint --cache file Adjusting size and test Updated viewBox settings Border feat(git): allow custom merge commit ids Document line curve options Added 'ms' duration Fix font weight for messages in sequence diagrams Added lollipop feature for updated codebase

* develop: Update dependabot.yml

* develop: chore(deps-dev): bump @commitlint/cli from 17.1.1 to 17.1.2 chore(deps-dev): bump terser-webpack-plugin from 5.3.5 to 5.3.6 chore(deps-dev): bump webpack-dev-server from 4.10.0 to 4.10.1 Fix gitGraph findLane function error Replacing replaceAll with replace Rework 'parseDuration' as a pure duration parsing Supports duration in decimal Create a more consistent 'parseDuration' Fix svgDraw return types Add more tests Fix nested types Fix nested types Add nested test Updating to version to 9.1.6

@param

* develop: (67 commits) fix: Tsconfig Update prettier chore: Run postbuild with prepare (formatting) prettier fix Removed warnings in the grammar oand some console logging ci: lint .jison files for any console.log() fix JSDOC @param, @returns; fixed a few minor typos in comments unmangle sentence about doc changes committed and showing up on docsify site change references from /docs to /src/docs; rework doc section in CONTRIBUTING Update after lint comments Regenerate the directive docs as I changed them chore(deps-dev): bump typescript from 4.7.4 to 4.8.2 Update duplicate copy pasted directive description chore(deps-dev): bump @types/dompurify from 2.3.3 to 2.3.4 chore(deps-dev): bump jest-environment-jsdom from 29.0.1 to 29.0.2 chore(deps-dev): bump babel-jest from 29.0.1 to 29.0.2 Lint fixes Removing requirement to add ids for nodes with a shape #3336 Merged typescript changes Merged typescript changes ...

slorber · 2022-11-02T15:35:44Z

package.json

  "exports": {
    ".": {
      "require": "./dist/mermaid.min.js",
-      "import": "./dist/mermaid.esm.min.mjs"
+      "import": "./dist/mermaid.esm.min.mjs",
+      "types": "./dist/mermaid.d.ts"


wonder if this line isn't causing troubles, see #3747

sidharthv96 added 10 commits August 20, 2022 23:40

Typescript init

88e17bf

tsConversion: DetectType

95dbbb3

tsConversion: errorRenderer

c9cd569

tsConversion: logger

896154d

tsConversion: flowchartStyles

fab9688

Add trace logLevel

d9bace0

tsConversion: styles

238cbd1

Add trace logLevel

6de66ea

tsConversion: config & common

f14f0d9

fix: sanitization bug

4710f67

github-advanced-security bot found potential problems Aug 21, 2022

View reviewed changes

src/diagrams/common/common.ts Fixed Show fixed Hide fixed

src/diagrams/common/common.ts Fixed Show fixed Hide fixed

fix: codeScanning vuln

cd4b1ea

github-advanced-security bot found potential problems Aug 21, 2022

View reviewed changes

sidharthv96 marked this pull request as ready for review August 21, 2022 06:51

sidharthv96 commented Aug 21, 2022

View reviewed changes

sidharthv96 requested review from knsv, mmorel-35, Yash-Singh1 and ashishjain0512 August 21, 2022 06:55

sidharthv96 self-assigned this Aug 21, 2022

sidharthv96 commented Aug 21, 2022

View reviewed changes

sidharthv96 mentioned this pull request Aug 21, 2022

htmlLabels should be moved up from flowchart to config. #3337

Closed

tsConversion: mermaid main

c68ec54

sidharthv96 mentioned this pull request Aug 21, 2022

Pending improvements - Tracker #3340

Open

15 tasks

sidharthv96 added 5 commits August 21, 2022 19:24

Merge branch 'develop' into sidv/typescript

a51d8e8

* develop: Fix #3009 Update main #3243 Adding disabled testcase for diagram with leading \n

fix: startOnLoad

d97b380

tsConversion: fix paths, add d.ts to output

39aaf2f

tsConversion: mermaidAPI

d365dac

tsConversion: rename DiagramAPI

c245a2d

knsv approved these changes Aug 22, 2022

View reviewed changes

mmorel-35 approved these changes Aug 22, 2022

View reviewed changes

sidharthv96 added 2 commits August 23, 2022 21:35

Remove console.logs

32ba2d5

Merge branch 'sidv/typescript' of https://github.com/mermaid-js/mermaid…

a8042f6

… into sidv/typescript * 'sidv/typescript' of https://github.com/mermaid-js/mermaid: Update src/config.ts

sidharthv96 commented Aug 24, 2022

View reviewed changes

sidharthv96 added 3 commits August 24, 2022 11:32

Cleanup

1efd5c7

Remove failing test

84148d4

Yash-Singh1 requested changes Aug 24, 2022

View reviewed changes

sidharthv96 mentioned this pull request Aug 25, 2022

Add nested test for parseGenericTypes #3354

Merged

3 tasks

Yash-Singh1 reviewed Aug 25, 2022

View reviewed changes

src/diagrams/mindmap/mindamapDetector.ts Outdated Show resolved Hide resolved

src/diagrams/git/gitGraphDetector.ts Outdated Show resolved Hide resolved

src/diagrams/common/common.ts Outdated Show resolved Hide resolved

sidharthv96 and others added 2 commits August 25, 2022 21:53

Remove @ts-ignores.

a3dfc4c

Co-authored-by: Yash Singh <saiansh2525@gmail.com>

mmorel-35 approved these changes Aug 31, 2022

View reviewed changes

sidharthv96 added 7 commits September 1, 2022 18:40

Fix TODO Qs

8c85c10

Merge branch 'develop' into sidv/typescript

4619ff2

* develop: Update dependabot.yml

Revert flowchart change

36be811

Revert flowchart change

4fa0d36

Fix repo URL

2272eb6

Typo fix

1ced01c

knsv merged commit 5597cf4 into develop Sep 1, 2022

sidharthv96 added this to the 9.2.0 milestone Sep 2, 2022

knsv added a commit that referenced this pull request Sep 5, 2022

#3336 Merged typescript changes

8b4a08e

slorber reviewed Nov 2, 2022

View reviewed changes

This was referenced Feb 21, 2023

fix(deps): update dependency mermaid to v10 trussworks/Engineering-Playbook#329

Merged

fix(deps): update dependency mermaid to v10 uiwjs/react-md-editor#485

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introducing TypeScript #3336

Introducing TypeScript #3336

sidharthv96 commented Aug 21, 2022 •

edited

Loading

sidharthv96 Aug 21, 2022

knsv Aug 22, 2022

sidharthv96 Aug 24, 2022

sidharthv96 Aug 21, 2022

knsv Aug 21, 2022

sidharthv96 Aug 22, 2022

sidharthv96 Aug 21, 2022

knsv Aug 22, 2022

knsv Aug 22, 2022

knsv left a comment

sidharthv96 left a comment

Yash-Singh1 left a comment

sidharthv96 commented Aug 25, 2022

slorber Nov 2, 2022

Introducing TypeScript #3336

Introducing TypeScript #3336

Conversation

sidharthv96 commented Aug 21, 2022 • edited Loading

📑 Summary

📋 Tasks

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

knsv left a comment

Choose a reason for hiding this comment

sidharthv96 left a comment

Choose a reason for hiding this comment

Yash-Singh1 left a comment

Choose a reason for hiding this comment

sidharthv96 commented Aug 25, 2022

Choose a reason for hiding this comment

sidharthv96 commented Aug 21, 2022 •

edited

Loading