@naturalcycles/dev-lib 17.2.1 → 18.0.0

package/readme.md

@@ -17,7 +17,7 @@
 - ESLint
 - Biome
 - Stylelint
-- Jest / Vitest
+- Vitest
 - ktlint
 - actionlint
 - lint-staged
@@ -46,7 +46,7 @@ UPD: these tools/linters would use default configs if absent:
 
 These tools require a respective config to run, otherwise they're not run. List of configs:
 
-- `jest.config.js`
+- `vitest.config.js`
 - `prettier.config.js`
 - `eslint.config.js` (eslint FLAT config)
 - `stylelint.config.js`
@@ -112,7 +112,7 @@ automatically in any environment. They're useful to run tests manually every now
 
 All test commands set `TZ=UTC`. You can override it by providing `TZ` env variable **before**
 running a test command. Adds `APP_ENV=test` env var (for all runs except integration). Automatically
-adds `--silent` (and `JEST_SILENT` env var) if all tests are run.
+adds `--silent` (and `TEST_SILENT` env var) if all tests are run.
 
 - `test`: runs unit tests (all tests _except_ `*.integration.test.ts` and `*.manual.test.ts`).
   Detects `CI` env variable, adds `--coverage` if in CI. Uses `default` reporter in `!CI`, otherwise
@@ -123,34 +123,19 @@ adds `--silent` (and `JEST_SILENT` env var) if all tests are run.
 
 For unit tests (`yarn test`) these `setupFilesAfterEnv` will be used (if found) in that order:
 
-- `<rootDir>/src/test/setupJest.ts`
-- `<rootDir>/src/test/setupJest.unit.ts`
+- `<rootDir>/src/test/setupVitest.ts`
+- `<rootDir>/src/test/setupVitest.unit.ts`
 
 For integration tests (`yarn test-integration`) these `setupFilesAfterEnv` will be used (if found)
 in that order:
 
-- `<rootDir>/src/test/setupJest.ts`
-- `<rootDir>/src/test/setupJest.integration.ts`
+- `<rootDir>/src/test/setupVitest.ts`
+- `<rootDir>/src/test/setupVitest.integration.ts`
 
 For manual tests:
 
-- `<rootDir>/src/test/setupJest.ts`
-- `<rootDir>/src/test/setupJest.manual.ts`
-
-`yarn dev-lib test` runs tests in alphabetic order by default (internally it points
-`--testSequencer` to a pre-defined sequencer file that sorts all filenames alphabetically). Set
-`JEST_NO_ALPHABETIC` env variable to disable it.
-
-##### Shard support
-
-Jest 28 introduced [--shard](https://jestjs.io/docs/cli#--shard) feature.
-
-Set `JEST_SHARDS` environment variable (e.g `export JEST_SHARDS=3`), so that your `yarn test*`
-commands will automatically split your tests by N number of shards and execute them **one after
-another** (serially, **not** in parallel). Might be helpful to avoid Jest's notorious memory leaks.
-
-If you need to execute shards **in parallel**, you can follow e.g
-[this instruction](https://medium.com/@mfreundlich1/speed-up-your-jest-tests-with-shards-776e9f02f637).
+- `<rootDir>/src/test/setupVitest.ts`
+- `<rootDir>/src/test/setupVitest.manual.ts`
 
 #### Lint commands
 

package/cfg/eslint-jest-rules.js

@@ -1,14 +0,0 @@
-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' }],
-    'jest/expect-expect': 0,
-    'jest/no-commented-out-tests': 0,
-    'jest/no-export': 2,
-    'jest/no-conditional-expect': 0,
-    'jest/no-disabled-tests': 0,
-  },
-}

package/cfg/jest.alphabetic.sequencer.js

@@ -1,13 +0,0 @@
-const Sequencer = require('@jest/test-sequencer').default
-
-class CustomSequencer extends Sequencer {
-  sort(tests) {
-    // console.log('jest.alphabetic.sequencer.js is used')
-    // Test structure information
-    // https://github.com/facebook/jest/blob/6b8b1404a1d9254e7d5d90a8934087a9c9899dab/packages/jest-runner/src/types.ts#L17-L21
-    const copyTests = Array.from(tests)
-    return copyTests.sort((testA, testB) => (testA.path > testB.path ? 1 : -1))
-  }
-}
-
-module.exports = CustomSequencer

package/cfg/jest.config.js

@@ -1,139 +0,0 @@
-/**
- * Default config for jest.
- * Extendable.
- */
-
-const fs = require('node:fs')
-
-const runInIDE = process.argv.some(
-  a => a === '--runTestsByPath' || a.includes('IDEA') || a.includes('Visual Studio'),
-)
-const ideIntegrationTest = runInIDE && process.argv.some(a => a.endsWith('.integration.test.ts'))
-const ideManualTest = runInIDE && process.argv.some(a => a.endsWith('.manual.test.ts'))
-const { CI, GITHUB_ACTIONS } = process.env
-const cwd = process.cwd()
-
-// Set 'setupFilesAfterEnv' only if it exists
-const setupFilesAfterEnv = []
-if (fs.existsSync(`${cwd}/src/test/setupJest.ts`)) {
-  setupFilesAfterEnv.push('<rootDir>/src/test/setupJest.ts')
-}
-
-if (ideIntegrationTest) {
-  if (fs.existsSync(`${cwd}/src/test/setupJest.integration.ts`)) {
-    setupFilesAfterEnv.push('<rootDir>/src/test/setupJest.integration.ts')
-  }
-} else if (ideManualTest) {
-  if (fs.existsSync(`${cwd}/src/test/setupJest.manual.ts`)) {
-    setupFilesAfterEnv.push('<rootDir>/src/test/setupJest.manual.ts')
-  }
-} else {
-  if (fs.existsSync(`${cwd}/src/test/setupJest.unit.ts`)) {
-    setupFilesAfterEnv.push('<rootDir>/src/test/setupJest.unit.ts')
-  }
-}
-
-const testMatch = ['<rootDir>/src/**/*.test.ts?(x)']
-const roots = ['<rootDir>/src']
-const scriptDirExists = fs.existsSync(`${cwd}/scripts`)
-if (scriptDirExists) {
-  testMatch.push('<rootDir>/scripts/**/*.test.ts?(x)')
-  roots.push('<rootDir>/scripts')
-}
-
-const testPathIgnorePatterns = ['<rootDir>/.*/__exclude/', '<rootDir>/src/environments/']
-
-// console.log({argv: process.argv})
-
-if (runInIDE) {
-  console.log({ runInIDE, ideIntegrationTest, ideManualTest })
-  process.env.APP_ENV = process.env.APP_ENV || 'test'
-  process.env.TZ = process.env.TZ || 'UTC'
-} else {
-  // This allows to run integration/manual tests in IDE
-  testPathIgnorePatterns.push('\\.integration\\.test\\.ts$', '\\.manual\\.test\\.ts$')
-}
-
-/** @typedef {import('ts-jest/dist/types')} */
-module.exports = {
-  transform: {
-    // '^.+\\.js$': 'babel-jest',
-    '^.+\\.tsx?$': [
-      'ts-jest',
-      {
-        diagnostics: false,
-        // compilerHost: true, // disabled, cause its effects are not detected/understood yet
-        // 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,
-        },
-      },
-    ],
-    // example (experimental):
-    // '^.+\\.ts$': '@naturalcycles/dev-lib/cfg/jest.esbuild.transformer.js',
-  },
-  transformIgnorePatterns: ['/node_modules/'], // Jest default value
-  testMatch,
-  roots,
-  rootDir: cwd,
-  testPathIgnorePatterns,
-  moduleFileExtensions: ['js', 'jsx', 'ts', 'tsx', 'd.ts', 'json'],
-  moduleNameMapper: {
-    // should match aliases from tsconfig.json
-    // as explained here: https://alexjoverm.github.io/2017/10/07/Enhance-Jest-configuration-with-Module-Aliases/
-    '@src/(.*)$': '<rootDir>/src/$1',
-  },
-  skipNodeResolution: true,
-  testEnvironment: 'node',
-  errorOnDeprecated: true,
-  restoreMocks: true,
-  unmockedModulePathPatterns: [],
-  setupFilesAfterEnv,
-  workerIdleMemoryLimit: '800MB', // workaround for this: https://github.com/facebook/jest/issues/11956
-  collectCoverageFrom: [
-    'src/**/*.{ts,tsx}',
-    '!**/__exclude/**',
-    '!src/index.{ts,tsx}',
-    '!src/test/**',
-    '!src/typings/**',
-    '!scripts/**',
-    '!src/env/**',
-    '!src/environment/**',
-    '!src/environments/**',
-    '!src/env/**',
-    '!src/bin/**',
-    '!src/vendor/**',
-    '!public/**',
-    '!**/*.test.ts',
-    '!**/*.script.ts',
-    '!**/*.module.ts',
-    '!**/*.mock.ts',
-    '!**/*.page.{ts,tsx}',
-    '!**/*.component.{ts,tsx}',
-    '!**/*.modal.{ts,tsx}',
-  ],
-  // default: ["clover", "json", "lcov", "text"]
-  coverageReporters: ['clover', 'json', 'json-summary', 'lcov', !CI && 'text'].filter(Boolean),
-  // CI: only jest-junit reporter (no default)
-  // not-CI: only default reporter, but not jest-junit
-  reporters: [
-    'default',
-    CI && [
-      'jest-junit',
-      {
-        suiteName: 'jest tests',
-        outputDirectory: './tmp/jest',
-        outputName: 'unit.xml',
-        suiteNameTemplate: '{filepath}',
-        classNameTemplate: '{filename} - {classname}',
-        titleTemplate: '{title}',
-        ancestorSeparator: ' ',
-      },
-    ],
-    GITHUB_ACTIONS && 'github-actions', // https://jestjs.io/blog/2022/04/25/jest-28#github-actions-reporter
-  ].filter(Boolean),
-  prettierPath: null, // todo: remove when jest has fixed it https://github.com/jestjs/jest/issues/14305
-}

package/cfg/jest.esbuild.transformer.js

@@ -1,37 +0,0 @@
-const { transformSync } = require('esbuild')
-
-const debug = !!process.env.DEBUG_ESBUILD
-
-// https://esbuild.github.io/api/
-module.exports = {
-  process(src, filename) {
-    if (debug) {
-      console.log(filename)
-    }
-
-    const result = transformSync(src, {
-      sourcefile: filename,
-      loader: 'ts',
-      // platform: 'node',
-      format: 'cjs',
-      target: 'es2020',
-      sourcemap: true,
-      //     tsconfigRaw: `{
-      //   "compilerOptions": {
-      //     "esModuleInterop": false,
-      //   },
-      // }`,
-    })
-
-    // console.log(result.code)
-
-    if (result.warnings.length) {
-      console.log(...result.warnings)
-    }
-
-    return {
-      code: result.code,
-      map: result.map,
-    }
-  },
-}

package/cfg/jest.integration-test.config.js

@@ -1,41 +0,0 @@
-/**
- * "Integration test" config for jest.
- * Extendable.
- */
-
-const fs = require('node:fs')
-const { CI, GITHUB_ACTIONS } = process.env
-const cwd = process.cwd()
-
-// Set 'setupFilesAfterEnv' only if it exists
-const setupFilesAfterEnv = []
-if (fs.existsSync(`${cwd}/src/test/setupJest.ts`)) {
-  setupFilesAfterEnv.push('<rootDir>/src/test/setupJest.ts')
-}
-if (fs.existsSync(`${cwd}/src/test/setupJest.integration.ts`)) {
-  setupFilesAfterEnv.push('<rootDir>/src/test/setupJest.integration.ts')
-}
-
-/** @typedef {import('ts-jest/dist/types')} */
-module.exports = {
-  ...require('./jest.config'),
-  testMatch: ['<rootDir>/src/**/*.integration.test.ts'],
-  testPathIgnorePatterns: ['<rootDir>/.*/__exclude/'],
-  setupFilesAfterEnv,
-  reporters: [
-    'default',
-    CI && [
-      'jest-junit',
-      {
-        suiteName: 'jest tests',
-        outputDirectory: './tmp/jest',
-        outputName: 'integration.xml',
-        suiteNameTemplate: '{filepath}',
-        classNameTemplate: '{classname}',
-        titleTemplate: '{title}',
-        ancestorSeparator: ' ',
-      },
-    ],
-    GITHUB_ACTIONS && 'github-actions',
-  ].filter(Boolean),
-}

package/cfg/jest.manual-test.config.js

@@ -1,25 +0,0 @@
-/**
- * "Manual test" config for jest.
- * Extendable.
- */
-
-const fs = require('node:fs')
-const cwd = process.cwd()
-
-// Set 'setupFilesAfterEnv' only if it exists
-const setupFilesAfterEnv = []
-if (fs.existsSync(`${cwd}/src/test/setupJest.ts`)) {
-  setupFilesAfterEnv.push('<rootDir>/src/test/setupJest.ts')
-}
-if (fs.existsSync(`${cwd}/src/test/setupJest.manual.ts`)) {
-  setupFilesAfterEnv.push('<rootDir>/src/test/setupJest.manual.ts')
-}
-
-/** @typedef {import('ts-jest/dist/types')} */
-module.exports = {
-  ...require('./jest.config'),
-  testMatch: ['<rootDir>/src/**/*.manual.test.ts'],
-  testPathIgnorePatterns: ['<rootDir>/.*/__exclude/'],
-  setupFilesAfterEnv,
-  reporters: ['default'],
-}

package/dist/testing/time.util.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MOCK_TS_2018_06_21 = void 0;
-exports.mockTime = mockTime;
-exports.resetTime = resetTime;
-exports.MOCK_TS_2018_06_21 = 1_529_539_200;
-/**
- * Locks time-related functions to return always same time.
- * For deterministic tests.
- */
-function mockTime(ts = exports.MOCK_TS_2018_06_21) {
-    const timekeeper = require('timekeeper');
-    timekeeper.freeze(ts * 1000);
-}
-function resetTime() {
-    const timekeeper = require('timekeeper');
-    timekeeper.reset();
-}