@kensio/smartass 1.24.0 → 1.25.0

package/README.md

@@ -161,3 +161,28 @@ structure.
 - [typeTypedArray](src/assert/type-typed-array/type-typed-array.match.ts)
 - [uuidV4](src/assert/uuid/uuid-v4.match.ts)
 <!-- matcher-functions:end -->
+
+## Optional ESLint config
+
+The `@kensio/smartass` package also exports an optional ESLint flat config that discourages less
+specific assertion usage. For example:
+
+```typescript
+assertIdentical(foo.length, 2);
+// suggested improvement:
+assertArrayLength(foo, 2);
+```
+
+You can use this in your ESLint config like this:
+
+```typescript
+import { defineConfig } from "eslint/config";
+import tseslint from "typescript-eslint";
+
+import { smartassAssertions } from "@kensio/smartass/eslint";
+
+export default defineConfig(
+  ...tseslint.configs.recommended,
+  ...smartassAssertions,
+);
+```

package/dist/eslint/smartass-eslint.config.d.ts

@@ -0,0 +1,2 @@
+export declare const smartassAssertions: import("eslint/config").Config[];
+//# sourceMappingURL=smartass-eslint.config.d.ts.map

package/dist/eslint/smartass-eslint.config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"smartass-eslint.config.d.ts","sourceRoot":"","sources":["../../src/eslint/smartass-eslint.config.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,kBAAkB,kCA+B7B,CAAC"}

package/dist/eslint/smartass-eslint.config.js

@@ -0,0 +1,26 @@
+import { defineConfig } from "eslint/config";
+export const smartassAssertions = defineConfig({
+    name: "@kensio/smartass/assertions",
+    rules: {
+        "no-restricted-syntax": [
+            "warn",
+            {
+                selector: "CallExpression[callee.name='assertIdentical'] > Literal[value=true]:nth-child(2)",
+                message: "Use assertTrue(value) instead of assertIdentical(value, true).",
+            },
+            {
+                selector: "CallExpression[callee.name='assertIdentical'] > Literal[value=false]:nth-child(2)",
+                message: "Use assertFalse(value) instead of assertIdentical(value, false).",
+            },
+            {
+                selector: "CallExpression[callee.name='assertIdentical'] > MemberExpression[property.name='length']:first-child",
+                message: "Use a more specific length assertion, such as assertArrayLength(value, expectedLength) or assertStringLength(value, expectedLength), instead of assertIdentical(value.length, expectedLength).",
+            },
+            {
+                selector: "CallExpression[callee.name='assertIdentical'] > MemberExpression[property.name='size']:first-child",
+                message: "Use a more specific size assertion, such as assertSetSize(value, expectedSize) or assertMapSize(value, expectedSize), instead of assertIdentical(value.size, expectedSize).",
+            },
+        ],
+    },
+});
+//# sourceMappingURL=smartass-eslint.config.js.map

package/dist/eslint/smartass-eslint.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"smartass-eslint.config.js","sourceRoot":"","sources":["../../src/eslint/smartass-eslint.config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,MAAM,CAAC,MAAM,kBAAkB,GAAG,YAAY,CAAC;IAC7C,IAAI,EAAE,6BAA6B;IACnC,KAAK,EAAE;QACL,sBAAsB,EAAE;YACtB,MAAM;YACN;gBACE,QAAQ,EACN,kFAAkF;gBACpF,OAAO,EACL,gEAAgE;aACnE;YACD;gBACE,QAAQ,EACN,mFAAmF;gBACrF,OAAO,EACL,kEAAkE;aACrE;YACD;gBACE,QAAQ,EACN,sGAAsG;gBACxG,OAAO,EACL,gMAAgM;aACnM;YACD;gBACE,QAAQ,EACN,oGAAoG;gBACtG,OAAO,EACL,6KAA6K;aAChL;SACF;KACF;CACF,CAAC,CAAC"}

package/package.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/KensioSoftware/smartass"
   },
   "license": "Apache-2.0",
-  "version": "1.24.0",
+  "version": "1.25.0",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -15,6 +15,10 @@
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
+    },
+    "./eslint": {
+      "types": "./dist/eslint/smartass-eslint.config.d.ts",
+      "import": "./dist/eslint/smartass-eslint.config.js"
     }
   },
   "files": [