feat(rule-tester): add support for snapshot testing rules#6994

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Closed

bradzacher wants to merge2 commits intomainfromv6-rule-tester-snapshots

Closed

feat(rule-tester): add support for snapshot testing rules#6994

bradzacher wants to merge2 commits intomainfromv6-rule-tester-snapshots

Conversation

Copy link

Member

bradzacher commentedMay 6, 2023•
edited
Loading

PR Checklist

Addresses an existing open issue: fixesEnhancement: snapshot testing for lint rule failures #6499
That issue was marked asaccepting prs
Steps inContributing were taken

Overview

This PR adds support for snapshot testing rules using a custom, framework agnostic snapshot setup.

The snapshot emits two files for each.run call - a markdown file which is the human-readable results of the test, and a binary file which is a compressed json blob containing the machine-readable snapshot information.

I've done a test migration of our codebase here:https://github.com/typescript-eslint/typescript-eslint/tree/v6-rule-tester-snapshots-migrate-codebase

TODO:

finalise snapshot format
add docs
add a version field so we can do breaking changes to the snapshot object format?
add tests to validate it works as intended
usefilenamify to ensure test names are valid filenames

feat(rule-tester): add support for snapshot testing rules

33f4193

bradzacher added enhancement

New feature or request

DO NOT MERGEPRs which should not be merged yet labels

May 6, 2023

Copy link

Contributor

typescript-eslintbot commentedMay 6, 2023

Thanks for the PR,@bradzacher!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

Copy link

netlifybot commentedMay 6, 2023•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`ebc8745`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6455d2f746082900089aad22
😎 Deploy Preview	https://deploy-preview-6994--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to yourNetlify site settings.

Copy link

nx-cloudbot commentedMay 6, 2023•
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commitebc8745. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch