@naturalcycles/dev-lib 20.17.0 → 20.18.1

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/dist/bin/dev-lib.js

@@ -5,7 +5,8 @@ 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, requireOxlintConfig, 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
@@ -105,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',

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(): Promise<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 async 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 = await 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(cwd?: string): Promise<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,24 @@
+import { AjvSchema, j } from '@naturalcycles/nodejs-lib/ajv';
+import { fs2 } from '@naturalcycles/nodejs-lib/fs2';
+/**
+ * Returns an empty config if the file is absent.
+ */
+export async function readDevLibConfigIfPresent(cwd = process.cwd()) {
+    const devLibConfigPath = `${cwd}/dev-lib.config.js`;
+    let cfg = {};
+    if (fs2.pathExists(devLibConfigPath)) {
+        cfg = (await import(devLibConfigPath)).default;
+        console.log(`read ${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/index.d.ts

@@ -1 +1 @@
-export type {};
+export * from './config.js';

package/dist/index.js

@@ -1 +1 @@
-export {};
+export * from './config.js';

package/dist/lint.util.d.ts

@@ -21,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';
@@ -231,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/dist/paths.d.ts

@@ -1,4 +1,5 @@
 export declare const projectDir: string;
+export declare const repoDir: string;
 export declare const srcDir: string;
 export declare const testDir: string;
 export declare const cfgDir: string;

package/dist/paths.js

@@ -1,5 +1,6 @@
 import { join } from 'node:path';
 export const projectDir = join(import.meta.dirname, '..');
+export const repoDir = join(projectDir, '../..');
 export const srcDir = `${projectDir}/src`;
 export const testDir = `${srcDir}/test`;
 export const cfgDir = `${projectDir}/cfg`;

package/package.json

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