@naturalcycles/dev-lib 20.16.1 → 20.18.0

package/cfg/biome.jsonc

@@ -3,18 +3,12 @@
   "root": false,
   "files": {
     "includes": [
-      "*",
-      "src/**",
-      "scripts/**",
-      "!**/*.html",
-      "!**/*.css",
-      "!**/*.scss",
-      "!**/tsconfig.json",
-      "!**/tsconfig.*.json",
+      "**/*.ts",
+      "**/*.tsx",
+      "**/*.js",
+      "**/*.jsx",
       "!**/__exclude",
-      "!**/try.ts",
-      "!**/*.compact.json",
-      "!**/*.mock.json"
+      "!**/try.ts"
     ]
   },
   "formatter": {

package/cfg/oxlint.config.json

@@ -277,6 +277,7 @@
     "vitest/prefer-spy-on": 2,
     "vitest/prefer-to-be": 2,
     "vitest/prefer-to-contain": 2,
+    "vitest/consistent-test-filename": 2,
     "jest/consistent-test-it": [
       2,
       {

package/cfg/vitest.config.d.ts

@@ -10,10 +10,15 @@ import type { InlineConfig } from 'vitest/node'
    // bail: 1,
  })
 
+ Pass `import.meta.dirname` as cwd if running from a monorepo.
+
  */
 export function defineVitestConfig(config?: Partial<ViteUserConfig>, cwd?: string): ViteUserConfig
 
-export const sharedConfig: InlineConfig
+/**
+ * Pass `import.meta.dirname` as cwd if running from a monorepo.
+ */
+export function getSharedConfig(cwd?: string): InlineConfig
 
 export const CollectReporter: any
 export const SummaryReporter: any

package/cfg/vitest.config.js

@@ -37,13 +37,10 @@ if (silent) {
  * })
  */
 export function defineVitestConfig(config, cwd) {
-  const setupFiles = getSetupFiles(testType, cwd)
-
   const mergedConfig = defineConfig({
     ...config,
     test: {
-      ...sharedConfig,
-      setupFiles,
+      ...getSharedConfig(cwd),
       ...config?.test,
     },
   })
@@ -70,65 +67,67 @@ export function defineVitestConfig(config, cwd) {
 /**
  * Shared config for Vitest.
  */
-export const sharedConfig = {
-  pool,
-  maxWorkers,
-  isolate: false,
-  watch: false,
-  // dir: 'src',
-  restoreMocks: true,
-  silent,
-  setupFiles: getSetupFiles(testType),
-  logHeapUsage: true,
-  testTimeout: 60_000,
-  slowTestThreshold: isCI ? 500 : 300, // higher threshold in CI
-  sequence: {
-    sequencer: VitestAlphabeticSequencer,
-    // shuffle: {
-    //   files: true,
-    //   tests: false,
-    // },
-    // seed: 1, // this makes the order of tests deterministic (but still not alphabetic)
-  },
-  include,
-  exclude,
-  reporters: [
-    'default',
-    new SummaryReporter(),
-    junitReporterEnabled && [
-      'junit',
-      {
-        suiteName: `${testType} tests`,
-        // classNameTemplate: '{filename} - {classname}',
-      },
-    ],
-  ].filter(Boolean),
-  // outputFile location is specified for compatibility with the previous jest config
-  outputFile: junitReporterEnabled ? `./tmp/jest/${testType}.xml` : undefined,
-  coverage: {
-    enabled: coverageEnabled,
-    reporter: ['html', 'lcov', 'json', 'json-summary', !isCI && 'text'].filter(Boolean),
-    include: ['src/**/*.{ts,tsx}'],
-    exclude: [
-      '**/__exclude/**',
-      'scripts/**',
-      'public/**',
-      'src/index.{ts,tsx}',
-      'src/test/**',
-      'src/typings/**',
-      'src/{env,environment,environments}/**',
-      'src/bin/**',
-      'src/vendor/**',
-      '**/*.test.*',
-      '**/*.script.*',
-      '**/*.module.*',
-      '**/*.mock.*',
-      '**/*.page.{ts,tsx}',
-      '**/*.component.{ts,tsx}',
-      '**/*.directive.{ts,tsx}',
-      '**/*.modal.{ts,tsx}',
-    ],
-  },
+export function getSharedConfig(cwd) {
+  return {
+    pool,
+    maxWorkers,
+    isolate: false,
+    watch: false,
+    // dir: 'src',
+    restoreMocks: true,
+    silent,
+    setupFiles: getSetupFiles(testType, cwd),
+    logHeapUsage: true,
+    testTimeout: 60_000,
+    slowTestThreshold: isCI ? 500 : 300, // higher threshold in CI
+    sequence: {
+      sequencer: VitestAlphabeticSequencer,
+      // shuffle: {
+      //   files: true,
+      //   tests: false,
+      // },
+      // seed: 1, // this makes the order of tests deterministic (but still not alphabetic)
+    },
+    include,
+    exclude,
+    reporters: [
+      'default',
+      new SummaryReporter(),
+      junitReporterEnabled && [
+        'junit',
+        {
+          suiteName: `${testType} tests`,
+          // classNameTemplate: '{filename} - {classname}',
+        },
+      ],
+    ].filter(Boolean),
+    // outputFile location is specified for compatibility with the previous jest config
+    outputFile: junitReporterEnabled ? `./tmp/jest/${testType}.xml` : undefined,
+    coverage: {
+      enabled: coverageEnabled,
+      reporter: ['html', 'lcov', 'json', 'json-summary', !isCI && 'text'].filter(Boolean),
+      include: ['src/**/*.{ts,tsx}'],
+      exclude: [
+        '**/__exclude/**',
+        'scripts/**',
+        'public/**',
+        'src/index.{ts,tsx}',
+        'src/test/**',
+        'src/typings/**',
+        'src/{env,environment,environments}/**',
+        'src/bin/**',
+        'src/vendor/**',
+        '**/*.test.*',
+        '**/*.script.*',
+        '**/*.module.*',
+        '**/*.mock.*',
+        '**/*.page.{ts,tsx}',
+        '**/*.component.{ts,tsx}',
+        '**/*.directive.{ts,tsx}',
+        '**/*.modal.{ts,tsx}',
+      ],
+    },
+  }
 }
 
 function doesItRunInIDE() {
@@ -184,14 +183,14 @@ function isRunningAllTests() {
   return !hasPositionalArgs
 }
 
-function getSetupFiles(testType, cwd = '.') {
+function getSetupFiles(testType, cwd = process.cwd()) {
   // Set 'setupFiles' only if setup files exist
   const setupFiles = []
   if (fs.existsSync(`${cwd}/src/test/setupVitest.ts`)) {
-    setupFiles.push('./src/test/setupVitest.ts')
+    setupFiles.push(`${cwd}/src/test/setupVitest.ts`)
   }
   if (fs.existsSync(`${cwd}/src/test/setupVitest.${testType}.ts`)) {
-    setupFiles.push(`./src/test/setupVitest.${testType}.ts`)
+    setupFiles.push(`${cwd}/src/test/setupVitest.${testType}.ts`)
   }
   return setupFiles
 }

package/dist/bin/dev-lib.js

@@ -5,17 +5,23 @@ import { _assert } from '@naturalcycles/js-lib/error/assert.js';
 import { fs2 } from '@naturalcycles/nodejs-lib/fs2';
 import { runScript } from '@naturalcycles/nodejs-lib/runScript';
 import { buildCopy, buildProd, runTSCInFolders } from '../build.util.js';
-import { eslintAll, lintAllCommand, lintStagedCommand, runBiome, runCommitlintCommand, runOxlint, runPrettier, stylelintAll, } from '../lint.util.js';
+import { runCommitlint } from '../commitlint.js';
+import { eslintAll, lintAllCommand, lintStagedCommand, requireOxlintConfig, runBiome, runOxlint, runPrettier, stylelintAll, } from '../lint.util.js';
 import { runTest } from '../test.util.js';
 const commands = [
     new Separator(), // build
+    { name: 'check', fn: check, desc: '"Run all possible checks": lint, typecheck, then test.' },
+    { name: 'bt', fn: bt, desc: 'Build & Test: run "typecheck" (via oxlint) and then "test".' },
     {
         name: 'typecheck',
-        fn: typecheck,
-        desc: 'Run typecheck (tsc) in folders (src, scripts, e2e) if there is tsconfig.json present',
+        fn: typecheckWithOxlint,
+        desc: 'Run typecheck via oxlint --type-aware',
+    },
+    {
+        name: 'typecheck-with-tsc',
+        fn: typecheckWithTSC,
+        desc: 'Run typecheck (tsc) in folders (src, scripts, e2e) if there is tsconfig.json present. Deprecated, use oxlint type-checking instead.',
     },
-    { name: 'bt', fn: bt, desc: 'Build & Test: run "typecheck" (tsc) and then "test".' },
-    { name: 'check', fn: lbt, desc: '"Run all possible checks": lint, typecheck, then test.' },
     {
         name: 'build',
         fn: buildProd,
@@ -100,7 +106,7 @@ const commands = [
         desc: 'Run stylelint with auto-fix disabled.',
     },
     { name: 'stylelint-no-fix', cliOnly: true, fn: () => stylelintAll(false) },
-    { name: 'commitlint', fn: runCommitlintCommand, desc: 'Run commitlint.', cliOnly: true },
+    { name: 'commitlint', fn: runCommitlint, desc: 'Run commitlint.', cliOnly: true },
     new Separator(), // interactive-only
     {
         name: 'exit',
@@ -145,15 +151,20 @@ runScript(async () => {
     }
     await commandMap[cmd].fn();
 });
-async function lbt() {
+async function check() {
     await lintAllCommand();
-    await bt();
+    runTest();
 }
 async function bt() {
-    await typecheck();
+    await typecheckWithOxlint();
     runTest();
 }
-async function typecheck() {
+async function typecheckWithOxlint() {
+    requireOxlintConfig();
+    const fix = !CI;
+    runOxlint(fix);
+}
+async function typecheckWithTSC() {
     await runTSCInFolders(['src', 'scripts', 'e2e'], ['--noEmit']);
 }
 async function cleanDist() {

package/dist/build.util.d.ts

@@ -1,11 +1,9 @@
 export declare function buildProd(): Promise<void>;
 /**
  * Use 'src' to indicate root.
+ *
+ * @deprecated - oxlint should be used for type-checking instead, it's faster.
  */
 export declare function runTSCInFolders(dirs: string[], args?: string[], parallel?: boolean): Promise<void>;
-/**
- * Pass 'src' to run in root.
- */
-export declare function runTSCInFolder(dir: string, args?: string[]): Promise<void>;
 export declare function runTSCProd(args?: string[]): Promise<void>;
 export declare function buildCopy(): void;

package/dist/build.util.js

@@ -11,6 +11,8 @@ export async function buildProd() {
 }
 /**
  * Use 'src' to indicate root.
+ *
+ * @deprecated - oxlint should be used for type-checking instead, it's faster.
  */
 export async function runTSCInFolders(dirs, args = [], parallel = true) {
     if (parallel) {
@@ -25,7 +27,7 @@ export async function runTSCInFolders(dirs, args = [], parallel = true) {
 /**
  * Pass 'src' to run in root.
  */
-export async function runTSCInFolder(dir, args = []) {
+async function runTSCInFolder(dir, args = []) {
     let configDir = dir;
     if (dir === 'src') {
         configDir = '';

package/dist/commitlint.d.ts

@@ -0,0 +1,15 @@
+import { type DevLibCommitlintConfig } from './config.js';
+/**
+ * Validates the commit message,
+ * which is read from a file, passed as process.argv.at(-1)
+ */
+export declare function runCommitlint(): void;
+/**
+ * Commit message validator following Conventional Commits specification.
+ * https://www.conventionalcommits.org/
+ */
+export declare function validateCommitMessage(input: string, cfg?: DevLibCommitlintConfig): CommitMessageValidationResponse;
+export interface CommitMessageValidationResponse {
+    valid: boolean;
+    errors: string[];
+}

package/dist/commitlint.js

@@ -0,0 +1,106 @@
+import { _assert } from '@naturalcycles/js-lib/error';
+import { fs2 } from '@naturalcycles/nodejs-lib/fs2';
+import { readDevLibConfigIfPresent } from './config.js';
+const ALLOWED_TYPES = new Set([
+    'feat',
+    'fix',
+    'chore',
+    'refactor',
+    'docs',
+    'style',
+    'test',
+    'perf',
+    'ci',
+    'build',
+    'revert',
+]);
+const SUBJECT_MAX_LENGTH = 120; // Only applies to subject line (first line)
+/**
+ * Validates the commit message,
+ * which is read from a file, passed as process.argv.at(-1)
+ */
+export function runCommitlint() {
+    //  || '.git/COMMIT_EDITMSG' // fallback is unnecessary, first argument should be always present
+    const arg1 = process.argv.at(-1);
+    _assert(arg1, 'dev-lib commitlint2 is called with $1 (first argument) missing');
+    console.log({ arg1 });
+    fs2.requireFileToExist(arg1);
+    const msg = fs2.readText(arg1);
+    console.log({ msg });
+    const devLibCfg = readDevLibConfigIfPresent();
+    console.log({ devLibCfg });
+    const { valid, errors } = validateCommitMessage(msg, devLibCfg.commitlint);
+    if (valid) {
+        console.log('✓ Valid commit message');
+        return;
+    }
+    console.error('✗ Invalid commit message:');
+    for (const err of errors) {
+        console.error(`  - ${err}`);
+    }
+    process.exit(1);
+}
+/**
+ * Commit message validator following Conventional Commits specification.
+ * https://www.conventionalcommits.org/
+ */
+export function validateCommitMessage(input, cfg = {}) {
+    const errors = [];
+    const msg = input.trim();
+    if (!msg) {
+        return { valid: false, errors: ['Commit message is empty'] };
+    }
+    const lines = msg.split('\n');
+    const subjectLine = lines[0];
+    // Step 1: Validate subject line format
+    // Pattern: type(scope)!: description  OR  type!: description  OR  type(scope): description  OR  type: description
+    const subjectPattern = /^(\w+)(?:\(([^)]+)\))?(!)?\s*:\s*(.+)$/;
+    const match = subjectLine.match(subjectPattern);
+    if (!match) {
+        errors.push(`Subject line must match format: type(scope): description\n` +
+            `  Got: "${subjectLine}"\n` +
+            `  Examples: "feat(auth): add login", "fix: resolve crash"`);
+        return { valid: false, errors };
+    }
+    const [, type, scope, _breaking, description] = match;
+    // Step 2: Validate type
+    if (!ALLOWED_TYPES.has(type)) {
+        errors.push(`Invalid type "${type}". Allowed types: ${[...ALLOWED_TYPES].join(', ')}`);
+    }
+    // Step 3: Validate subject line length
+    if (subjectLine.length > SUBJECT_MAX_LENGTH) {
+        errors.push(`Subject line too long: ${subjectLine.length} chars (max ${SUBJECT_MAX_LENGTH})`);
+    }
+    // Step 4: Validate description is not empty
+    if (!description?.trim()) {
+        errors.push('Description after colon cannot be empty');
+    }
+    // Step 5: Validate description doesn't start with capital letter (conventional style)
+    // Disabled: many existing commits use capitals
+    // if (description && /^[A-Z]/.test(description.trim())) {
+    //   errors.push('Description should start with lowercase letter')
+    // }
+    // Step 6: Validate blank line between subject and body (if body exists)
+    if (lines.length > 1 && lines[1].trim() !== '') {
+        errors.push('There must be a blank line between subject and body');
+    }
+    // Note: No line length validation for body lines - they can be any length
+    // Step 7: scope validation
+    if (cfg.requireScope && !scope) {
+        errors.push('Scope is required');
+    }
+    if (scope && cfg.allowedScopes && !cfg.allowedScopes.includes(scope)) {
+        errors.push(`Scope must be one of the allowed scopes:\n${cfg.allowedScopes.join('\n')}`);
+    }
+    return {
+        valid: errors.length === 0,
+        errors,
+        // parsed: {
+        //   type,
+        //   scope: scope || null,
+        //   breaking: !!breaking,
+        //   description: description?.trim(),
+        //   body: lines.slice(2).join('\n').trim() || null,
+        // },
+    };
+}

package/dist/config.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Returns an empty config if the file is absent.
+ */
+export declare function readDevLibConfigIfPresent(): DevLibConfig;
+export interface DevLibConfig {
+    commitlint?: DevLibCommitlintConfig;
+}
+export interface DevLibCommitlintConfig {
+    /**
+     * Defaults to false.
+     * If set to true - commit scope becomes required.
+     */
+    requireScope?: boolean;
+    /**
+     * If defined - commitlint (which is run on git precommit hook) will validate that
+     * the scope is one of the allowedScopes.
+     * Empty (not present) scope will pass this rule, as it depends on the `requireScope` option instead.
+     */
+    allowedScopes?: string[];
+}

package/dist/config.js

@@ -0,0 +1,20 @@
+import { AjvSchema, j } from '@naturalcycles/nodejs-lib/ajv';
+import { fs2 } from '@naturalcycles/nodejs-lib/fs2';
+const devLibConfigPath = 'dev-lib.config.js';
+/**
+ * Returns an empty config if the file is absent.
+ */
+export function readDevLibConfigIfPresent() {
+    const cfg = fs2.pathExists(devLibConfigPath) ? fs2.readJson(devLibConfigPath) : {};
+    return devLibConfigSchema.validate(cfg);
+}
+const devLibConfigSchema = AjvSchema.create(j.object({
+    commitlint: j.object
+        .infer({
+        requireScope: j.boolean().optional(),
+        allowedScopes: j.array(j.string()).optional(),
+    })
+        .optional(),
+}), {
+    inputName: 'dev-lib.config.js',
+});

package/dist/lint.util.d.ts

@@ -12,6 +12,8 @@ interface EslintAllOptions {
  */
 export declare function eslintAll(opt?: EslintAllOptions): void;
 export declare function runOxlint(fix?: boolean): void;
+export declare function requireOxlintConfig(): void;
+export declare function hasOxlintConfig(): boolean;
 interface RunPrettierOptions {
     experimentalCli?: boolean;
     fix?: boolean;
@@ -19,7 +21,6 @@ interface RunPrettierOptions {
 export declare function runPrettier(opt?: RunPrettierOptions): void;
 export declare function stylelintAll(fix?: boolean): void;
 export declare function lintStagedCommand(): Promise<void>;
-export declare function runCommitlintCommand(): void;
 export declare function requireActionlintVersion(): void;
 export declare function getActionLintVersion(): SemVerString | undefined;
 export declare function runBiome(fix?: boolean): void;

package/dist/lint.util.js

@@ -7,7 +7,6 @@ import { _since } from '@naturalcycles/js-lib/datetime/time.util.js';
 import { _assert } from '@naturalcycles/js-lib/error/assert.js';
 import { _filterFalsyValues } from '@naturalcycles/js-lib/object/object.util.js';
 import { semver2 } from '@naturalcycles/js-lib/semver';
-import { git2 } from '@naturalcycles/nodejs-lib';
 import { dimGrey, white } from '@naturalcycles/nodejs-lib/colors';
 import { exec2 } from '@naturalcycles/nodejs-lib/exec2';
 import { fs2 } from '@naturalcycles/nodejs-lib/fs2';
@@ -132,8 +131,8 @@ function runESLint(extensions = eslintExtensions.split(','), fix = true) {
     });
 }
 export function runOxlint(fix = true) {
-    const oxlintConfigPath = `.oxlintrc.json`;
-    if (!existsSync(oxlintConfigPath)) {
+    if (!hasOxlintConfig()) {
+        console.log('.oxlintrc.json is not found, skipping to run oxlint');
         return;
     }
     const oxlintPath = findPackageBinPath('oxlint', 'oxlint');
@@ -151,6 +150,13 @@ export function runOxlint(fix = true) {
         shell: false,
     });
 }
+export function requireOxlintConfig() {
+    _assert(hasOxlintConfig(), '.oxlintrc.json config is not found');
+}
+export function hasOxlintConfig() {
+    const oxlintConfigPath = `.oxlintrc.json`;
+    return existsSync(oxlintConfigPath);
+}
 const prettierPaths = [
     // Everything inside these folders
     `./{${prettierDirs.join(',')}}/**/*.{${prettierExtensionsAll}}`,
@@ -224,24 +230,6 @@ export async function lintStagedCommand() {
     if (!success)
         process.exit(3);
 }
-export function runCommitlintCommand() {
-    const editMsg = process.argv.at(-1) || '.git/COMMIT_EDITMSG';
-    // console.log(editMsg)
-    const cwd = process.cwd();
-    const localConfig = `${cwd}/commitlint.config.js`;
-    const sharedConfig = `${cfgDir}/commitlint.config.js`;
-    const config = existsSync(localConfig) ? localConfig : sharedConfig;
-    const env = {
-        GIT_BRANCH: git2.getCurrentBranchName(),
-    };
-    const commitlintPath = findPackageBinPath('@commitlint/cli', 'commitlint');
-    exec2.spawn(`${commitlintPath} --edit ${editMsg} --config ${config}`, {
-        env,
-        passProcessEnv: true, // important to pass it through, to preserve $PATH
-        forceColor: false,
-        log: false,
-    });
-}
 async function runKTLint(fix = true) {
     if (!existsSync(`node_modules/@naturalcycles/ktlint`))
         return;

package/package.json

@@ -1,11 +1,9 @@
 {
   "name": "@naturalcycles/dev-lib",
   "type": "module",
-  "version": "20.16.1",
+  "version": "20.18.0",
   "dependencies": {
     "@biomejs/biome": "^2",
-    "@commitlint/cli": "^20",
-    "@commitlint/config-conventional": "^20",
     "@eslint/js": "^9",
     "@inquirer/prompts": "^8",
     "@naturalcycles/js-lib": "^15",