![\"A](\"https://raw.githubusercontent.com/TotalTechGeek/pineapple/master/resources/pineapple.png\")
\n
Making your software tests sweet!
\n\n\n\n---\n\n## What is this?\n\n[](https://badge.fury.io/js/pineapple) [](https://github.com/TotalTechGeek/pineapple/actions/workflows/node.js.yml) [](https://coveralls.io/github/TotalTechGeek/pineapple)\n\nPineapple is a test framework designed to remove the cruft from writing unit tests and creating snapshots.\n\n```js\n/**\n * Adds numbers together for the sake of demonstrating pineapple.\n * @test 1, 2 returns 3\n * @test '1', 2 throws \"Not a number\"\n * @param {number} a \n * @param {number} b\n */\nexport function add(a, b) {\n if (typeof a !== 'number' || typeof b !== 'number') throw new Error('Not a number')\n return a + b\n}\n```\n\nPineapple allows you to embed a few example test-cases in your JSDocs, making it easier to focus on your code and less on defining `it` & `expect` chains.\n\n![\"An](\"https://jessemitchell.me/pineapple/img/snapshot.gif\")
\n\n## Documentation\n\nVisit our [documentation here](https://pineapple.js.org).\n\n## Highlights\n\n### Snapshots\n\nWhen you omit conditions from your test cases, Pineapple will automatically capture the result of your test & snapshot it, making it easier to preserve expected behavior in your applications, and even easier for users to find examples on how to call your code.\n\n### Property Based / Fuzz Testing\n\nBy leveraging fast-check, Pineapple makes it simple to fuzz-test your functions with simple clauses.\n\nThis pairs extremely well with the snapshot testing for capturing a variety of test-cases that would've taken time to generate by hand.\n\n```typescript\n/**\n * Computes the sum of numbers.\n * @test #array(#integer)\n */\nexport function sum(arr: number[]) {\n return arr.reduce((a,b) => a + b, 0)\n}\n```\n\n### Language-Idiomatic Test Code\n\nEven in cases where you might need to write a more complex unit test, Pineapple encourages you to write normal JavaScript functions.\n\n### Continuous Test Runner\n\nBy enabling the `-w` or `--watch-mode` flag, Pineapple will watch your project for changes. Any changes to a file will kick off all tests that could be potentially impacted by your change.\n\n**And Much More**\n\n## To Install\n\n```\nnpm i pineapple --save-dev\n```\n\nor\n\n```\nyarn add pineapple --dev\n```\n\nAlternatively, you may install the runner globally (add a `-g` flag).\n\n### To Run\n\n```\nUsage: pineapple [options]\n\nOptions:\n -V, --version output the version number\n -i, --include