fix(utils): intellisense on matchScreenshot command (#186)

.eslintignore

@@ -1,2 +1,3 @@
 node_modules
 dist
+utils/types/

.gitignore

@@ -11,6 +11,7 @@ dist
 !action/dist
 
 # utils
+utils/types/
 utils/commands.js
 
 # misc

.prettierignore

@@ -1,2 +1,3 @@
 dist/
+utils/types/
 node_modules/

utils/index.ts

@@ -1,4 +1,5 @@
 import { baseExists, compareScreenshots, onAfterScreenshot } from './screenshots';
+import { MatchScreenshotArgs } from './match-screenshot';
 
 export function setupVisualTests(on: Cypress.PluginEvents, config: Cypress.PluginConfigOptions) {
   on('after:screenshot', onAfterScreenshot);
@@ -14,4 +15,10 @@ export function setupVisualTests(on: Cypress.PluginEvents, config: Cypress.Plugi
   return config;
 }
 
-export { matchScreenshot } from './match-screenshot';
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      matchScreenshot(args?: MatchScreenshotArgs): Chainable;
+    }
+  }
+}

utils/match-screenshot.ts

@@ -90,3 +90,5 @@ export function matchScreenshot(subject: Cypress.JQueryWithSelector | Window | D
     return null;
   });
 }
+
+Cypress.Commands.add('matchScreenshot', { prevSubject: ['optional', 'element', 'window', 'document'] }, matchScreenshot);

utils/package.json

@@ -1,10 +1,11 @@
 {
   "name": "comparadise-utils",
   "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "types": "types/index.d.ts",
   "license": "Apache-2.0",
   "files": [
     "dist",
+    "types",
     "commands.js"
   ],
   "repository": {
@@ -26,7 +27,8 @@
     "@types/pngjs": "6.0.1"
   },
   "scripts": {
-    "build": "tsc",
-    "postbuild": "echo \"require('./dist/match-screenshot-command');\" > commands.js"
+    "prebuild": "rm -rf dist types",
+    "build": "tsc && tsc --project tsconfig.types.json",
+    "postbuild": "echo \"require('./dist/match-screenshot');\" > commands.js && echo \"export {};\" > types/index.js"
   }
 }

utils/tsconfig.json

@@ -1,7 +1,7 @@
 {
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "declaration": true,
+    "declaration": false,
     "types": ["cypress"],
     "noEmit": false,
     "sourceMap": false,

utils/tsconfig.types.json

@@ -0,0 +1,12 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "types": ["cypress"],
+    "noEmit": false,
+    "outDir": "types"
+  },
+  "include": ["**/*.ts"],
+  "exclude": ["dist", "node_modules"]
+}