Gathering detailed insights and metrics for @swimlane/cy-dom-diff
Gathering detailed insights and metrics for @swimlane/cy-dom-diff
Allows matching chunks of DOM against HTML; including dynamic content.
Installations
npm install @swimlane/cy-dom-diffDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
12.15.0
NPM Version
6.13.4
Releases
4
Languages
3
TypeScript
JavaScript
HTML
TypeScript (66.19%)
JavaScript (27.81%)
HTML (6%)
Developer
swimlane
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
9 Stars
45 Commits
1 Forks
3 Watchers
1 Branches
7 Contributors
Updated on Mar 15, 2022
Maintainers
14
Package Meta Information
Latest Version
2.0.0
Package Id
@swimlane/cy-dom-diff@2.0.0
Size
4.55 kB
NPM Version
6.13.4
Node Version
12.15.0
Published on
Feb 02, 2021
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
2
Peer Dependencies
1
Dev Dependencies
20
cy-dom-diff
cy-dom-diff allows matching chunks of DOM against HTML; including dynamic content.
Introduction
cy-dom-diff consist of two parts. First is a Cypress command that matches a DOM element against a regular expression. When a DOM element is matched its HTML is normalized to produce consistent diffable output while maintaining sematic meaning. This includes:
- whitespace and newlines are normalized
- tags and attributes are printed on individual lines
- comments are removed
- tags and attributes can be ignored through configuration
In the second part cy-dom-diff provides a template function to generate a regular expression from a HTML string. This HTML string is passed through the same normalization as the DOM element (described above) as well as allowing embedded regular expression for dynamic content.
Installation and Setup
1npm install --save-dev @swimlane/cy-dom-diff
Import the Cypress commands in cypress/support/index.js or cypress/support/commands.js
1import '@swimlane/cy-dom-diff/commands';
Usage
In a basic example the following will assert that the element matches the regexp generated by the dom template tag. Most of the HTML string within the tagged template string is treated literally. However, regular expressions within the embedded expression are matches as expected.
1import { dom } from '@swimlane/cy-dom-diff'; 2 3const TIME = /\d?\d:\d?\d\:\d?\d/; 4const NUMBER = /[\+\-]?\d*\.?\d+(?:[Ee][\+\-]?\d+)?/; 5 6cy.get('#clock').domMatch(dom` 7 <span>The current time is:</span> 8 <span class="clock">${TIME} ${/[AP]/}M</span> 9 <span class="offset">${NUMBER}</span> hrs 10 `);
cy.domMatch Cypress command
cy.domMatch will run the domMatch assertions (see below) and add a Cypress runner log with a diff.
cy.domDiff Cypress command
cy.domDiff is used in the same way as cy.domMatch but will only add a Cypress runner log with a diff. It will not fail if the DOM does not match and will not retry.
domMatch Chai assertion
At its lowest level cy-dom-diff adds a Chai assertion for matching the DOM. This will not generate a Cypress log except to show that the assertion passed or failed. Use cy.domMatch to get better logging.
1import { dom } from '@swimlane/cy-dom-diff'; 2 3const TIME = /\d?\d:\d?\d\:\d?\d/; 4const NUMBER = /[\+\-]?\d*\.?\d+(?:[Ee][\+\-]?\d+)?/; 5 6cy.get('#clock').should('domMatch', dom` 7 <span>The current time is:</span> 8 <span class="clock">${TIME} ${/[AP]/}M</span> 9 <span class="offset">${NUMBER}</span> hrs 10`); 11 12// OR 13 14cy.get('#clock').then($el => { 15 expect($el).to.domMatch(dom` 16 <span>The current time is:</span> 17 <span class="clock">${TIME} ${/[AP]/}M</span> 18 <span class="offset">${NUMBER}</span> hrs 19 `); 20});
Credits
cy-dom-diff is a Swimlane open-source project; we believe in giving back to the open-source community by sharing some of the projects we build for our application. Swimlane is an automated cyber security operations and incident response platform that enables cyber security teams to leverage threat intelligence, speed up incident response and automate security operations.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
dependency not pinned by hash detected -- score normalized to 4
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/swimlane/cy-dom-diff/lint.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/lint.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/swimlane/cy-dom-diff/lint.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/swimlane/cy-dom-diff/test.yml/main?enable=pin
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
- Info: 1 out of 1 npmCommand dependencies pinned
Reason
Found 0/21 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/lint.yml:1
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
license file not detected
Details
- Warn: project does not have a license file
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 10 are checked with a SAST tool
Reason
33 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-x55w-vjjp-222r
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4
- Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g
- Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
- Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
- Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-w5p7-h5w8-2hfq
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Score
2.4
/10
Last Scanned on 2025-06-30
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More