@naturalcycles/dev-lib 16.0.2 → 16.2.0

package/cfg/vitest.config.mts

@@ -0,0 +1,119 @@
+import fs from 'node:fs'
+import type { InlineConfig } from 'vitest/node'
+
+let silent: boolean
+let testType: TestType = (process.env['TEST_TYPE'] as TestType) || 'unit'
+
+const runsInIDE = process.argv.some(
+  a => a === '--runTestsByPath' || a.includes('IDEA') || a.includes('Visual Studio'),
+)
+
+if (runsInIDE) {
+  silent = false
+
+  if (process.argv.some(a => a.endsWith('.integration.test.ts'))) {
+    testType = 'integration'
+  } else if (process.argv.some(a => a.endsWith('.manual.test.ts'))) {
+    testType = 'manual'
+  }
+} else {
+  silent = isRunningAllTests()
+}
+
+const isCI = !!process.env['CI']
+process.env.TZ = process.env.TZ || 'UTC'
+if (testType === 'unit') {
+  process.env['APP_ENV'] = process.env['APP_ENV'] || 'test'
+}
+
+// Set 'setupFiles' only if setup files exist
+const setupFiles: InlineConfig['setupFiles'] = []
+if (fs.existsSync(`./src/test/setupVitest.ts`)) {
+  setupFiles.push('./src/test/setupVitest.ts')
+}
+if (fs.existsSync(`./src/test/setupVitest.${testType}.ts`)) {
+  setupFiles.push(`./src/test/setupVitest.${testType}.ts`)
+}
+
+let include: InlineConfig['include']
+const exclude: InlineConfig['exclude'] = ['**/__exclude/**']
+
+if (testType === 'integration') {
+  include = ['{src,scripts}/**/*.integration.test.ts']
+} else if (testType === 'manual') {
+  include = ['{src,scripts}/**/*.manual.test.ts']
+} else {
+  // normal unit test
+  include = ['{src,scripts}/**/*.test.ts']
+  exclude.push('**/*.{integration,manual}.test.*')
+}
+
+if (silent) {
+  process.env['TEST_SILENT'] = 'true'
+}
+
+console.log('shared vitest config', { testType, silent, isCI, runsInIDE, include, exclude })
+
+/**
+ * Shared config for Vitest.
+ */
+export const sharedConfig: InlineConfig = {
+  watch: false,
+  // dir: 'src',
+  restoreMocks: true,
+  silent,
+  setupFiles,
+  logHeapUsage: true,
+  testTimeout: 60_000,
+  sequence: {
+    // todo: make it sort alphabetically
+  },
+  include,
+  exclude,
+  coverage: {
+    enabled: isCI && testType === 'unit',
+    reporter: ['html', 'lcov', 'json', !isCI && 'text'].filter(Boolean) as string[],
+    include: ['src/**/*.{ts,tsx}'],
+    exclude: [
+      '**/__exclude/**',
+      'scripts/**',
+      'public/**',
+      'src/index.*',
+      'src/test/**',
+      'src/typings/**',
+      'src/{env,environment,environments}/**',
+      'src/bin/**',
+      'src/vendor/**',
+      '**/*.test.*',
+      '**/*.script.*',
+      '**/*.module.*',
+      '**/*.mock.*',
+      '**/*.page.*',
+      '**/*.component.*',
+      '**/*.modal.*',
+    ],
+  },
+}
+
+/**
+ * Detects if vitest is run with all tests, or with selected individual tests.
+ */
+function isRunningAllTests(): boolean {
+  let vitestArg = false
+  let hasPositionalArgs = false
+  process.argv.forEach(a => {
+    if (a.includes('.bin/vitest')) {
+      vitestArg = true
+      return
+    }
+    if (!vitestArg) return
+    if (!a.startsWith('-')) {
+      hasPositionalArgs = true
+    }
+  })
+  // console.log({vitestArg, hasPositionalArgs}, process.argv)
+
+  return !hasPositionalArgs
+}
+
+type TestType = 'unit' | 'integration' | 'manual'

package/dist/bin/dev-lib.js

@@ -35,16 +35,21 @@ const commands = [
         desc: 'Clean ./dist and ./dist-esm, then run "tsc" in CJS and ESM modes, with --emit and --noCheck',
     },
     new prompts_1.Separator(), // test
-    { name: 'test', fn: test_util_1.runJest, desc: 'Run jest for *.test.ts files.' },
+    { name: 'test', fn: test_util_1.runTest, desc: 'Run vitest/jest for *.test.ts files.' },
     {
         name: 'test-integration',
-        fn: () => (0, test_util_1.runJest)({ integration: true }),
-        desc: 'Run jest for *.integration.test.ts files.',
+        fn: () => (0, test_util_1.runTest)({ integration: true }),
+        desc: 'Run vitest/jest for *.integration.test.ts files.',
+    },
+    {
+        name: 'test-manual',
+        fn: () => (0, test_util_1.runTest)({ manual: true }),
+        desc: 'Run vitest/jest for *.manual.test.ts files.',
     },
     {
         name: 'test-leaks',
-        fn: () => (0, test_util_1.runJest)({ leaks: true }),
-        desc: 'Run jest --detectLeaks for *.test.ts files.',
+        fn: () => (0, test_util_1.runTest)({ leaks: true }),
+        desc: 'Run vitest/jest --detectLeaks for *.test.ts files.',
     },
     new prompts_1.Separator(), // lint
     {
@@ -136,7 +141,7 @@ async function lbt() {
 }
 async function bt() {
     await tscAll();
-    (0, test_util_1.runJest)();
+    (0, test_util_1.runTest)();
 }
 async function tscAll() {
     await (0, build_util_1.runTSCInFolders)(['.', 'scripts', 'e2e'], ['--noEmit']);

package/dist/lint.util.js

@@ -182,20 +182,10 @@ function stylelintAll() {
     });
 }
 async function lintStagedCommand() {
-    // const cwd = process.cwd()
     const localConfig = `./lint-staged.config.js`;
     const sharedConfig = `${paths_1.cfgDir}/lint-staged.config.js`;
     const config = node_fs_1.default.existsSync(localConfig) ? localConfig : sharedConfig;
-    // if (!config) {
-    //   console.log(`lint-staged is skipped, because no ${localConfig} is found`)
-    //   return
-    // }
-    // await execWithArgs(`lint-staged`, [`--config`, config])
-    // const lintStaged = require('lint-staged')
-    // lint-staged is ESM since 12.0
-    // const lintStaged = await import('lint-staged')
-    // biome-ignore lint/security/noGlobalEval: ok
-    const { default: lintStaged } = await eval(`import('lint-staged')`);
+    const { default: lintStaged } = await import('lint-staged');
     const success = await lintStaged({
         configPath: config,
     });

package/dist/test.util.d.ts

@@ -1,10 +1,7 @@
-interface RunJestOpt {
+interface RunTestOptions {
     integration?: boolean;
     manual?: boolean;
     leaks?: boolean;
 }
-/**
- * 1. Adds `--silent` if running all tests at once.
- */
-export declare function runJest(opt?: RunJestOpt): void;
+export declare function runTest(opt?: RunTestOptions): void;
 export {};

package/dist/test.util.js

@@ -1,19 +1,51 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.runJest = runJest;
+exports.runTest = runTest;
 const tslib_1 = require("tslib");
 const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
 const js_lib_1 = require("@naturalcycles/js-lib");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
 const paths_1 = require("./paths");
+function runTest(opt = {}) {
+    if (nodeModuleExists('vitest')) {
+        runVitest(opt);
+        return;
+    }
+    if (nodeModuleExists('jest')) {
+        runJest(opt);
+        return;
+    }
+    console.log((0, nodejs_lib_1.dimGrey)(`vitest/jest not found, skipping tests`));
+}
+function runVitest(opt) {
+    const { integration, manual } = opt;
+    const processArgs = process.argv.slice(3);
+    const args = [...processArgs];
+    const { TZ = 'UTC' } = process.env;
+    const env = {
+        TZ,
+    };
+    if (integration) {
+        Object.assign(env, {
+            TEST_TYPE: 'integration',
+        });
+    }
+    else if (manual) {
+        Object.assign(env, {
+            TEST_TYPE: 'manual',
+        });
+    }
+    nodejs_lib_1.exec2.spawn('vitest', {
+        args: (0, js_lib_1._uniq)(args),
+        logFinish: false,
+        shell: false,
+        env,
+    });
+}
 /**
  * 1. Adds `--silent` if running all tests at once.
  */
-function runJest(opt = {}) {
-    if (!nodeModuleExists('jest')) {
-        console.log((0, nodejs_lib_1.dimGrey)(`node_modules/${(0, nodejs_lib_1.white)('jest')} not found, skipping tests`));
-        return;
-    }
+function runJest(opt) {
     const { CI, CPU_LIMIT, TZ = 'UTC', APP_ENV, JEST_NO_ALPHABETIC, JEST_SHARDS } = process.env;
     const cpuLimit = Number(CPU_LIMIT) || undefined;
     const { integration, manual, leaks } = opt;

package/dist/testing/testOffline.util.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.testOffline = testOffline;
 exports.jestOnline = jestOnline;
-const index_1 = require("./index");
 const LOCAL_HOSTS = ['localhost', '127.0.0.1'];
 const detectLeaks = process.argv.some(a => a.includes('detectLeaks'));
 let mitm;
@@ -11,10 +10,10 @@ let mitm;
  */
 function testOffline() {
     if (detectLeaks) {
-        (0, index_1.jestLog)('NOT applying testOffline() when --detectLeaks is on');
+        console.log('NOT applying testOffline() when --detectLeaks is on');
         return;
     }
-    (0, index_1.jestLog)('test offline mode');
+    console.log('test offline mode');
     const createMitm = require('mitm');
     mitm ||= createMitm();
     mitm.on('connect', (socket, opts) => {

package/dist/testing/testing.util.d.ts

@@ -1,3 +1,3 @@
 export declare function silentConsole(): void;
-export declare const jestLogger: import("@naturalcycles/js-lib").CommonLogger;
-export declare const jestLog: import("@naturalcycles/js-lib").CommonLogFunction;
+export declare const testLogger: import("@naturalcycles/js-lib").CommonLogger;
+export declare const testLog: import("@naturalcycles/js-lib").CommonLogFunction;

package/dist/testing/testing.util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.jestLog = exports.jestLogger = void 0;
+exports.testLog = exports.testLogger = void 0;
 exports.silentConsole = silentConsole;
 const js_lib_1 = require("@naturalcycles/js-lib");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
@@ -13,8 +13,8 @@ function silentConsole() {
     console.time = () => { };
     console.table = () => { };
 }
-exports.jestLogger = (0, js_lib_1.commonLoggerCreate)((_level, args) => {
-    if (process.env['JEST_SILENT'])
+exports.testLogger = (0, js_lib_1.commonLoggerCreate)((_level, args) => {
+    if (process.env['JEST_SILENT'] || process.env['TEST_SILENT'])
         return; // no-op
     process.stdout.write(args
         .map(a => (0, nodejs_lib_1._inspect)(a, {
@@ -22,4 +22,4 @@ exports.jestLogger = (0, js_lib_1.commonLoggerCreate)((_level, args) => {
     }))
         .join(' ') + '\n');
 });
-exports.jestLog = exports.jestLogger.log.bind(exports.jestLogger);
+exports.testLog = exports.testLogger.log.bind(exports.testLogger);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/dev-lib",
-  "version": "16.0.2",
+  "version": "16.2.0",
   "scripts": {
     "prepare": "husky",
     "tsn-debug": "tsn testScript.ts",
@@ -12,6 +12,7 @@
     "test": "tsn ./src/bin/dev-lib.ts test",
     "test-leaks": "tsn ./src/bin/dev-lib.ts test-leaks",
     "test-integration": "tsn ./src/bin/dev-lib.ts test-integration",
+    "test-manual": "tsn ./src/bin/dev-lib.ts test-manual",
     "lint": "tsn ./src/bin/dev-lib.ts lint",
     "up": "tsn ./src/bin/up.ts",
     "upnc": "tsn ./src/bin/upnc.ts"
@@ -47,13 +48,10 @@
     "yargs": "^17"
   },
   "devDependencies": {
-    "@types/jest": "^29",
-    "eslint-plugin-jest": "^28",
-    "jest": "^29",
-    "jest-junit": "^16",
+    "@vitest/coverage-v8": "^3",
     "stylelint": "^16",
     "stylelint-config-standard-scss": "^14",
-    "ts-jest": "^29"
+    "vitest": "^3"
   },
   "files": [
     "dist",