@naturalcycles/dev-lib 18.0.1 → 18.1.1

package/cfg/eslint-rules.js

@@ -31,7 +31,7 @@ export default {
         },
       },
     ],
-    '@typescript-eslint/consistent-type-imports': 0, // too noisy
+    '@typescript-eslint/consistent-type-imports': 2,
     '@typescript-eslint/consistent-type-exports': 2,
     '@typescript-eslint/consistent-type-assertions': 2,
     '@typescript-eslint/consistent-type-definitions': [2, 'interface'],

package/cfg/eslint-vitest-rules.js

@@ -0,0 +1,34 @@
+export default {
+  rules: {
+    'vitest/consistent-test-filename': 2,
+    'vitest/consistent-test-it': [
+      2,
+      {
+        fn: 'test',
+        withinDescribe: 'test',
+      },
+    ],
+    'vitest/expect-expect': 0,
+    'vitest/max-nested-describe': [2, { max: 3 }],
+    'vitest/no-alias-methods': 2,
+    'vitest/no-commented-out-tests': 0,
+    'vitest/no-duplicate-hooks': 2,
+    'vitest/no-test-return-statement': 2,
+    'vitest/padding-around-before-all-blocks': 2,
+    'vitest/padding-around-after-all-blocks': 2,
+    'vitest/padding-around-before-each-blocks': 2,
+    'vitest/padding-around-after-each-blocks': 2,
+    'vitest/padding-around-describe-blocks': 2,
+    'vitest/prefer-hooks-in-order': 2,
+    'vitest/prefer-hooks-on-top': 2,
+    'vitest/prefer-mock-promise-shorthand': 2,
+    'vitest/prefer-spy-on': 2,
+    'vitest/prefer-strict-boolean-matchers': 2,
+    'vitest/prefer-to-be': 2,
+    'vitest/prefer-to-contain': 2,
+    'vitest/prefer-to-have-length': 2,
+    'vitest/prefer-vi-mocked': 2,
+    'vitest/require-to-throw-message': 2,
+    'vitest/valid-expect-in-promise': 2,
+  },
+}

package/cfg/eslint.config.js

@@ -9,16 +9,19 @@ import eslint from '@eslint/js'
 import tseslint from 'typescript-eslint'
 import eslintPluginUnicorn from 'eslint-plugin-unicorn'
 import eslintPluginVue from 'eslint-plugin-vue'
+import eslintPluginVitest from '@vitest/eslint-plugin'
 import eslintPluginImportX from 'eslint-plugin-import-x'
 import eslintPluginSimpleImportSort from 'eslint-plugin-simple-import-sort'
 import eslintPluginJsdoc from 'eslint-plugin-jsdoc'
 import eslintPluginStylistic from '@stylistic/eslint-plugin'
 import eslintRules from './eslint-rules.js'
 import eslintVueRules from './eslint-vue-rules.js'
+import eslintVitestRules from './eslint-vitest-rules.js'
 import eslintPrettierRules from './eslint-prettier-rules.js'
 import eslintBiomeRules from './eslint-biome-rules.js'
 
 const defaultFiles = ['**/*.ts', '**/*.tsx', '**/*.cts', '**/*.mts']
+const testFiles = ['**/*.test.ts', '**/*.test.tsx', '**/*.test.cts', '**/*.test.mts']
 
 export default [
   {
@@ -46,6 +49,21 @@ export default [
     ...c,
     files: defaultFiles,
   })),
+  {
+    files: testFiles,
+    plugins: {
+      vitest: eslintPluginVitest,
+    },
+    settings: {
+      vitest: {
+        typecheck: true,
+      },
+    },
+    rules: {
+      ...eslintPluginVitest.configs.recommended.rules,
+      ...eslintVitestRules.rules,
+    },
+  },
   {
     files: defaultFiles,
     ...getConfig(),
@@ -64,7 +82,6 @@ function getConfig() {
       'simple-import-sort': eslintPluginSimpleImportSort,
       jsdoc: eslintPluginJsdoc,
       '@stylistic': eslintPluginStylistic,
-      // ...(hasJest ? { jest: require('eslint-plugin-jest') } : {}), // todo: eslint-plugin-vitest
     },
     languageOptions: {
       ecmaVersion: 'latest',
@@ -88,7 +105,6 @@ function getConfig() {
     rules: {
       ...eslintRules.rules,
       ...eslintVueRules.rules,
-      // ...(hasJest ? require('./eslint-jest-rules').rules : {}), // todo: vitest-rules
       ...eslintPrettierRules.rules, // disable eslint rules already covered by prettier
       ...eslintBiomeRules.rules, // disable eslint rules already covered by biome
     },

package/cfg/init/vitest.config.ts

@@ -1,8 +1,5 @@
-import { defineConfig } from 'vitest/config'
-import { sharedConfig } from '@naturalcycles/dev-lib/cfg/vitest.config.js'
+import { defineVitestConfig } from '@naturalcycles/dev-lib/cfg/vitest.config.js'
 
-export default defineConfig({
-  test: {
-    ...sharedConfig,
-  },
+export default defineVitestConfig({
+  // override here
 })

package/cfg/tsconfig.json

@@ -20,7 +20,7 @@
     // specifying these explicitly for better IDE compatibility (but they're on by default with module=nodenext)
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
-    // "verbatimModuleSyntax": true, // not enabled, since we'll need a lint rule to enforce `import type`
+    "verbatimModuleSyntax": true,
     // Faster compilation in general
     // Support for external compilers (e.g esbuild)
     // Speedup in Jest by using "isolatedModules" in 'ts-jest' config

package/cfg/vitest.config.d.ts

@@ -1,3 +1,15 @@
 import type { InlineConfig } from 'vitest/node'
 
+/**
+
+ Usage example:
+
+ export default defineVitestConfig({
+   // overrides here, e.g:
+   // bail: 1,
+ })
+
+ */
+export function defineVitestConfig(config?: Partial<InlineConfig>): InlineConfig
+
 export const sharedConfig: InlineConfig

package/cfg/vitest.config.js

@@ -1,12 +1,14 @@
 import fs from 'node:fs'
-
 import { VitestAlphabeticSequencer } from './vitestAlphabeticSequencer.js'
+import { defineConfig } from 'vitest/config'
+
 const runsInIDE = doesItRunInIDE()
 const testType = getTestType(runsInIDE)
 const silent = shouldBeSilent(runsInIDE)
 const setupFiles = getSetupFiles(testType)
 const { include, exclude } = getIncludeAndExclude(testType)
 const isCI = !!process.env['CI']
+const coverageEnabled = isCI && testType === 'unit'
 const junitReporterEnabled = isCI && testType !== 'manual'
 const maxWorkers = getMaxWorkers()
 const minWorkers = maxWorkers
@@ -14,6 +16,7 @@ const minWorkers = maxWorkers
 // UPD: it was not statistically significant, so, reverting back to forks which is more stable
 // UPD2: in a different experiment, threads show ~10% faster locally, consistently
 const pool = 'threads'
+
 process.env.TZ ||= 'UTC'
 
 if (testType === 'unit') {
@@ -24,16 +27,37 @@ if (silent) {
   process.env['TEST_SILENT'] = 'true'
 }
 
-console.log('shared vitest config', {
-  testType,
-  silent,
-  isCI,
-  runsInIDE,
-  include,
-  exclude,
-  pool,
-  maxWorkers,
-})
+/**
+ * Use it like this in your vitest.config.ts:
+ *
+ * export default defineVitestConfig({
+ *   // overrides here, e.g:
+ *   // bail: 1,
+ * })
+ */
+export function defineVitestConfig(config) {
+  const mergedConfig = defineConfig({
+    test: {
+      ...sharedConfig,
+      ...config,
+    },
+  })
+
+  const { silent, include, exclude, pool, maxWorkers } = mergedConfig.test
+
+  console.log({
+    testType,
+    silent,
+    isCI,
+    runsInIDE,
+    include,
+    exclude,
+    pool,
+    maxWorkers,
+  })
+
+  return mergedConfig
+}
 
 /**
  * Shared config for Vitest.
@@ -73,7 +97,7 @@ export const sharedConfig = {
   // outputFile location is specified for compatibility with the previous jest config
   outputFile: junitReporterEnabled ? `./tmp/jest/${testType}.xml` : undefined,
   coverage: {
-    enabled: isCI && testType === 'unit',
+    enabled: coverageEnabled,
     reporter: ['html', 'lcov', 'json', 'json-summary', !isCI && 'text'].filter(Boolean),
     include: ['src/**/*.{ts,tsx}'],
     exclude: [

package/dist/build.util.js

@@ -22,7 +22,7 @@ export async function runTSCInFolders(tsconfigPaths, args = [], parallel = true)
  */
 export async function runTSCInFolder(tsconfigPath, args = []) {
     if (!fs2.pathExists(tsconfigPath)) {
-        console.log(`Skipping to run tsc for ${tsconfigPath}, as it doesn't exist`);
+        // console.log(`Skipping to run tsc for ${tsconfigPath}, as it doesn't exist`)
         return;
     }
     await exec2.spawnAsync(`tsc`, {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/dev-lib",
   "type": "module",
-  "version": "18.0.1",
+  "version": "18.1.1",
   "scripts": {
     "prepare": "husky",
     "tsx-debug": "tsx scripts/testScript.ts",
@@ -28,6 +28,8 @@
     "@naturalcycles/nodejs-lib": "^14",
     "@stylistic/eslint-plugin": "^4",
     "@types/node": "^22",
+    "@vitest/coverage-v8": "^3",
+    "@vitest/eslint-plugin": "^1",
     "eslint": "^9",
     "eslint-plugin-import-x": "^4",
     "eslint-plugin-jsdoc": "^50",
@@ -47,7 +49,6 @@
   },
   "devDependencies": {
     "@types/mitm": "^1.3.8",
-    "@vitest/coverage-v8": "^3",
     "stylelint": "^16",
     "stylelint-config-standard-scss": "^14",
     "tsx": "^4",