Cucumber-js: Suporte a módulo JS nativo em definições de etapas e código de suporte

Eu gostaria de fazer o cucumber-js trabalhar com o ESM. Já tínhamos algumas outras questões abertas sobre isso.

Poderíamos fazer uma opção CLI (ou usar alguma outra maneira de procurar quando utilizá-la) que faz o cucumber-js usar import vez de exigir e esperar pela promessa retornada.

Dado o exemplo que você adicionou, poderíamos adicionar um caso de teste especificamente para isso e trabalhar para torná-lo aprovado. Experimentando a troca de exigir a importação e aguardando a promessa, encontrei outro erro:

⋊> ~/p/test ./node_modules/.bin/cucumber-js                                21:05:22
(node:7422) ExperimentalWarning: The ESM module loader is experimental.
file:///test/features/steps.js:1
import { Given } from "cucumber";
         ^^^^^
SyntaxError: The requested module 'cucumber' does not provide an export named 'Given'
    at ModuleJob._instantiate (internal/modules/esm/module_job.js:92:21)
    at async ModuleJob.run (internal/modules/esm/module_job.js:107:20)
    at async Loader.import (internal/modules/esm/loader.js:176:24)
    at async Promise.all (index 0)
    at async Cli.getSupportCodeLibrary (/test/node_modules/cucumber/lib/cli/index.js:119:5)
    at async Cli.run (/test/node_modules/cucumber/lib/cli/index.js:141:32)
    at async Object.run [as default] (/test/node_modules/cucumber/lib/cli/run.js:30:14)

Peguei o exemplo (ligeiramente modificado) da documentação de definição de etapa, mas você está certo, não funcionará como está escrito. Como Cucumber.js é um módulo CommonJS, ele fornece apenas uma exportação padrão. No curto prazo, eu provavelmente apenas importaria o padrão do módulo e, em seguida, acessaria os métodos Dado / Quando / Então a partir dele:

import cucumber from "cucumber";

cucumber.Given(...);

A longo prazo, seria bom se o Cucumber tivesse pontos de entrada separados para importar e exigir, como mostrado aqui .

Obrigado por olhar para isso. Pelo que vale a pena, uma opção CLI para dizer ao Cucumber para importar em vez de exigir seria adequado para mim. Também seria ótimo se Cucumber procurasse arquivos de suporte com extensões .cjs e .mjs e os tratasse automaticamente como CommonJS e módulos nativos, respectivamente.

EDITAR: só quero reiterar que estou feliz em ajudar com tudo isso, se puder; apenas me aponte na direção certa.

Eu provavelmente apenas importaria o padrão do módulo e, em seguida, acessaria os métodos Dado / Quando / Então a partir dele:
importe pepino de "pepino";
pepino.Dado (...);

Isso não funciona. Eu recebo a mesma mensagem.
Eu tenho "type": "module" no package.json e o resto do meu projeto está usando módulos, então mudar isso não é uma opção.

Se eu usar um destes:

import cucumber from '@cucumber/cucumber';
// OR
import { When } from '@cucumber/cucumber';

Recebo a mesma mensagem de erro da postagem original.
Se eu mudar para

const cucumber = require('@cucumber/cucumber');

Então eu recebo esta mensagem:

Em vez disso, renomeie /some/path/cucumbertest/features/step_definitions.js para terminar em .cjs, altere o código necessário para usar import () ou remova "type": "module" de project / package.json.

Se eu renomear step_definitions.js para _either_ step_definitions.cjs ou step_definitions.mjs , ele simplesmente será ignorado e recebo mensagens genéricas do pepino dizendo para criar stubs para minhas etapas:

UUUUUU

Failures:

1) Scenario: Empty Payload # spec\cucumber\features\users\create\main.feature:4
   ? When the client creates a POST request to /users
       Undefined. Implement with the following snippet:

         When('the client creates a POST request to \/users', function () {
           // Write code here that turns the phrase above into concrete actions
           return 'pending';
         });

... etc

Eu recebo exatamente as mesmas mensagens se excluir o arquivo completamente, então ele está claramente sendo ignorado.

Solução (mais ou menos)

No final, a única maneira de fazer o pepino funcionar em um projeto com "type": "module" é criar um specpackage.json separado sem "type": "module" e instalar o pepino em spec/node_modules .

Até agora, parece estar funcionando. Vamos ver se ele ainda está funcionando depois de criar alguns testes reais.

Para os mantenedores: esta é a primeira vez que uso pepino, e até agora estou gostando. No entanto, isso realmente prejudicou meu progresso. Em vez de passar a tarde aprendendo pepino, passei-o depurando importações. Eu sei como é irritante tentar criar uma biblioteca que suporte as importações ES6 e CJS, então você tem minha simpatia.

Uma possível solução:
É possível publicar compilações CJS e ES6 de uma vez se você gerar um segundo arquivo dist:

dist / cucumber.js
dist / cucumber.module.js

Em seguida, adicione esta linha ao package.json:

"módulo": "dist / cucumber.module.js"

Isso deve permitir que o nó resolva as importações ES6.

tem que haver uma maneira melhor de fazer isso. Eu também estou tendo esse problema e, como as importações não podem ser usadas com o commonJS, eu teria que usar
https://nodejs.org/api/esm.html#esm_import_expressions

em todos os lugares...

existe uma maneira de o Cucumber ter um sinalizador para nos ajudar a usar o ES?

Uma rápida para as pessoas interessadas nisso: ao usar o ESM em um projeto com pepino, você:

• Use a extensão .js e "type":"module"
• Use a extensão .mjs
• Algo mais?

Obrigado!

Eu tendo a seguir a convenção de usar extensões .mjs e .cjs para todos os meus arquivos JavaScript para evitar ambigüidade, e seria minha preferência fazer isso também neste caso. No entanto, não seria nenhum grande inconveniente definir “tipo”: “módulo” no nível do projeto e deixá-los como arquivos .js se essa for a melhor solução para mais usuários.

Eu uso a extensão .js e "type":"module" pois espero que isso se torne a norma a longo prazo.

Obrigado pelo feedback @adamlacoste @looeee

@davidjgoss o # 1589 sendo mesclado é o suficiente para que esse problema seja

Obrigado pela cotovelada @ aurelien-reeves!

A versão 7.2.0 de @cucumber/cucumber agora está em npm, incluindo suporte experimental para ESM conforme descrito nos documentos aqui:
https://github.com/cucumber/cucumber-js/blob/master/docs/cli.md#es-modules-experimental-nodejs-12

Se os interessados ​​pudessem experimentar e relatar o que você achou, isso seria ótimo. Eu coloquei um projeto de exemplo super minimalista aqui:
https://github.com/davidjgoss/cucumber-esm-example

Fico feliz em manter esse problema em aberto por um tempo, apenas para pegar o feedback inicial em um só lugar.

Refs. https://github.com/cucumber/cucumber-js/issues/1646

Portanto, essa mudança causou um problema com estruturas e formatadores de terceiros que require certas coisas diretamente (em oposição ao ponto de entrada). Eu lancei o 7.2.1, que é basicamente uma reversão para o 7.1.0 para desbloquear essas pessoas, e irei investigar a causa e ver se podemos evitá-lo enquanto ainda oferecemos suporte ao ESM. Enquanto isso, se isso não afeta você, o 7.2.0 ainda está lá para experimentar.

Tenho tentado dar uma chance a v7.2.0 junto com a bandeira --esm . eu uso o testdouble nos testes do pacote que estou tentando converter para ESM.

para usar td.replaceEsm , um carregador deve ser usado como --loader=testdouble . quando tento fornecer o carregador diretamente para o pepino cli, recebo o seguinte erro:

> cucumber-js test/integration --esm --loader=testdouble

error: unknown option '--loader=testdouble'

como essa opção não estava disponível, tentei NODE_OPTIONS :

> NODE_OPTIONS='--loader=testdouble' cucumber-js test/integration --esm

(node:62231) ExperimentalWarning: --experimental-loader is an experimental feature. This feature could change at any time
(Use `node --trace-warnings ...` to show where the warning was created)
internal/process/esm_loader.js:74
    internalBinding('errors').triggerUncaughtException(
                              ^

TypeError [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension "" for /path/to/project/node_modules/@cucumber/cucumber/bin/cucumber-js
    at defaultGetFormat (internal/modules/esm/get_format.js:71:15)
    at getFormat (file:///path/to/project/node_modules/quibble/lib/quibble.mjs:65:12)
    at Loader.getFormat (internal/modules/esm/loader.js:104:42)
    at Loader.getModuleJob (internal/modules/esm/loader.js:242:31)
    at async Loader.import (internal/modules/esm/loader.js:176:17)
    at async Object.loadESM (internal/process/esm_loader.js:68:5) {
  code: 'ERR_UNKNOWN_FILE_EXTENSION'
}

para referência, isso era contra o nó v14.17.0

seria bom se isso funcionasse com a abordagem NODE_OPTIONS , mas idealmente a opção --loader seria suportada diretamente pelo cli como algumas estruturas de teste começaram a suportar. considere essas abordagens com sua próxima versão que aborda o suporte ESM :)

existe uma abordagem para definir um carregador que você esperaria que funcionasse com v7.2.0 ?