Proposal: change default snapshot filename (~breaking)
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 52/100
- Tipo de issue
- Funcionalidade
- Clareza
- Razoavelmente clara
- Status de atividade
- Pouca atividade
- Stack de tecnologia
- node.js
- Domínio
- developer-experience, testing
Direção de pesquisa
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.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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.
- Linguagem predominante
- Sem dados de linguagem
- Estrelas
- 3
- Forks
- 4
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Sem modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de nodejs/test-runner
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 1/100
nodejs/test-runner#46 ·
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 5/100
nodejs/test-runner#45 ·
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 10/100
nodejs/test-runner#44 ·
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 15/100
nodejs/test-runner#43 ·
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 15/100
nodejs/test-runner#42 ·
Todas as issues de nodejs/test-runner
Issues semelhantes
-
diagram-bug good first issue help wanted
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
enhapu-afk/omaspec#4 ·
-
ready-for-agent
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
LucasSantana-Dev/Lucky#2945 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 62/100
earthtojake/text-to-cad#758 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
colbymchenry/codegraph#3223 ·
Mantenedores costumam responder em até 1 dia
-
good first issue
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 85/100
r-afael/better-yt-recommendations#36 ·
Mantenedores costumam responder em até 1 dia