expect-type - npm Package Compare versions

Comparing version 0.9.1 to 0.9.2

CHANGELOG.json

@@ -5,2 +5,14 @@ {
     {
+      "version": "0.9.2",
+      "tag": "expect-type_v0.9.2",
+      "date": "Sat, 28 Nov 2020 19:10:00 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "docs(jest): document useful jest/eslint config (#218) - @olance"
+          }
+        ]
+      }
+    },
+    {
       "version": "0.9.1",
@@ -7,0 +19,0 @@ "tag": "expect-type_v0.9.1",

CHANGELOG.md

 # Change Log - expect-type
 
-This log was last generated on Thu, 26 Nov 2020 17:06:36 GMT and should not be manually modified.
+This log was last generated on Sat, 28 Nov 2020 19:10:00 GMT and should not be manually modified.
 
+## 0.9.2
+Sat, 28 Nov 2020 19:10:00 GMT
+
+### Patches
+
+- docs(jest): document useful jest/eslint config (#218) - @olance
+
 ## 0.9.1
@@ -6,0 +13,0 @@ Thu, 26 Nov 2020 17:06:36 GMT

package.json

 {
 	"name": "expect-type",
-	"version": "0.9.1",
+	"version": "0.9.2",
 	"keywords": [
@@ -5,0 +5,0 @@ "typescript",

readme.md

@@ -40,2 +40,4 @@ # expect-type
    - [Features](#features)
+   - [Within test frameworks](#within-test-frameworks)
+      - [Jest & `eslint-plugin-jest`](#jest--eslint-plugin-jest)
 - [Similar projects](#similar-projects)
@@ -316,2 +318,24 @@ - [Comparison](#comparison)
 
+### Within test frameworks
+
+#### Jest & `eslint-plugin-jest`
+If you're using Jest along with `eslint-plugin-jest`, you will get warnings from the [`jest/expect-expect`](https://github.com/jest-community/eslint-plugin-jest/blob/master/docs/rules/expect-expect.md) rule, complaining that "Test has no assertions" for tests that only use `expectTypeOf()`.
+
+To remove this warning, configure the ESlint rule to consider `expectTypeOf` as an assertion:
+
+```js
+"rules": {
+  // ...
+  "jest/expect-expect": [
+    "warn",
+    {
+      "assertFunctionNames": [
+        "expect", "expectTypeOf"
+      ]
+    }
+  ],
+  // ...
+}
+```
+
 ## Similar projects
@@ -345,2 +369,2 @@
 - built into existing tooling. No extra build step, cli tool, IDE extension, or lint plugin is needed. Just import the function and start writing tests. Failures will be at compile time - they'll appear in your IDE and when you run `tsc`.
-- small implementation with no dependencies. <200 lines of code - [take a look!](https://github.com/mmkal/ts/tree/a3d6001/packages/expect-type/src/index.ts)
+- small implementation with no dependencies. <200 lines of code - [take a look!](https://github.com/mmkal/ts/tree/00c3abe/packages/expect-type/src/index.ts)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

50510

increased by3.88%

Lines of code

426

increased by2.9%

Number of lines in readme file

368

increased by6.98%

No dependency changes