@naturalcycles/dev-lib 20.23.0 → 20.24.0

package/dist/bin/dev-lib.js

@@ -3,12 +3,10 @@ import { _by } from '@naturalcycles/js-lib/array/array.util.js';
 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 { buildCopy, buildProd, eslintAll, lintStagedCommand, requireOxlintConfig, runBiome, runCheck, runOxlint, runPrettier, runTest, stylelintAll, typecheckWithTSC, } from '../check.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 = [
-    { name: 'check', fn: check, desc: '"Run all possible checks": lint, typecheck, then test.' },
+    { name: 'check', fn: runCheck, desc: '"Run all possible checks": lint, typecheck, then test.' },
     {
         name: 'quick-check',
         fn: quickCheck,
@@ -64,7 +62,10 @@ const commands = [
     },
     {
         name: 'lint',
-        fn: lintAllCommand,
+        fn: () => runCheck({
+            typecheckWithTSC: false,
+            test: false,
+        }),
         desc: 'Run all linters: eslint, prettier, stylelint, ktlint, actionlint.',
     },
     {
@@ -156,14 +157,13 @@ runScript(async () => {
     }
     await commandMap[cmd].fn();
 });
-async function check() {
-    await lintAllCommand();
-    await typecheckWithTSC(); // unfortunately still needed since oxlint doesn't catch all ts errors
-    runTest();
-}
 async function quickCheck() {
-    await lintAllCommand(false);
-    runTest();
+    await runCheck({
+        eslint: false,
+        prettier: false,
+        stylelint: false,
+        typecheckWithTSC: false,
+    });
 }
 async function bt() {
     // Still using tsc, as oxlint is found to fail in certain cases
@@ -177,10 +177,6 @@ async function _typecheckWithOxlint() {
     const fix = !CI;
     runOxlint(fix);
 }
-async function typecheckWithTSC() {
-    // todo: try tsgo
-    await runTSCInFolders(['src', 'scripts', 'e2e'], ['--noEmit']);
-}
 async function cleanDist() {
     fs2.emptyDir('./dist'); // it doesn't delete the dir itself, to prevent IDE jumping
 }

package/dist/{lint.util.d.ts → check.util.d.ts}

@@ -1,10 +1,23 @@
 import type { SemVerString } from '@naturalcycles/js-lib/types';
+/**
+ * Every boolean defaults to true, so, by default - everything is being run.
+ * Pass false to skip it.
+ */
+export interface CheckOptions {
+    fastLinters?: boolean;
+    eslint?: boolean;
+    stylelint?: boolean;
+    prettier?: boolean;
+    ktlint?: boolean;
+    typecheckWithTSC?: boolean;
+    test?: boolean;
+}
 /**
  * Run all linters.
  *
  * If full=false - the "slow" linters are skipped.
  */
-export declare function lintAllCommand(full?: boolean): Promise<void>;
+export declare function runCheck(opt?: CheckOptions): Promise<void>;
 interface EslintAllOptions {
     ext?: string;
     fix?: boolean;
@@ -26,5 +39,19 @@ export declare function lintStagedCommand(): Promise<void>;
 export declare function requireActionlintVersion(): void;
 export declare function getActionLintVersion(): SemVerString | undefined;
 export declare function runBiome(fix?: boolean): void;
+export declare function buildProd(): Promise<void>;
+export declare function typecheckWithTSC(): Promise<void>;
+/**
+ * Use 'src' to indicate root.
+ */
+export declare function runTSCInFolders(dirs: string[], args?: string[], parallel?: boolean): Promise<void>;
+export declare function runTSCProd(args?: string[]): Promise<void>;
+export declare function buildCopy(): void;
+interface RunTestOptions {
+    integration?: boolean;
+    manual?: boolean;
+    leaks?: boolean;
+}
+export declare function runTest(opt?: RunTestOptions): void;
 export declare function findPackageBinPath(pkg: string, cmd: string): string;
 export {};

package/dist/{lint.util.js → check.util.js}

@@ -3,6 +3,7 @@ import { existsSync } from 'node:fs';
 import { createRequire } from 'node:module';
 import path from 'node:path';
 import { _isTruthy } from '@naturalcycles/js-lib';
+import { _uniq } from '@naturalcycles/js-lib/array';
 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';
@@ -10,6 +11,7 @@ import { semver2 } from '@naturalcycles/js-lib/semver';
 import { dimGrey, white } from '@naturalcycles/nodejs-lib/colors';
 import { exec2 } from '@naturalcycles/nodejs-lib/exec2';
 import { fs2 } from '@naturalcycles/nodejs-lib/fs2';
+import { kpySync } from '@naturalcycles/nodejs-lib/kpy';
 import { _yargs } from '@naturalcycles/nodejs-lib/yargs';
 import { eslintExtensions, lintExclude, minActionlintVersion, prettierDirs, prettierExtensionsAll, stylelintExtensions, } from '../cfg/_cnst.js';
 import { cfgDir } from './paths.js';
@@ -19,7 +21,8 @@ const { CI, ESLINT_CONCURRENCY } = process.env;
  *
  * If full=false - the "slow" linters are skipped.
  */
-export async function lintAllCommand(full = true) {
+export async function runCheck(opt = {}) {
+    const { fastLinters = true, eslint = true, stylelint = true, prettier = true, ktlint = true, typecheckWithTSC: runTSC = true, test = true, } = opt;
     const started = Date.now();
     // const { commitOnChanges, failOnChanges } = _yargs().options({
     //   commitOnChanges: {
@@ -41,24 +44,37 @@ export async function lintAllCommand(full = true) {
     // (known limitation / "infinite run loop" prevention)
     // That's why we run in "no-fix" mode in CI, and "fix" mode locally
     const fix = !CI;
-    // Fast linters (that run in <1 second) go first
-    runActionLint();
-    runBiome(fix);
-    runOxlint(fix);
+    if (fastLinters) {
+        // Fast linters (that run in <1 second) go first
+        runActionLint();
+        runBiome(fix);
+        runOxlint(fix);
+    }
     // From this point we start the "slow" linters, with ESLint leading the way
-    if (full) {
+    if (eslint) {
         // We run eslint BEFORE Prettier, because eslint can delete e.g unused imports.
         eslintAll({
             fix,
         });
-        if (existsSync(`node_modules/stylelint`) &&
-            existsSync(`node_modules/stylelint-config-standard-scss`)) {
-            stylelintAll(fix);
-        }
+    }
+    if (stylelint &&
+        existsSync(`node_modules/stylelint`) &&
+        existsSync(`node_modules/stylelint-config-standard-scss`)) {
+        stylelintAll(fix);
+    }
+    if (prettier) {
         runPrettier({ fix });
+    }
+    if (ktlint) {
         await runKTLint(fix);
     }
-    console.log(`${check(true)}${white(`lint-all`)} ${dimGrey(`took ` + _since(started))}`);
+    if (runTSC) {
+        await typecheckWithTSC();
+    }
+    if (test) {
+        runTest();
+    }
+    console.log(`${check(true)}${white(`check`)} ${dimGrey(`took ` + _since(started))}`);
     // if (needToTrackChanges) {
     //   const gitStatusAfter = gitStatus()
     //   const hasChanges = gitStatusAfter !== gitStatusAtStart
@@ -279,6 +295,113 @@ export function runBiome(fix = true) {
         shell: false,
     });
 }
+export async function buildProd() {
+    // fs2.emptyDir('./dist') // it doesn't delete the dir itself, to prevent IDE jumping
+    buildCopy();
+    await runTSCProd();
+}
+export async function typecheckWithTSC() {
+    // todo: try tsgo
+    await runTSCInFolders(['src', 'scripts', 'e2e'], ['--noEmit']);
+}
+/**
+ * Use 'src' to indicate root.
+ */
+export async function runTSCInFolders(dirs, args = [], parallel = true) {
+    if (parallel) {
+        await Promise.all(dirs.map(dir => runTSCInFolder(dir, args)));
+    }
+    else {
+        for (const dir of dirs) {
+            await runTSCInFolder(dir, args);
+        }
+    }
+}
+/**
+ * Pass 'src' to run in root.
+ */
+async function runTSCInFolder(dir, args = []) {
+    let configDir = dir;
+    if (dir === 'src') {
+        configDir = '';
+    }
+    const tsconfigPath = [configDir, 'tsconfig.json'].filter(Boolean).join('/');
+    if (!fs2.pathExists(tsconfigPath) || !fs2.pathExists(dir)) {
+        // console.log(`Skipping to run tsc for ${tsconfigPath}, as it doesn't exist`)
+        return;
+    }
+    const tscPath = findPackageBinPath('typescript', 'tsc');
+    const cacheLocation = `node_modules/.cache/${dir}.tsbuildinfo`;
+    const cacheFound = existsSync(cacheLocation);
+    console.log(dimGrey(`${check(cacheFound)}tsc ${dir} cache found: ${cacheFound}`));
+    await exec2.spawnAsync(tscPath, {
+        args: ['-P', tsconfigPath, ...args],
+        shell: false,
+    });
+}
+export async function runTSCProd(args = []) {
+    const tsconfigPath = [`./tsconfig.prod.json`].find(p => fs2.pathExists(p)) || 'tsconfig.json';
+    const tscPath = findPackageBinPath('typescript', 'tsc');
+    await exec2.spawnAsync(tscPath, {
+        args: ['-P', tsconfigPath, '--noEmit', 'false', '--noCheck', '--incremental', 'false', ...args],
+        shell: false,
+    });
+}
+export function buildCopy() {
+    const baseDir = 'src';
+    const inputPatterns = [
+        '**',
+        '!**/*.ts',
+        '!**/__snapshots__',
+        '!**/__exclude',
+        '!test',
+        '!**/*.test.js',
+    ];
+    const outputDir = 'dist';
+    kpySync({
+        baseDir,
+        inputPatterns,
+        outputDir,
+        dotfiles: true,
+    });
+}
+export function runTest(opt = {}) {
+    // if (nodeModuleExists('vitest')) {
+    if (fs2.pathExists('vitest.config.ts')) {
+        runVitest(opt);
+        return;
+    }
+    console.log(dimGrey(`vitest.config.ts not found, skipping tests`));
+}
+function runVitest(opt) {
+    const { integration, manual } = opt;
+    const processArgs = process.argv.slice(3);
+    const args = [...processArgs];
+    const env = {};
+    if (integration) {
+        Object.assign(env, {
+            TEST_TYPE: 'integration',
+        });
+    }
+    else if (manual) {
+        Object.assign(env, {
+            TEST_TYPE: 'manual',
+        });
+    }
+    const vitestPath = findPackageBinPath('vitest', 'vitest');
+    exec2.spawn(vitestPath, {
+        args: _uniq(args),
+        logFinish: false,
+        shell: false,
+        env,
+    });
+}
+/**
+ * Returns true if module with given name exists in _target project's_ node_modules.
+ */
+// function nodeModuleExists(moduleName: string): boolean {
+//   return existsSync(`./node_modules/${moduleName}`)
+// }
 function canRunBinary(name) {
     try {
         execSync(`which ${name}`);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/dev-lib",
   "type": "module",
-  "version": "20.23.0",
+  "version": "20.24.0",
   "dependencies": {
     "@biomejs/biome": "^2",
     "@eslint/js": "^9",

package/dist/build.util.d.ts

@@ -1,9 +0,0 @@
-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>;
-export declare function runTSCProd(args?: string[]): Promise<void>;
-export declare function buildCopy(): void;

package/dist/build.util.js

@@ -1,77 +0,0 @@
-import { existsSync } from 'node:fs';
-import { dimGrey } from '@naturalcycles/nodejs-lib/colors';
-import { exec2 } from '@naturalcycles/nodejs-lib/exec2';
-import { fs2 } from '@naturalcycles/nodejs-lib/fs2';
-import { kpySync } from '@naturalcycles/nodejs-lib/kpy';
-import { findPackageBinPath } from './lint.util.js';
-export async function buildProd() {
-    // fs2.emptyDir('./dist') // it doesn't delete the dir itself, to prevent IDE jumping
-    buildCopy();
-    await runTSCProd();
-}
-/**
- * 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) {
-        await Promise.all(dirs.map(dir => runTSCInFolder(dir, args)));
-    }
-    else {
-        for (const dir of dirs) {
-            await runTSCInFolder(dir, args);
-        }
-    }
-}
-/**
- * Pass 'src' to run in root.
- */
-async function runTSCInFolder(dir, args = []) {
-    let configDir = dir;
-    if (dir === 'src') {
-        configDir = '';
-    }
-    const tsconfigPath = [configDir, 'tsconfig.json'].filter(Boolean).join('/');
-    if (!fs2.pathExists(tsconfigPath) || !fs2.pathExists(dir)) {
-        // console.log(`Skipping to run tsc for ${tsconfigPath}, as it doesn't exist`)
-        return;
-    }
-    const tscPath = findPackageBinPath('typescript', 'tsc');
-    const cacheLocation = `node_modules/.cache/${dir}.tsbuildinfo`;
-    const cacheFound = existsSync(cacheLocation);
-    console.log(dimGrey(`${check(cacheFound)}tsc ${dir} cache found: ${cacheFound}`));
-    await exec2.spawnAsync(tscPath, {
-        args: ['-P', tsconfigPath, ...args],
-        shell: false,
-    });
-}
-export async function runTSCProd(args = []) {
-    const tsconfigPath = [`./tsconfig.prod.json`].find(p => fs2.pathExists(p)) || 'tsconfig.json';
-    const tscPath = findPackageBinPath('typescript', 'tsc');
-    await exec2.spawnAsync(tscPath, {
-        args: ['-P', tsconfigPath, '--noEmit', 'false', '--noCheck', '--incremental', 'false', ...args],
-        shell: false,
-    });
-}
-export function buildCopy() {
-    const baseDir = 'src';
-    const inputPatterns = [
-        '**',
-        '!**/*.ts',
-        '!**/__snapshots__',
-        '!**/__exclude',
-        '!test',
-        '!**/*.test.js',
-    ];
-    const outputDir = 'dist';
-    kpySync({
-        baseDir,
-        inputPatterns,
-        outputDir,
-        dotfiles: true,
-    });
-}
-function check(predicate) {
-    return predicate ? ' ✓ ' : '   ';
-}

package/dist/test.util.d.ts

@@ -1,10 +0,0 @@
-interface RunTestOptions {
-    integration?: boolean;
-    manual?: boolean;
-    leaks?: boolean;
-}
-export declare function runTest(opt?: RunTestOptions): void;
-export {};
-/**
- * Returns true if module with given name exists in _target project's_ node_modules.
- */

package/dist/test.util.js

@@ -1,42 +0,0 @@
-import { _uniq } from '@naturalcycles/js-lib/array/array.util.js';
-import { dimGrey } from '@naturalcycles/nodejs-lib/colors';
-import { exec2 } from '@naturalcycles/nodejs-lib/exec2';
-import { fs2 } from '@naturalcycles/nodejs-lib/fs2';
-import { findPackageBinPath } from './lint.util.js';
-export function runTest(opt = {}) {
-    // if (nodeModuleExists('vitest')) {
-    if (fs2.pathExists('vitest.config.ts')) {
-        runVitest(opt);
-        return;
-    }
-    console.log(dimGrey(`vitest.config.ts not found, skipping tests`));
-}
-function runVitest(opt) {
-    const { integration, manual } = opt;
-    const processArgs = process.argv.slice(3);
-    const args = [...processArgs];
-    const env = {};
-    if (integration) {
-        Object.assign(env, {
-            TEST_TYPE: 'integration',
-        });
-    }
-    else if (manual) {
-        Object.assign(env, {
-            TEST_TYPE: 'manual',
-        });
-    }
-    const vitestPath = findPackageBinPath('vitest', 'vitest');
-    exec2.spawn(vitestPath, {
-        args: _uniq(args),
-        logFinish: false,
-        shell: false,
-        env,
-    });
-}
-/**
- * Returns true if module with given name exists in _target project's_ node_modules.
- */
-// function nodeModuleExists(moduleName: string): boolean {
-//   return existsSync(`./node_modules/${moduleName}`)
-// }