jasmine-browser-runner 2.0.0-beta.1 → 2.0.0

package/README.md

@@ -1,6 +1,3 @@
-[![Build Status](https://circleci.com/gh/jasmine/jasmine-browser.svg?style=shield)](https://circleci.com/gh/jasmine/jasmine-browser)
-
-
 jasmine-browser-runner runs your Jasmine specs in a browser. It's suitable for
 interactive use with normal browsers as well as running specs in CI builds
 using either headless Chrome or Saucelabs.
@@ -9,44 +6,34 @@ using either headless Chrome or Saucelabs.
 
 ```bash
 npm install --save-dev jasmine-browser-runner jasmine-core
+npx jasmine-browser-runner init
 ```
 
 or
 
 ```bash
 yarn add -D jasmine-browser-runner jasmine-core
+npx jasmine-browser-runner init
 ```
 
-Add a `spec/support/jasmine-browser.json`. For example:
+If you intend to use ES modules, add `--esm` to the `jasmine-browser-runner init`
+command.
 
-```json
-{
-  "srcDir": "src",
-  "srcFiles": [
-    "**/*.?(m)js"
-  ],
-  "specDir": "spec",
-  "specFiles": [
-    "**/*[Ss]pec.?(m)js"
-  ],
-  "helpers": [
-    "helpers/asyncAwait.js"
-  ],
-  "env": {
-    "random": true
-  }
-}
-```
+Then, customize `spec/support/jasmine-browser.json` to suit your needs. You can
+change the spec files, helpers, and source files that are loaded, specify the
+[Jasmine env's configuration](https://jasmine.github.io/api/edge/Configuration.html),
+and more.
 
 You can also use the `--config` option to specify a different file. This file can be a JSON file or a javascript file that exports a object that looks like the JSON above.
 
-Start the server:
+To start the server so that you can run the specs interactively (particularly
+useful for debugging):
 
 ```
 npx jasmine-browser-runner serve
 ```
 
-Run the tests in a browser (defaults to Firefox)
+To run the specs in a browser (defaults to Firefox):
 
 ```
 npx jasmine-browser-runner runSpecs
@@ -70,7 +57,9 @@ Its value can be `"firefox"`, `"headlessFirefox"`, `"safari"`,
 If a source, spec, or helper file's name ends in `.mjs`, it will be loaded as
 an ES module rather than a regular script. Note that ES modules can only be
 loaded from other ES modules. So if your source files are ES modules, your
-spec files need to be ES modules too.
+spec files need to be ES modules too. Want to use a different extension than
+`.esm`? Just set the `esmFilenameExtension` config property, e.g.
+`"esmFilenameExtension": ".js"`.
 
 To allow spec files to import source files via relative paths, set the `specDir`
 config field to something that's high enough up to include both spec and source
@@ -223,7 +212,7 @@ Firefox, and Microsoft Edge) as well as Node.
 
 | Environment       | Supported versions     |
 |-------------------|------------------------|
-| Node              | 12.17+, 14, 16, 18, 20 |
+| Node              | 18, 20                 |
 | Safari            | 15-16                  |
 | Chrome            | Evergreen              |
 | Firefox           | Evergreen, 102         |

package/lib/examples/default_esm_config.json

@@ -8,6 +8,8 @@
   "helpers": [
     "spec/helpers/**/*.?(m)js"
   ],
+  "esmFilenameExtension": ".mjs",
+  "enableTopLevelAwait": false,
   "env": {
     "stopSpecOnExpectationFailure": false,
     "stopOnSpecFailure": false,

package/lib/server.js

@@ -14,7 +14,7 @@ class Server {
    * @param {ServerCtorOptions} options
    */
   constructor(options) {
-    this.options = options;
+    this.options = { ...options };
     this.useHtmlReporter =
       options.useHtmlReporter === undefined ? true : options.useHtmlReporter;
     this.projectBaseDir = options.projectBaseDir || path.resolve();
@@ -29,6 +29,13 @@ class Server {
         return unWindows(path.join('/__jasmine__', fileName));
       })
       .concat(this.bootFiles());
+
+    if (!this.options.esmFilenameExtension) {
+      this.options.esmFilenameExtension = '.mjs';
+    } else if (this.options.esmFilenameExtension[0] !== '.') {
+      this.options.esmFilenameExtension =
+        '.' + this.options.esmFilenameExtension;
+    }
   }
 
   bootFiles() {
@@ -75,9 +82,9 @@ class Server {
       this.options.srcDir,
       this.options.srcFiles,
       '/__src__'
-    ).filter(function(url) {
+    ).filter(url => {
       // Exclude ES modules. These will be loaded by other ES modules.
-      return !url.endsWith('.mjs');
+      return !url.endsWith(this.options.esmFilenameExtension);
     });
     const helperUrls = this.getUrls(
       this.options.specDir,
@@ -163,6 +170,7 @@ class Server {
             cssFiles: self.allCss(),
             jasmineJsFiles: self.jasmineJs(),
             userJsFiles: self.userJs(),
+            esmFilenameExtension: self.options.esmFilenameExtension,
             importMap: self.importMap(),
             enableTopLevelAwait: self.options.enableTopLevelAwait || false,
           })

package/lib/support/loaders.js

@@ -19,7 +19,10 @@ window._jasmine_loadEsModule = function(src) {
   document.head.appendChild(script);
 };
 
-window._jasmine_loadWithTopLevelAwaitSupport = async function(scriptUrls) {
+window._jasmine_loadWithTopLevelAwaitSupport = async function(
+  scriptUrls,
+  esmFilenameExtension
+) {
   const scriptsLoaded = (async function() {
     // Load scripts sequentially to ensure that users can get a stable order
     // by disabling randomization or setting a seed. This can be considerably
@@ -28,7 +31,7 @@ window._jasmine_loadWithTopLevelAwaitSupport = async function(scriptUrls) {
     // describes will execute in a consistent order in the presence of top-level
     // await.
     for (const url of scriptUrls) {
-      const isEsm = url.endsWith('.mjs');
+      const isEsm = url.endsWith(esmFilenameExtension);
 
       if (isEsm) {
         try {

package/lib/types.js

@@ -70,6 +70,12 @@
  * @name ServerCtorOptions#srcFiles
  * @type string[] | undefined
  */
+/**
+ * The file extension used by ES modules
+ * @name ServerCtorOptions#esmFilenameExtension
+ * @type string | undefined
+ * @default ".mjs"
+ */
 
 /**
  * Specifies the properties of the configuration file, as well as

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jasmine-browser-runner",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.0",
   "description": "Serve and run your Jasmine specs in a browser",
   "bin": "bin/jasmine-browser-runner",
   "exports": "./index.js",
@@ -43,14 +43,14 @@
     "selenium-webdriver": "^4.8.2"
   },
   "peerDependencies": {
-    "jasmine-core": "^5.0.0-beta.0"
+    "jasmine-core": "^5.0.0"
   },
   "devDependencies": {
     "ejs-lint": "^2.0.0",
     "eslint": "^8.38.0",
     "eslint-plugin-jasmine": "^4.1.3",
-    "jasmine": "^5.0.0-beta.0",
-    "jasmine-core": "^5.0.0-beta.0",
+    "jasmine": "^5.0.0",
+    "jasmine-core": "^5.0.0",
     "prettier": "^1.17.1",
     "shelljs": "^0.8.3",
     "temp": "^0.9.4"

package/run.html.ejs

@@ -24,11 +24,11 @@
         <% userJsFiles.forEach(function(jsFile) { %>
           '<%= jsFile %>',
         <% }) %>
-      ]);
+      ], '<%=esmFilenameExtension%>');
     </script>
   <% } else { %>
     <% userJsFiles.forEach(function(jsFile) { %>
-      <% if (jsFile.endsWith('.mjs')) { %>
+      <% if (jsFile.endsWith(esmFilenameExtension)) { %>
         <script type="module">_jasmine_loadEsModule('<%= jsFile %>')</script>
       <% } else { %>
         <script src="<%= jsFile %>" type="text/javascript"></script>