Cucumber-js: ステップ定義とサポートコードでのネイティブJSモジュールのサポート

cucumber-jsをESMで動作させたいのですが。 私たちはすでにそれについて他のいくつかの問題を開いていました。

cucumber-jsがrequireの代わりにimport使用して、返されたpromiseを待機するようにする、CLIオプションを作成する（または他の方法を使用してユーザーをいつ使用するかを探す）ことができます。

追加した例を考えると、これ専用のテストケースを追加して、合格させることができます。 切り替えを試すには、インポートしてpromiseを待つ必要があり、その後、別のエラーが発生しました。

⋊> ~/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)

ステップ定義のドキュメントから例（わずかに変更）を取りましたが、その通りです。記述どおりに機能しません。 Cucumber.jsはCommonJSモジュールであるため、デフォルトのエクスポートのみを提供します。 短期的には、モジュールのデフォルトをインポートして、そこからGiven / When / Thenメソッドにアクセスするだけです。

import cucumber from "cucumber";

cucumber.Given(...);

長期的には、ここに示すように、Cucumberにインポート用とrequire用の別々のエントリポイントがあると便利です。

これを見てくれてありがとう。 その価値については、Cucumberに要求する代わりにインポートするように指示するCLIオプションが適しています。 また、Cucumberが.cjsおよび.mjs拡張子の付いたサポートファイルを探し、それらをそれぞれCommonJSおよびネイティブモジュールとして自動的に処理することもできます。

編集：可能であれば、これについて喜んでお手伝いできることを繰り返し述べたいと思います。 私を正しい方向に向けてください。

モジュールのデフォルトをインポートして、そこからGiven / When / Thenメソッドにアクセスするだけです。
「きゅうり」からきゅうりを輸入する。
cucumber.Given（...）;

これは機能しません。 同じメッセージが表示されます。
package.jsonに "type"： "module"があり、プロジェクトの残りの部分はモジュールを使用しているため、これを変更することはできません。

これらのいずれかを使用する場合：

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

元の投稿と同じエラーメッセージが表示されます。
に変更した場合

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

次に、このメッセージが表示されます。

代わりに、/ some / path / cucumbertest / features / step_definitions.jsの名前を.cjsで終わるように変更するか、import（）を使用するように必要なコードを変更するか、project / package.jsonから「type」：「module」を削除してください。

step_definitions.js名前を_ step_definitions.cjsまたはstep_definitions.mjsに変更すると、無視され、キュウリからステップのスタブを作成するようにという一般的なメッセージが表示されます。

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

ファイルを完全に削除するとまったく同じメッセージが表示されるため、明らかに無視されています。

解決策（一種）

結局、「type」：「module」を使用してプロジェクトでキュウリを実行することができた唯一の方法は、「type」：「module」を使用せずに別のspecpackage.jsonを作成し、キュウリをspec/node_modulesインストールすることです。

これまでのところ、それは機能しているようです。 実際のテストをいくつか作成したら、それがまだ機能するかどうかを見てみましょう。

メンテナの皆さんへ：キュウリを使うのは初めてで、今のところ気に入っています。 しかし、これは本当に私の進歩に打撃を与えました。 午後にキュウリを学ぶ代わりに、インポートのデバッグに費やしました。 ES6のインポートとCJSの両方をサポートするライブラリを作成しようとするのがいかに面倒かを知っているので、お見舞い申し上げます。

考えられる解決策：
2番目のdistファイルを生成すると、CJSビルドとES6ビルドの両方を一度に公開できます。

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

次に、この行をpackage.jsonに追加します。

"モジュール"： "dist / cucumber.module.js"

これにより、ノードがES6インポートを解決できるようになります。

これを行うためのより良い方法が必要です。 私もその問題を抱えています。インポートはcommonJSで使用できないため、使用する必要があります。
https://nodejs.org/api/esm.html#esm_import_expressions

どこにでも...

Eを使用できるようにするためにCucumberにフラグを付ける方法はありますか？

これに興味のある人のための簡単なもの：キュウリを使ったプロジェクトでESMを使用するとき、あなたは次のことをしますか？

• .js拡張子と"type":"module"
• .mjs拡張子を使用する
• 他に何かありますか？

ありがとう！

私は、あいまいさを避けるために、すべてのJavaScriptファイルに.mjsおよび.cjs拡張子を使用するという規則に従う傾向があります。この場合も、そうすることをお勧めします。 ただし、プロジェクトレベルで「type」：「module」を設定し、それがより多くのユーザーにとってより良いソリューションである場合は、これらを.jsファイルのままにしておくことは大きな不便ではありません。

.js拡張子と"type":"module"を使用します。これは、長期的には標準になると予想しているためです。

フィードバックをありがとう@ adamlacoste

@ davidjgoss ＃1589をマージするだけで、その問題を解決できますか？ それとも何か他のものが必要ですか？

@ aurelien-reevesを微調整してくれてありがとう！

@cucumber/cucumberバージョン7.2.0がnpmに追加されました。これには、以下のドキュメントで説明されているESMの実験的なサポートが含まれます。
https://github.com/cucumber/cucumber-js/blob/master/docs/cli.md#es-modules-experimental-nodejs-12

興味のある人が試してみて、あなたが見つけたものを報告することができれば、それは素晴らしいことです。 私はここに超最小限のサンプルプロジェクトを載せました：
https://github.com/davidjgoss/cucumber-esm-example

初期のフィードバックを1か所で把握するために、この問題を少しの間開いたままにしておいてください。

参照。 https://github.com/cucumber/cucumber-js/issues/1646

そのため、この変更により、（エントリポイントからではなく）特定のものを直接requireするサードパーティのフレームワークとフォーマッタで問題が発生しました。 私は7.2.1をリリースしました。これは基本的に7.1.0に戻ってそれらの人々のブロックを解除します。原因を掘り下げて、ESMをサポートしながらそれを回避できるかどうかを確認します。 それまでの間、それがあなたに影響を与えないのであれば、7.2.0はまだ実験するためにそこにあります。

--esmフラグと一緒にv7.2.0試してみました。 ESMに変換しようとしているパッケージのテストでtestdoubleを使用しています。

td.replaceEsm使用するには、 --loader=testdoubleようにローダーを使用する必要があります。 ローダーをキュウリのCLIに直接提供しようとすると、次のエラーが発生します。

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

error: unknown option '--loader=testdouble'

そのオプションが利用できなかったので、私はそれから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'
}

参考までに、これはノードv14.17.0

これがNODE_OPTIONSアプローチで機能するのは良いことですが、理想的には、一部のテストフレームワークがサポートを開始したように、 --loaderオプションがCLIによって直接サポートされます。 ESMサポートにアプローチする次のバージョンでこれらのアプローチを検討してください:)

v7.2.0動作すると予想されるローダーを定義する方法はありますか？