build(tools): add eslint configuration for tests with jest (#7)

toofff · web-flow · commit 85d657885eed · 2023-01-19T06:08:37.000+01:00
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,16 @@
+.github
+.husky
+dist
+example
+node_modules
+resources
+*lock*
+.*ignore
+*.css
+*.ico
+*.json
+*.html
+*.md
+*.yaml
+.editorconfig
+LICENSE
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -13,14 +13,33 @@
       "impliedStrict": true
     }
   },
+  "plugins": ["prettier"],
   "extends": [
     "eslint:recommended",
     "airbnb-base",
     "plugin:import/recommended",
     "plugin:promise/recommended",
     "plugin:prettier/recommended"
   ],
-  "plugins": ["prettier"],
+  "overrides": [
+    {
+      "files": ["**/__tests__/**/*.js", "**/?(*.)+(spec|test).js"],
+      "env": {
+        "jest": true
+      },
+      "settings": {
+        "jest": {
+          "version": 29
+        }
+      },
+      "extends": [
+        "plugin:jest/recommended",
+        "plugin:jest/style",
+        "plugin:jest-dom/recommended",
+        "plugin:testing-library/dom"
+      ]
+    }
+  ],
   "rules": {
     "prettier/prettier": "error",
     "consistent-return": "warn",
diff --git a/.lintstagedrc.json b/.lintstagedrc.json
@@ -1,4 +1,4 @@
 {
-  "src/*.js": ["pnpm run lint:tool:eslint --fix", "git add ."],
+  "{__tests__,src}/**/*.js": ["pnpm run lint:tool:eslint --fix", "git add ."],
   "**/*.{css,html,json,md}": ["pnpm run lint:tool:prettier --write", "git add ."]
 }
diff --git a/.prettierignore b/.prettierignore
@@ -1,4 +1,12 @@
-.*ignore
+.husky
+dist
+example
+node_modules
+resources
 *lock*
+.*ignore
+*.ico
+*.js
+*.yaml
+.editorconfig
 .github/PULL_REQUEST_TEMPLATE.md
-example/example.min.js
diff --git a/__tests__/cancel.spec.js b/__tests__/cancel.spec.js
@@ -33,7 +33,7 @@ describe('cancel', () => {
     drake.start(item);
     drake.cancel();
 
-    expect(div.children.length).toEqual(1);
+    expect(div.children).toHaveLength(1);
     expect(drake.dragging).toBeFalsy();
   });
 
diff --git a/__tests__/container.spec.js b/__tests__/container.spec.js
@@ -6,7 +6,7 @@ describe('container', () => {
     const drake = dragula();
 
     expect(Array.isArray(drake.containers)).toBeTruthy();
-    expect(drake.containers.length).toEqual(0);
+    expect(drake.containers).toHaveLength(0);
   });
 
   it('drake reads containers from array argument', () => {
@@ -15,7 +15,7 @@ describe('container', () => {
     const drake = dragula(containers);
 
     expect(drake.containers).toEqual(containers);
-    expect(drake.containers.length).toEqual(1);
+    expect(drake.containers).toHaveLength(1);
   });
 
   it('drake reads containers from array in options', () => {
@@ -24,7 +24,7 @@ describe('container', () => {
     const drake = dragula({ containers });
 
     expect(drake.containers).toEqual(containers);
-    expect(drake.containers.length).toEqual(1);
+    expect(drake.containers).toHaveLength(1);
   });
 
   it('containers in options take precedent', () => {
@@ -33,6 +33,6 @@ describe('container', () => {
     const drake = dragula([], { containers });
 
     expect(drake.containers).toEqual(containers);
-    expect(drake.containers.length).toEqual(1);
+    expect(drake.containers).toHaveLength(1);
   });
 });
diff --git a/__tests__/default.spec.js b/__tests__/default.spec.js
@@ -3,16 +3,16 @@ const dragula = require('../src/dragula');
 
 describe('default', () => {
   it('drake has sensible default options', () => {
-    const options = dragula({}).options;
+    const { options } = dragula({});
 
-    expect(typeof options.moves).toEqual('function');
-    expect(typeof options.accepts).toEqual('function');
-    expect(typeof options.invalid).toEqual('function');
-    expect(typeof options.isContainer).toEqual('function');
+    expect(typeof options.moves).toBe('function');
+    expect(typeof options.accepts).toBe('function');
+    expect(typeof options.invalid).toBe('function');
+    expect(typeof options.isContainer).toBe('function');
     expect(options.copy()).toBeFalsy();
     expect(options.revertOnSpill).toBeFalsy();
     expect(options.removeOnSpill).toBeFalsy();
-    expect(options.direction).toEqual('vertical');
+    expect(options.direction).toBe('vertical');
     expect(options.mirrorContainer).toEqual(document.body);
   });
 });
diff --git a/__tests__/destroy.spec.js b/__tests__/destroy.spec.js
@@ -33,7 +33,7 @@ describe('destroy', () => {
     drake.start(item);
     drake.destroy();
 
-    expect(div.children.length).toEqual(1);
+    expect(div.children).toHaveLength(1);
     expect(drake.dragging).toBeFalsy();
   });
 
diff --git a/__tests__/drag.spec.js b/__tests__/drag.spec.js
@@ -154,7 +154,7 @@ describe('drag', () => {
     events.raise(item, 'pointerdown', { which: 1 });
     events.raise(item, 'pointermove', { which: 1 });
 
-    expect(item.className).toEqual('gu-transit');
+    expect(item.className).toBe('gu-transit');
   });
 
   it.skip('when dragging, body gets gu-unselectable class', () => {
@@ -167,7 +167,7 @@ describe('drag', () => {
     events.raise(item, 'pointerdown', { which: 1 });
     events.raise(item, 'pointermove', { which: 1 });
 
-    expect(document.body.className).toEqual('gu-unselectable');
+    expect(document.body.className).toBe('gu-unselectable');
   });
 
   it.skip('when dragging, element gets a mirror image for show', () => {
@@ -186,7 +186,7 @@ describe('drag', () => {
 
     expect(item.className).toBe('gu-transit');
     expect(stubCloned).toHaveBeenCalledTimes(1);
-    expect(stubCloned.mock.calls[0][0].className).toEqual('gu-mirror');
+    expect(stubCloned.mock.calls[0][0].className).toBe('gu-mirror');
     expect(stubCloned.mock.calls[0][0].innerHTML).toEqual(item.innerHTML);
     expect(stubCloned.mock.calls[0][1]).toEqual(item);
   });
@@ -220,11 +220,11 @@ describe('drag', () => {
     events.raise(item, 'pointerdown', { which: 1 });
     events.raise(item, 'pointermove', { which: 1 });
 
-    expect(item.className).toEqual('gu-transit');
+    expect(item.className).toBe('gu-transit');
 
     drake.end();
 
-    expect(item.className).toEqual('');
+    expect(item.className).toBe('');
   });
 
   it.skip('when dragging stops, body becomes selectable again', () => {
@@ -237,11 +237,11 @@ describe('drag', () => {
     events.raise(item, 'pointerdown', { which: 1 });
     events.raise(item, 'pointermove', { which: 1 });
 
-    expect(document.body.className).toEqual('gu-unselectable');
+    expect(document.body.className).toBe('gu-unselectable');
 
     drake.end();
 
-    expect(document.body.className).toEqual('');
+    expect(document.body.className).toBe('');
   });
 
   it.skip('when drag begins, check for copy option', () => {
@@ -261,8 +261,8 @@ describe('drag', () => {
     events.raise(item, 'pointermove', { which: 1 }); // ensure the copy method condition is only asserted once
 
     expect(stubCopy).toHaveBeenCalledTimes(1);
-    expect(stubCopy.mock.calls[0][0].className).toEqual('copyable');
-    expect(stubCopy.mock.calls[0][1].className).toEqual('contains');
+    expect(stubCopy.mock.calls[0][0].className).toBe('copyable');
+    expect(stubCopy.mock.calls[0][1].className).toBe('contains');
 
     drake.end();
   });
diff --git a/__tests__/drake-api.spec.js b/__tests__/drake-api.spec.js
@@ -12,14 +12,14 @@ describe('drake-api', () => {
     const drake = dragula();
 
     expect(drake).toBeTruthy();
-    expect(typeof drake).toEqual('object');
+    expect(typeof drake).toBe('object');
     expect(Array.isArray(drake.containers)).toBeTruthy();
-    expect(typeof drake.start).toEqual('function');
-    expect(typeof drake.end).toEqual('function');
-    expect(typeof drake.cancel).toEqual('function');
-    expect(typeof drake.remove).toEqual('function');
-    expect(typeof drake.destroy).toEqual('function');
-    expect(typeof drake.dragging).toEqual('boolean');
+    expect(typeof drake.start).toBe('function');
+    expect(typeof drake.end).toBe('function');
+    expect(typeof drake.cancel).toBe('function');
+    expect(typeof drake.remove).toBe('function');
+    expect(typeof drake.destroy).toBe('function');
+    expect(typeof drake.dragging).toBe('boolean');
     expect(drake.dragging).toBeFalsy();
   });
 });
diff --git a/__tests__/events.spec.js b/__tests__/events.spec.js
@@ -16,7 +16,7 @@ describe('events', () => {
     drake.start(item);
 
     expect(stubCloned).toHaveBeenCalledTimes(1);
-    expect(stubCloned.mock.calls[0][2]).toEqual('copy');
+    expect(stubCloned.mock.calls[0][2]).toBe('copy');
     expect(stubCloned.mock.calls[0][0]).not.toBe(item);
     expect(stubCloned.mock.calls[0][0].nodeType).toEqual(item.nodeType);
     expect(stubCloned.mock.calls[0][1]).toEqual(item);
@@ -225,7 +225,7 @@ describe('events', () => {
     events.raise(item, 'pointermove', { which: 1 });
 
     expect(stubCloned).toHaveBeenCalledTimes(1);
-    expect(stubCloned.mock.calls[0][2]).toEqual('mirror');
+    expect(stubCloned.mock.calls[0][2]).toBe('mirror');
     expect(stubCloned.mock.calls[0][0]).not.toBe(item);
     expect(stubCloned.mock.calls[0][0].nodeType).toEqual(item.nodeType);
     expect(stubCloned.mock.calls[0][1]).toEqual(item);
@@ -245,7 +245,7 @@ describe('events', () => {
     events.raise(item, 'pointermove', { which: 1 });
 
     expect(stubCloned).toHaveBeenCalledTimes(1);
-    expect(stubCloned.mock.calls[0][2]).toEqual('copy');
+    expect(stubCloned.mock.calls[0][2]).toBe('copy');
     expect(stubCloned.mock.calls[0][0]).not.toBe(item);
     expect(stubCloned.mock.calls[0][0].nodeType).toEqual(item.nodeType);
     expect(stubCloned.mock.calls[0][1]).toEqual(item);
diff --git a/__tests__/lib/events.js b/__tests__/lib/events.js
@@ -10,5 +10,5 @@ const raise = (el, type, options) => {
 };
 
 module.exports = {
-  raise: raise,
+  raise,
 };
diff --git a/__tests__/public-api.spec.js b/__tests__/public-api.spec.js
@@ -3,6 +3,6 @@ const dragula = require('../src/dragula');
 
 describe('public-api', () => {
   it('public api matches expectation', () => {
-    expect(typeof dragula).toEqual('function');
+    expect(typeof dragula).toBe('function');
   });
 });
diff --git a/__tests__/remove.spec.js b/__tests__/remove.spec.js
@@ -34,7 +34,7 @@ describe('remove', () => {
     drake.start(item);
     drake.remove();
 
-    expect(div.children.length).toEqual(0);
+    expect(div.children).toHaveLength(0);
     expect(drake.dragging).toBeFalsy();
   });
 
@@ -79,7 +79,7 @@ describe('remove', () => {
 
     expect(drake.dragging).toBeFalsy();
     expect(stubCancel).toHaveBeenCalledTimes(1);
-    expect(stubCancel.mock.calls[0][0].className).toEqual('gu-transit');
+    expect(stubCancel.mock.calls[0][0].className).toBe('gu-transit');
     expect(stubCancel.mock.calls[0][0]).not.toEqual(item);
     expect(stubCancel.mock.calls[0][1]).toBeNull();
     expect(stubDragEnd).toHaveBeenCalledTimes(1);
diff --git a/package.json b/package.json
@@ -22,8 +22,8 @@
     "generate:styles:minify": "pnpm exec cleancss -O2 --source-map src/dragula.css --output dist/dragula.min.css",
     "lint": "pnpm run lint:tool:eslint; pnpm run lint:tool:prettier",
     "lint:fix": "pnpm run lint:tool:eslint --fix; pnpm run lint:tool:prettier --write",
-    "lint:tool:eslint": "pnpm exec eslint \"./src\" --color --ext .js --no-inline-config",
-    "lint:tool:prettier": "pnpm exec prettier \"**/*.{css,html,json,md}\" --list-different",
+    "lint:tool:eslint": "pnpm exec eslint --color --no-inline-config \"./{__tests__,src}/**/*.js\"",
+    "lint:tool:prettier": "pnpm exec prettier --list-different \"**/*.{css,html,json,md}\"",
     "test": "jest --maxWorkers=50%",
     "test:ci": "jest --silent --maxWorkers=50%",
     "test:watch": "jest --watchAll",
@@ -43,8 +43,11 @@
     "eslint-config-airbnb-base": "15.0.0",
     "eslint-config-prettier": "8.6.0",
     "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-jest": "27.2.1",
+    "eslint-plugin-jest-dom": "4.0.3",
     "eslint-plugin-prettier": "4.2.1",
     "eslint-plugin-promise": "6.1.1",
+    "eslint-plugin-testing-library": "5.9.1",
     "hihat": "2.6.4",
     "husky": "8.0.3",
     "jest": "29.3.1",

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`		`- "src/*.js": ["pnpm run lint:tool:eslint --fix", "git add ."],`
	`2`	`+ "{__tests__,src}/*/.js": ["pnpm run lint:tool:eslint --fix", "git add ."],`
`3`	`3`	`"*/.{css,html,json,md}": ["pnpm run lint:tool:prettier --write", "git add ."]`
`4`	`4`	`}`