Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix eslint error @typescript-eslint/no-base-to-string in common.ts #6115

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

Shahir-47
Copy link

📑 Summary

This PR fixes the eslint error @typescript-eslint/no-base-to-string caused by the use of .toString() in the file /packages/mermaid/src/diagrams/common/common.ts on line 86. The error prevented pnpm test from running successfully. The issue is resolved by explicitly converting the sanitized text to a string using the String() method.

Resolves #6113

📏 Design Decisions

  • Replaced the .toString() method with String() to explicitly convert the result of DOMPurify.sanitize to a string, adhering to the eslint rule @typescript-eslint/no-base-to-string.
  • This ensures that the object is safely converted without relying on the default stringification format ([object Object]), which was causing the issue.
  • No functionality changes were introduced; the fix only resolves the linting error.

📋 Tasks

Make sure you

  • 📖 have read the contribution guidelines
  • 💻 have added necessary unit/e2e tests.
  • 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
  • 🦋 If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Copy link

changeset-bot bot commented Dec 6, 2024

⚠️ No Changeset found

Latest commit: 3ee2598

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added the Type: Bug / Error Something isn't working or is incorrect label Dec 6, 2024
Copy link

netlify bot commented Dec 6, 2024

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 3ee2598
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/675ffd4a7809110008f16e7f
😎 Deploy Preview https://deploy-preview-6115--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

pkg-pr-new bot commented Dec 6, 2024

Open in Stackblitz

npm i https://pkg.pr.new/mermaid-js/mermaid@6115
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@6115
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@6115
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@6115

commit: 3ee2598

Copy link

codecov bot commented Dec 6, 2024

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 4.48%. Comparing base (df636c6) to head (3ee2598).

Files with missing lines Patch % Lines
packages/mermaid/src/diagrams/common/common.ts 0.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           develop   #6115   +/-   ##
=======================================
  Coverage     4.48%   4.48%           
=======================================
  Files          383     383           
  Lines        54038   54038           
  Branches       596     596           
=======================================
  Hits          2425    2425           
  Misses       51613   51613           
Flag Coverage Δ
unit 4.48% <0.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
packages/mermaid/src/diagrams/common/common.ts 53.01% <0.00%> (ø)

Copy link

argos-ci bot commented Dec 6, 2024

The latest updates on your projects. Learn more about Argos notifications ↗︎

Waiting for the first build to start…

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Bug / Error Something isn't working or is incorrect
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix eslint error @typescript-eslint/no-base-to-string causing test failures
1 participant