Jasmine Core Testing Framework

Common errors

• Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jasmine-core' imported from ...

  cause Attempting to `require('jasmine-core')` in an ESM context or `import` in CJS, or incorrect module resolution.
  fix Ensure your `package.json` `type` field is correctly set (e.g., `"type": "module"` for ESM files, or remove it for CJS). Use `import` statements for ESM and `require` for CJS. Verify the package is installed.

• TypeError: jasmine.getEnv is not a function

  cause Attempting to access `jasmine.getEnv()` directly after upgrading to Jasmine v6.x, where it's deprecated.
  fix Instead of `jasmine.getEnv()`, configure Jasmine via the `Jasmine` class instance (e.g., `new Jasmine().configure(...)`) or a configuration file. If migrating, consider using `jasmine-browser-runner` or the `jasmine` CLI package which abstract this.

• TypeError: expectAsync is not a function

  cause Attempting to use `expectAsync()` globally after upgrading to Jasmine v6.x without explicitly enabling it.
  fix Ensure your Jasmine configuration explicitly enables `expectAsync` if you need it as a global, or refactor to use `await expect()` for async matchers directly.

Warnings

• breaking Jasmine v6.0.0 dropped support for Node.js 14. Projects must now target Node.js 16 or newer. Node.js 18+ is required for the upcoming v7.0.0.
  Fix: Upgrade Node.js to v16 or higher for Jasmine v6.x, and v18 or higher for Jasmine v7.x.
• breaking With Jasmine v6.0.0, the `default` export for `jasmine-core` was removed for ESM. You must now use named exports for ESM imports.
  Fix: Change `import Jasmine from 'jasmine-core';` to `import { Jasmine } from 'jasmine-core';` or `import * as Jasmine from 'jasmine-core';`.
• deprecated `jasmine.DEFAULT_TIMEOUT_INTERVAL` and `jasmine.getEnv()` are deprecated in v6.0.0. While they still work, direct access is discouraged.
  Fix: Use the configuration object passed to the `Jasmine` constructor or its methods to set timeout intervals and access environment specifics.
• breaking Global `expectAsync` is no longer available by default in Jasmine v6.0.0. It must be explicitly enabled if required.
  Fix: If `expectAsync` is critical, ensure your Jasmine configuration enables it or use `await expect()` for async matchers directly.
• breaking `jasmine.Spy` constructor was removed in v6.0.0. Spies should be created using `spyOn`, `createSpy`, or `createSpyObj`.
  Fix: Refactor code to use `spyOn(object, 'method')`, `jasmine.createSpy('mySpy')`, or `jasmine.createSpyObj('MyObj', ['method1', 'method2'])`.
• gotcha The `jasmine.anything()` matcher now returns `true` for `null` and `undefined` in v6.0.0, which was not the case in previous versions.
  Fix: If strict non-null/non-undefined checks are needed, use `expect(value).not.toBeNull()` or `expect(value).not.toBeUndefined()` in addition to `jasmine.anything()` or create a custom matcher.

Install

• npm install jasmine-core npm
• yarn add jasmine-core yarn
• pnpm add jasmine-core pnpm

Imports

• jasmine
  wrong:

  const jasmine = require('jasmine-core');

  correct:

  import { jasmine } from 'jasmine-core';

  Primarily for programmatic setup. For ESM, direct import of `jasmine` as a named export is needed since v6. For CJS, `require('jasmine-core').getJasmineRequireObj()` is closer to the core object but still not directly `jasmine`.
• bootJasmine
  wrong:

  import bootJasmine from 'jasmine-core/lib/boot.js';

  correct:

  import { bootJasmine } from 'jasmine-core';

  Used to initialize Jasmine globals for browser environments. Often implicitly called by `jasmine-browser-runner`.
• getJasmineRequireObj
  wrong:

  import { getJasmineRequireObj } from 'jasmine-core';

  correct:

  const { getJasmineRequireObj } = require('jasmine-core');

  This is primarily a CommonJS export for internal use or advanced custom runners. Direct ESM import is generally not recommended as the primary interaction pattern for most users, and its usage differs from typical named exports.

Quickstart

This quickstart demonstrates how to programmatically configure and run Jasmine tests using the `Jasmine` class from the `jasmine` package (which wraps `jasmine-core`). It shows basic configuration loading and execution with a completion callback.

import Jasmine from 'jasmine';

const jasmine = new Jasmine();

// Configure Jasmine to use a custom reporter or default options
jasmine.loadConfig({
  spec_dir: 'spec',
  spec_files: [
    '**/*[sS]pec.js'
  ],
  helpers: [
    'helpers/**/*.js'
  ],
  random: false,
  seed: null,
  stopSpecOnExpectationFailure: false,
  failFast: false
});

// Add a simple spec file example (usually in a 'spec' directory)
// This would typically be in a separate file, e.g., 'spec/my-spec.js'
// describe('My Feature', () => {
//   it('should do something', () => {
//     expect(true).toBe(true);
//   });
// });

// For programmatic use, you can add a simple spec directly if not loading from files
// For a more complete programmatic example, you'd typically load files.
// Here's a placeholder for loading specs:
// jasmine.addSpecFile('spec/my-spec.js');

jasmine.onComplete(function(passed) {
  if(passed) {
    console.log('All specs have passed');
  } else {
    console.error('At least one spec has failed');
  }
});

jasmine.execute();