Proposal: change default snapshot filename (~breaking)

Ouverte
#26 1 commentaire 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
52/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Calme
Stack technique
node.js

Piste de recherche

Read the snapshot implementation linked as nodejs-loaders/…/test/snapshots.mjs and trace how the default filename is generated and existing files are read. The change is complete when new snapshots use the .snap.cjs name and the proposed handling of old .snapshot files is covered without breaking existing tests.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Problem(s) to solve

The current default value of a snapshot filename is to append .snapshot to the name of generating file (aka a "test file"). For instance foo.test.js → foo.test.js.snapshot.

This breaks any IDE trying to help with the file.

A snapshot file is actually a CJS file.

Proposed solution(s)

Adjust the default filename to ${TEST_FILE_BASENAME}.snap.cjs (see nodejs-loaders/…/test/snapshots.ts).

Ex foo.test.js → foo.test.snap.cjs

IDEs recognise this and render the snapshot file as the CJS that it actually is.


We can mitigate a breaking change by detecting the old on read and renaming the file on disk whilst also outputting a message to the console.

Langage dominant
Aucune donnée de langage
Étoiles
3
Forks
4
Métriques de merge des PR
Aucune PR mergée en 30 j

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de nodejs/test-runner

Toutes les issues de nodejs/test-runner

Issues similaires

Plus d'issues DevTools

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.