feat: rewriting the matcher in typescript (#45)

.eslintignore

@@ -1,2 +1,4 @@
+@types/
 coverage/
+dist/
 node_modules/

.eslintrc

@@ -1,7 +1,13 @@
 {
-  "extends": "@readme/eslint-config",
+  "extends": [
+    "@readme/eslint-config",
+    "@readme/eslint-config/typescript"
+  ],
   "root": true,
   "env": {
     "jest": true
+  },
+  "rules": {
+    "@typescript-eslint/consistent-type-imports": "error"
   }
 }

.gitignore

@@ -1,2 +1,4 @@
-node_modules/
+@types/
 coverage/
+dist/
+node_modules/

.npmignore

@@ -3,4 +3,5 @@ __tests__/
 coverage/
 .eslint*
 .gitignore
+jest.*
 .prettier*

.prettierignore

@@ -1,2 +1,4 @@
+@types/
 coverage/
+dist/
 node_modules/

README.md

@@ -10,17 +10,21 @@ A [Jest](https://jestjs.io/) custom matcher for asserting valid [HAR](https://en
 ## Installation
 
 ```sh
-npm install --save-dev jest-expect-har
-```
-
-Once the package is installed you'll need to let Jest know about it by adding the following into your Jest config (either `jest.config.js` or under `jest` in `package.json`):
-
-```json
-"setupFilesAfterEnv": ["jest-expect-har"],
+npm install jest-expect-har --save-dev
 ```
 
 ## Usage
 
 ```js
-await expect(har).toBeAValidHAR();
+import toBeAValidHAR from 'jest-expect-har';
+
+expect.extend({ toBeAValidHAR });
+
+test('should be a valid HAR', () => {
+  expect(har).toBeAValidHAR();
+});
+
+test('should not be a valid HAR', () => {
+  expect(invalidHar).not.toBeAValidHAR();
+});
 ```

__tests__/index.test.js → __tests__/index.test.ts

@@ -1,4 +1,7 @@
-const har = require('./__fixtures__/har.valid.json');
+import toBeAValidHAR from '../src';
+import har from './__fixtures__/har.valid.json';
+
+expect.extend({ toBeAValidHAR });
 
 test('should accept a valid HAR', async () => {
   await expect(har).toBeAValidHAR();

jest.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+  coveragePathIgnorePatterns: ['__tests__/__fixtures__/'],
+  globals: {
+    'ts-jest': {
+      tsconfig: 'tsconfig.test.json',
+    },
+  },
+  preset: 'ts-jest/presets/js-with-ts',
+  testPathIgnorePatterns: ['__tests__/__fixtures__/'],
+  testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.(js?|ts?)$',
+};