karma-jasmine-matchers

A Karma plugin to inject Jasmine-Matchers for Jasmine and Jest.

Table of Contents

• 🌩 Installation
• 📝 API
• 🕹 Usage
• 🙋🏾‍♀️ Getting Help
• 👀 Other Projects
• 🤓 Author

🌩 Installation

npm install karma-jasmine-matchers --save-dev

📝 API

See the following links for a full list of Matchers and Asymmetric Matchers provided.

🕹 Usage

Just include 'jasmine-matchers' in the frameworks and 'karma-jasmine-matchers'in the plugins section of your config

module.exports = function(config) {
  config.set({
    frameworks: ["jasmine", "jasmine-matchers"],
    files: ["src/**/*.js", "src/**/*.spec.js"],
    // also you must add it as a plugin
    plugins: ["karma-jasmine", "karma-jasmine-matchers"]
  });
};

TypeScript and Angular CLI projects

If you are using TypeScript, you might want to npm install @types/jasmine-expect --save-dev in order to prevent your IDE from complaining about the new Matchers.

Also, if you run into TypeScript compilation errors when running your tests, add "jasmine-expect" to the "types" array in your tests' tsconfig file.

As an example, for an Angular CLI based project, this would be your tsconfig.spec.json file:

{
  "extends": "../tsconfig.json",
  "compilerOptions": {
    "outDir": "../out-tsc/spec",
    "baseUrl": "./",
    "module": "commonjs",
    "target": "es5",
    "types": ["jasmine", "node", "jasmine-expect"]
  },
  "files": ["test.ts"],
  "include": ["**/*.spec.ts", "**/*.d.ts"]
}

🙋🏾‍♀️ Getting Help

Get help with issues by creating a Bug Report or discuss ideas by opening a Feature Request.

👀 Other Projects

If you find my Open Source projects useful, please share them ❤️

• eslint-formatter-git-logESLint Formatter featuring Git Author, Date, and Hash
• eslint-plugin-move-filesMove and rename files while keeping imports up to date
• eslint-plugin-prefer-arrow-functionsConvert functions to arrow functions
• ImageOptim-CLIAutomates ImageOptim, ImageAlpha, and JPEGmini for Mac to make batch optimisation of images part of your automated build process.
• Jasmine-MatchersWrite Beautiful Specs with Custom Matchers
• karma-benchmarkRun Benchmark.js over multiple Browsers, with CI compatible output
• self-helpInteractive Q&A Guides for Web and the Command Line
• syncpackManage multiple package.json files, such as in Lerna Monorepos and Yarn Workspaces

🤓 Author

I'm Jamie Mason from Leeds in England, I began Web Design and Development in 1999 and have been Contracting and offering Consultancy as Fold Left Ltd since 2012. Who I've worked with includes Sky Sports, Sky Bet, Sky Poker, The Premier League, William Hill, Shell, Betfair, and Football Clubs including Leeds United, Spurs, West Ham, Arsenal, and more.