@naturalcycles/dev-lib 13.2.3 → 13.4.1

package/cfg/eslint-jest-rules.js

@@ -0,0 +1,9 @@
+module.exports = {
+  rules: {
+    'jest/prefer-equality-matcher': 2,
+    'jest/prefer-spy-on': 2,
+    'jest/prefer-to-be': 2,
+    'jest/prefer-to-contain': 2,
+    'jest/consistent-test-it': [2, { fn: 'test', withinDescribe: 'test' }],
+  },
+}

package/cfg/eslint.config.js

@@ -3,6 +3,11 @@
  *
  * Shared eslint config.
  */
+
+// detect if jest is installed
+const hasJest = require('fs').existsSync('./node_modules/jest')
+// console.log({hasJest})
+
 module.exports = {
   env: {
     es2020: true,
@@ -33,8 +38,9 @@ module.exports = {
         // https://github.com/import-js/eslint-plugin-import/blob/main/config/typescript.js
         // 'plugin:import/typescript',
         './eslint-rules.js',
+        hasJest && './eslint-jest-rules.js',
         'prettier', // must be last! it only turns off eslint rules that conflict with prettier
-      ],
+      ].filter(Boolean),
       parser: '@typescript-eslint/parser',
       parserOptions: {
         project: ['tsconfig.json'],
@@ -48,9 +54,9 @@ module.exports = {
         '@typescript-eslint',
         // https://github.com/sweepline/eslint-plugin-unused-imports
         'unused-imports',
-        // 'jest', // add manually if needed!
+        hasJest && 'jest',
         'unicorn',
-      ],
+      ].filter(Boolean),
     },
     {
       files: ['*.vue'],

package/cfg/jest.config.js

@@ -79,6 +79,10 @@ module.exports = {
       // incremental: true,
       isolatedModules: true, // faster when run without cache (e.g in CI), 50s vs 83s for NCBackend3 right now
       babelConfig: false, // https://kulshekhar.github.io/ts-jest/user/config/babelConfig
+      tsconfig: {
+        sourceMap: true,
+        allowJs: true,
+      },
     },
   },
   testEnvironment: 'node',

package/dist/testing/expect.util.js

@@ -9,6 +9,7 @@ exports.expectResults = void 0;
  * ]).toMatchSnapshot()
  */
 function expectResults(fn, values) {
+    // eslint-disable-next-line jest/valid-expect
     return expect(new Map(values.map(v => [v, fn(v)])));
 }
 exports.expectResults = expectResults;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/dev-lib",
-  "version": "13.2.3",
+  "version": "13.4.1",
   "scripts": {
     "prepare": "husky install",
     "tsn-debug": "tsn testScript.ts",

package/readme.md

@@ -102,8 +102,7 @@ adds `--silent` (and `JEST_SILENT` env var) if all tests are run.
   `jest-junit` reporter. Includes fix for "CircleCI out of memory issue"
 - `test-integration`: runs `*.integration.test.ts` with `jest.integration-test.config.js` config.
 - `test-manual`: runs `*.manual.test.ts` with `jest.manual-test.config.js`.
-- `test-leaks`: runs Jest with `--logHeapUsage --detectOpenHandles --detectLeaks` (requires `weak`
-  module to be installed in target project).
+- `test-leaks`: runs Jest with `--logHeapUsage --detectOpenHandles --detectLeaks`.
 
 For unit tests (`yarn test`) these `setupFilesAfterEnv` will be used (if found) in that order:
 
@@ -196,14 +195,9 @@ These files are meant to be extended in target project, so act as _recommended d
 - `eslint.config.json`
 - `jest.config.js`
 
-## Extending eslint config
+## eslint
 
-### Jest
+Presence of `jest` is detected by checking if `node_modules/jest` exists.
 
-```js
-// .eslintrc.js
-module.exports = {
-  extends: ['plugin:jest/recommended'],
-  plugins: ['jest'],
-}
-```
+If exists - `eslint-plugin-jest` recommended config (plus opinionated `dev-lib`'s rules) are
+enabled. Otherwise disabled ( to not cause "jest not found" errors)