@naturalcycles/dev-lib 19.29.0 → 19.31.0

package/dist/build.util.js

@@ -1,5 +1,5 @@
 import { existsSync } from 'node:fs';
-import { grey } from '@naturalcycles/nodejs-lib/colors';
+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';
@@ -38,7 +38,7 @@ export async function runTSCInFolder(dir, args = []) {
     const tscPath = findPackageBinPath('typescript', 'tsc');
     const cacheLocation = `node_modules/.cache/${dir}.tsbuildinfo`;
     const cacheFound = existsSync(cacheLocation);
-    console.log(grey(`tsc ${dir} cache found: ${cacheFound}`));
+    console.log(dimGrey(`${check(cacheFound)} tsc ${dir} cache found: ${cacheFound}`));
     await exec2.spawnAsync(tscPath, {
         args: ['-P', tsconfigPath, ...args],
         shell: false,
@@ -49,7 +49,7 @@ export async function runTSCProd(args = []) {
     const tscPath = findPackageBinPath('typescript', 'tsc');
     const cacheLocation = `node_modules/.cache/src.tsbuildinfo`;
     const cacheFound = existsSync(cacheLocation);
-    console.log(grey(`tsc src cache found: ${cacheFound}`));
+    console.log(dimGrey(`   tsc src cache found: ${cacheFound}`));
     await exec2.spawnAsync(tscPath, {
         args: ['-P', tsconfigPath, '--noEmit', 'false', '--noCheck', ...args],
         shell: false,
@@ -73,3 +73,6 @@ export function buildCopy() {
         dotfiles: true,
     });
 }
+function check(predicate) {
+    return predicate ? '✔️ ' : '   ';
+}

package/dist/lint.util.d.ts

@@ -11,8 +11,12 @@ interface EslintAllOptions {
  * Runs `eslint` command for all predefined paths (e.g /src, /scripts, etc).
  */
 export declare function eslintAll(opt?: EslintAllOptions): Promise<void>;
-export declare function runPrettier(experimentalCli?: boolean): void;
-export declare function stylelintAll(): void;
+interface RunPrettierOptions {
+    experimentalCli?: boolean;
+    fix?: boolean;
+}
+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;

package/dist/lint.util.js

@@ -7,9 +7,8 @@ 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 { _truncate } from '@naturalcycles/js-lib/string/string.util.js';
 import { git2 } from '@naturalcycles/nodejs-lib';
-import { boldGrey, dimGrey, grey } from '@naturalcycles/nodejs-lib/colors';
+import { boldGrey, dimGrey } from '@naturalcycles/nodejs-lib/colors';
 import { exec2 } from '@naturalcycles/nodejs-lib/exec2';
 import { fs2 } from '@naturalcycles/nodejs-lib/fs2';
 import { _yargs } from '@naturalcycles/nodejs-lib/yargs';
@@ -21,52 +20,60 @@ const { CI, ESLINT_CONCURRENCY } = process.env;
  */
 export async function lintAllCommand() {
     const started = Date.now();
-    const { commitOnChanges, failOnChanges } = _yargs().options({
-        commitOnChanges: {
-            type: 'boolean',
-            default: false,
-        },
-        failOnChanges: {
-            type: 'boolean',
-            default: false,
-        },
-    }).argv;
-    const needToTrackChanges = commitOnChanges || failOnChanges;
-    const gitStatusAtStart = gitStatus();
-    if (needToTrackChanges && gitStatusAtStart) {
-        console.log('lint-all: git shows changes before run:');
-        console.log(gitStatusAtStart);
-    }
+    // const { commitOnChanges, failOnChanges } = _yargs().options({
+    //   commitOnChanges: {
+    //     type: 'boolean',
+    //     default: false,
+    //   },
+    //   failOnChanges: {
+    //     type: 'boolean',
+    //     default: false,
+    //   },
+    // }).argv
+    // const needToTrackChanges = commitOnChanges || failOnChanges
+    // const gitStatusAtStart = gitStatus()
+    // if (needToTrackChanges && gitStatusAtStart) {
+    //   console.log('lint-all: git shows changes before run:')
+    //   console.log(gitStatusAtStart)
+    // }
+    // In CI, Github Actions doesn't allow us to push and then run CI on changes again
+    // (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();
+    runBiome(fix);
     // From this point we start the "slow" linters, with ESLint leading the way
     // We run eslint BEFORE Prettier, because eslint can delete e.g unused imports.
-    await eslintAll();
+    await eslintAll({
+        fix,
+    });
     if (existsSync(`node_modules/stylelint`) &&
         existsSync(`node_modules/stylelint-config-standard-scss`)) {
-        stylelintAll();
-    }
-    runPrettier();
-    await runKTLint();
-    console.log(`${boldGrey('lint-all')} ${dimGrey(`took ` + _since(started))}`);
-    if (needToTrackChanges) {
-        const gitStatusAfter = gitStatus();
-        const hasChanges = gitStatusAfter !== gitStatusAtStart;
-        if (!hasChanges)
-            return;
-        const msg = 'style(ci): ' + _truncate(git2.commitMessageToTitleMessage(git2.getLastGitCommitMsg()), 60);
-        // pull, commit, push changes
-        git2.pull();
-        git2.commitAll(msg);
-        git2.push();
-        // fail on changes
-        if (failOnChanges) {
-            console.log(gitStatusAfter);
-            console.log('lint-all failOnChanges: exiting with status 1');
-            process.exitCode = 1;
-        }
+        stylelintAll(fix);
     }
+    runPrettier({ fix });
+    await runKTLint(fix);
+    console.log(`${boldGrey(`${check(true)} lint-all`)} ${dimGrey(`took ` + _since(started))}`);
+    // if (needToTrackChanges) {
+    //   const gitStatusAfter = gitStatus()
+    //   const hasChanges = gitStatusAfter !== gitStatusAtStart
+    //   if (!hasChanges) return
+    //   const msg =
+    //     'style(ci): ' + _truncate(git2.commitMessageToTitleMessage(git2.getLastGitCommitMsg()), 60)
+    //
+    //   // pull, commit, push changes
+    //   git2.pull()
+    //   git2.commitAll(msg)
+    //   git2.push()
+    //
+    //   // fail on changes
+    //   if (failOnChanges) {
+    //     console.log(gitStatusAfter)
+    //     console.log('lint-all failOnChanges: exiting with status 1')
+    //     process.exitCode = 1
+    //   }
+    // }
 }
 /**
  * Runs `eslint` command for all predefined paths (e.g /src, /scripts, etc).
@@ -80,7 +87,7 @@ export async function eslintAll(opt) {
         },
         fix: {
             type: 'boolean',
-            default: true,
+            default: !CI, // defaults to false in CI, true otherwise
         },
     });
     const { ext, fix } = {
@@ -88,26 +95,22 @@ export async function eslintAll(opt) {
         ...opt,
     };
     const extensions = ext.split(',');
-    if (fix) {
+    // The only time we don't parallelize is when run locally with no-fix,
+    // so errors can be seen properly
+    const runInParallel = fix || !!CI;
+    if (runInParallel) {
         await Promise.all([
-            // /src
             runESLint(`src`, extensions, fix),
-            // /scripts
             runESLint(`scripts`, extensions, fix),
-            // /e2e
             runESLint(`e2e`, extensions, fix),
         ]);
     }
     else {
-        // with no-fix - let's run serially
-        // /src
         await runESLint(`src`, extensions, fix);
-        // /scripts
         await runESLint(`scripts`, extensions, fix);
-        // /e2e
         await runESLint(`e2e`, extensions, fix);
     }
-    console.log(`${boldGrey('eslint-all')} ${dimGrey(`took ` + _since(started))}`);
+    console.log(`${boldGrey(`${check(true)} eslint-all`)} ${dimGrey(`took ` + _since(started))}`);
 }
 async function runESLint(dir, extensions = eslintExtensions.split(','), fix = true) {
     let configDir = dir;
@@ -123,8 +126,9 @@ async function runESLint(dir, extensions = eslintExtensions.split(','), fix = tr
     const eslintPath = findPackageBinPath('eslint', 'eslint');
     const cacheLocation = `node_modules/.cache/eslint_${dir}`;
     const cacheFound = existsSync(cacheLocation);
-    console.log(grey(`eslint ${dir} cache found: ${cacheFound}`));
+    console.log(dimGrey(`${check(cacheFound)} eslint ${dir} cache found: ${cacheFound}`));
     await exec2.spawnAsync(eslintPath, {
+        name: ['eslint', dir, !fix && '--no-fix'].filter(Boolean).join(' '),
         args: [
             `--config`,
             eslintConfigPath,
@@ -138,7 +142,7 @@ async function runESLint(dir, extensions = eslintExtensions.split(','), fix = tr
             cacheLocation,
             `--no-error-on-unmatched-pattern`,
             `--report-unused-disable-directives`, // todo: unnecessary with flat, as it's defined in the config
-            fix ? `--fix` : '',
+            fix ? `--fix` : '--no-fix',
         ].filter(_isTruthy),
         shell: false,
         env: _filterFalsyValues({
@@ -155,18 +159,20 @@ const prettierPaths = [
     // Exclude
     ...lintExclude.map((s) => `!${s}`),
 ];
-export function runPrettier(experimentalCli = true) {
+export function runPrettier(opt = {}) {
+    const { experimentalCli = true, fix = true } = opt;
     const prettierConfigPath = [`./prettier.config.js`].find(f => existsSync(f));
     if (!prettierConfigPath)
         return;
     const prettierPath = findPackageBinPath('prettier', 'prettier');
     const cacheLocation = 'node_modules/.cache/prettier';
     const cacheFound = existsSync(cacheLocation);
-    console.log(grey(`prettier cache found: ${cacheFound}`));
+    console.log(dimGrey(`${check(cacheFound)} prettier cache found: ${cacheFound}`));
     // prettier --write 'src/**/*.{js,ts,css,scss,graphql}'
     exec2.spawn(prettierPath, {
+        name: fix ? 'prettier' : 'prettier --check',
         args: [
-            `--write`,
+            fix ? `--write` : '--check',
             `--log-level=warn`,
             '--cache-location',
             cacheLocation,
@@ -184,18 +190,20 @@ const stylelintPaths = [
     // Exclude
     ...lintExclude.map((s) => `!${s}`),
 ];
-export function stylelintAll() {
-    const { fix } = _yargs().options({
+export function stylelintAll(fix) {
+    const argv = _yargs().options({
         fix: {
             type: 'boolean',
-            default: true,
+            default: !CI, // defaults to false in CI, true otherwise
         },
     }).argv;
+    fix ??= argv.fix;
     const config = [`./stylelint.config.js`].find(f => existsSync(f));
     if (!config)
         return;
     // stylelint is never hoisted from dev-lib, so, no need to search for its path
     exec2.spawn('stylelint', {
+        name: fix ? 'stylelint' : 'stylelint --no-fix',
         args: [fix ? `--fix` : '', `--allow-empty-input`, `--config`, config, ...stylelintPaths].filter(Boolean),
         shell: false,
     });
@@ -229,12 +237,12 @@ export function runCommitlintCommand() {
         log: false,
     });
 }
-async function runKTLint() {
+async function runKTLint(fix = true) {
     if (!existsSync(`node_modules/@naturalcycles/ktlint`))
         return;
     // @ts-expect-error ktlint is not installed (due to size in node_modules), but it's ok
     const { ktlintAll } = await import('@naturalcycles/ktlint');
-    await ktlintAll();
+    await ktlintAll(fix ? ['-F'] : []);
 }
 function runActionLint() {
     // Only run if there is a folder of `.github/workflows`, otherwise actionlint will fail
@@ -261,12 +269,6 @@ export function getActionLintVersion() {
     return exec2.exec('actionlint --version').split('\n')[0];
 }
 export function runBiome(fix = true) {
-    // if (!fs.existsSync(`node_modules/@biomejs/biome`)) {
-    //   if (verbose) {
-    //     console.log(`biome is not installed (checked in node_modules/@biomejs/biome), skipping`)
-    //   }
-    //   return
-    // }
     const configPath = `biome.jsonc`;
     if (!existsSync(configPath)) {
         console.log(`biome is skipped, because ./biome.jsonc is not present`);
@@ -275,6 +277,7 @@ export function runBiome(fix = true) {
     const biomePath = findPackageBinPath('@biomejs/biome', 'biome');
     const dirs = [`src`, `scripts`, `e2e`].filter(d => existsSync(d));
     exec2.spawn(biomePath, {
+        name: fix ? 'biome' : 'biome --no-fix',
         args: [`lint`, fix && '--write', fix && '--unsafe', '--no-errors-on-unmatched', ...dirs].filter(_isTruthy),
         logFinish: false,
         shell: false,
@@ -289,17 +292,19 @@ function canRunBinary(name) {
         return false;
     }
 }
-function gitStatus() {
-    try {
-        return execSync('git status -s', {
-            encoding: 'utf8',
-        });
-    }
-    catch { }
-}
+// function gitStatus(): string | undefined {
+//   try {
+//     return execSync('git status -s', {
+//       encoding: 'utf8',
+//     })
+//   } catch {}
+// }
 const require = createRequire(import.meta.url);
 export function findPackageBinPath(pkg, cmd) {
     const packageJsonPath = require.resolve(`${pkg}/package.json`);
     const { bin } = fs2.readJson(packageJsonPath);
     return path.join(path.dirname(packageJsonPath), typeof bin === 'string' ? bin : bin[cmd]);
 }
+function check(predicate) {
+    return predicate ? '✔️ ' : '   ';
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/dev-lib",
   "type": "module",
-  "version": "19.29.0",
+  "version": "19.31.0",
   "dependencies": {
     "@biomejs/biome": "^2",
     "@commitlint/cli": "^19",