@naturalcycles/dev-lib 12.13.4 → 12.15.0

package/cfg/jest.config.js

@@ -3,11 +3,12 @@
  * Extendable.
  */
 
+const fs = require('fs')
+
 const runInIDE = process.argv.includes('--runTestsByPath')
 const ideIntegrationTest = runInIDE && process.argv.some(a => a.endsWith('.integration.test.ts'))
 const ideManualTest = runInIDE && process.argv.some(a => a.endsWith('.manual.test.ts'))
-
-const fs = require('fs')
+const { CI } = process.env
 const cwd = process.cwd()
 
 // Set 'setupFilesAfterEnv' only if it exists
@@ -106,9 +107,13 @@ module.exports = {
     '!**/*.component.ts',
     '!**/*.modal.ts',
   ],
+  // default: ["clover", "json", "lcov", "text"]
+  coverageReporters: ['clover', 'json', 'lcov', !CI && 'text'].filter(Boolean),
+  // CI: only jest-junit reporter (no default)
+  // not-CI: only default reporter, but not jest-junit
   reporters: [
     'default',
-    [
+    CI && [
       'jest-junit',
       {
         suiteName: 'jest tests',
@@ -120,5 +125,5 @@ module.exports = {
         ancestorSeparator: ' ',
       },
     ],
-  ],
+  ].filter(Boolean),
 }

package/cfg/jest.integration-test.config.js

@@ -4,6 +4,7 @@
  */
 
 const fs = require('fs')
+const { CI } = process.env
 const cwd = process.cwd()
 
 // Set 'setupFilesAfterEnv' only if it exists
@@ -21,10 +22,9 @@ module.exports = {
   testMatch: ['<rootDir>/src/**/*.integration.test.ts'],
   testPathIgnorePatterns: ['<rootDir>/.*/__exclude/'],
   setupFilesAfterEnv,
-  coverageDirectory: 'tmp/coverage-integration',
   reporters: [
     'default',
-    [
+    CI && [
       'jest-junit',
       {
         suiteName: 'jest tests',
@@ -36,5 +36,5 @@ module.exports = {
         ancestorSeparator: ' ',
       },
     ],
-  ],
+  ].filter(Boolean),
 }

package/cfg/jest.manual-test.config.js

@@ -21,7 +21,5 @@ module.exports = {
   testMatch: ['<rootDir>/src/**/*.manual.test.ts'],
   testPathIgnorePatterns: ['<rootDir>/.*/__exclude/'],
   setupFilesAfterEnv,
-  // Should never need coverage or reporters, but anyway
-  coverageDirectory: 'tmp/coverage-manual',
   reporters: ['default'],
 }

package/cfg/lint-staged.config.js

@@ -79,7 +79,14 @@ const linters = {
   '**/*.{kt,kts}': match => {
     const filesList = micromatch.not(match, lintExclude).join(' ')
     if (!filesList) return []
-    return [`ktlint -F ${filesList}`]
+    const dir = './node_modules/@naturalcycles/ktlint'
+
+    if (!fs.existsSync(dir)) {
+      console.log(`!!\n!! Please install @naturalcycles/ktlint to lint *.kt files\n!!\n`, filesList)
+      return []
+    }
+
+    return [`${dir}/resources/ktlint -F ${filesList}`]
   },
 }
 

package/cfg/overwrite/.editorconfig

@@ -14,35 +14,39 @@ end_of_line = lf
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[**.md]
+[*.md]
 trim_trailing_whitespace = false
 indent_size = 4
 
-[**.html]
+[*.html]
 indent_size = 2
 
-[**.{css,scss}]
+[*.{css,scss}]
 indent_size = 2
 
-[**.{js,ts}]
+[*.{js,ts}]
 indent_size = 2
 
-[**.json]
+[*.json]
 indent_size = 2
 
-[**.xml]
-indent_size = 2
-
-[**.java]
+[*.java]
 indent_size = 4
 
-[**.sql]
+[*.{kt,kts}]
+disabled_rules=no-wildcard-imports
+ij_kotlin_imports_layout=*,java.**,javax.**,kotlin.**,^ # default IntelliJ IDEA style, same as alphabetical, but with "java", "javax", "kotlin" and alias imports in the end of the imports list
+
+[*.xml]
+indent_size = 2
+
+[*.sql]
 indent_size = 2
 
 [.eslintrc]
 indent_size = 2
 
-[**.min.*]
+[*.min.*]
 indent_style = ignore
 trim_trailing_whitespace = false
 insert_final_newline = ignore

package/dist/bin/bt.js

@@ -1,13 +1,14 @@
 #!/usr/bin/env node
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const fs = require("fs");
+const fs = require("fs-extra");
 const script_1 = require("@naturalcycles/nodejs-lib/dist/script");
 const tsc_scripts_command_1 = require("../cmd/tsc-scripts.command");
 const jest_util_1 = require("../util/jest.util");
 const tsc_util_1 = require("../util/tsc.util");
 (0, script_1.runScript)(async () => {
-    fs.rmSync('./dist', { recursive: true, force: true });
+    fs.emptyDirSync('./dist'); // it doesn't delete the dir itself, to prevent IDE jumping
+    // fs.rmSync('./dist', { recursive: true, force: true })
     await (0, tsc_util_1.tsc)();
     await (0, tsc_scripts_command_1.tscScriptsCommand)();
     await (0, jest_util_1.runJest)();

package/dist/bin/btl.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/bin/btl.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs-extra");
+const script_1 = require("@naturalcycles/nodejs-lib/dist/script");
+const lint_all_command_1 = require("../cmd/lint-all.command");
+const tsc_scripts_command_1 = require("../cmd/tsc-scripts.command");
+const jest_util_1 = require("../util/jest.util");
+const tsc_util_1 = require("../util/tsc.util");
+(0, script_1.runScript)(async () => {
+    await (0, lint_all_command_1.lintAllCommand)();
+    fs.emptyDirSync('./dist'); // it doesn't delete the dir itself, to prevent IDE jumping
+    // fs.rmSync('./dist', { recursive: true, force: true })
+    await (0, tsc_util_1.tsc)();
+    await (0, tsc_scripts_command_1.tscScriptsCommand)();
+    await (0, jest_util_1.runJest)();
+});

package/dist/bin/build.js

@@ -1,12 +1,13 @@
 #!/usr/bin/env node
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const fs = require("fs");
+const fs = require("fs-extra");
 const script_1 = require("@naturalcycles/nodejs-lib/dist/script");
 const tsc_scripts_command_1 = require("../cmd/tsc-scripts.command");
 const tsc_util_1 = require("../util/tsc.util");
 (0, script_1.runScript)(async () => {
-    fs.rmSync('./dist', { recursive: true, force: true });
+    fs.emptyDirSync('./dist'); // it doesn't delete the dir itself, to prevent IDE jumping
+    // fs.rmSync('./dist', { recursive: true, force: true })
     await (0, tsc_util_1.tsc)();
     await (0, tsc_scripts_command_1.tscScriptsCommand)();
 });

package/dist/bin/test-ci.js

@@ -4,5 +4,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const script_1 = require("@naturalcycles/nodejs-lib/dist/script");
 const jest_util_1 = require("../util/jest.util");
 (0, script_1.runScript)(async () => {
-    await (0, jest_util_1.runJest)({ ci: true });
+    console.log('! "yarn test-ci" is deprecated, use plain `yarn test` instead !');
+    await (0, jest_util_1.runJest)();
 });

package/dist/bin/test-integration-ci.js

@@ -4,5 +4,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const script_1 = require("@naturalcycles/nodejs-lib/dist/script");
 const jest_util_1 = require("../util/jest.util");
 (0, script_1.runScript)(async () => {
-    await (0, jest_util_1.runJest)({ integration: true, ci: true });
+    console.log('! "yarn test-integration-ci" is deprecated, use plain `yarn test-integration` instead !');
+    await (0, jest_util_1.runJest)({ integration: true });
 });

package/dist/cmd/build-prod-esm-cjs.command.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildProdESMCJSCommand = void 0;
-const fs = require("fs");
+const fs = require("fs-extra");
 const exec_1 = require("@naturalcycles/nodejs-lib/dist/exec");
 // You cannot have a shared `tsconfig.prod.json` because of relative paths for `include`
 const TSCONF_CJS_PATH = `./tsconfig.cjs.prod.json`;
@@ -11,8 +11,11 @@ async function buildProdESMCJSCommand() {
     const [cjsExists, esmExists] = [
         fs.existsSync(TSCONF_CJS_PATH),
         fs.existsSync(TSCONF_ESM_PATH),
-        fs.rmSync('./dist', { recursive: true, force: true }),
-        fs.rmSync('./dist-esm', { recursive: true, force: true }),
+        // it doesn't delete the dir itself, to prevent IDE jumping
+        fs.emptyDirSync('./dist'),
+        fs.emptyDirSync('./dist-esm'),
+        // fs.rmSync('./dist', { recursive: true, force: true }),
+        // fs.rmSync('./dist-esm', { recursive: true, force: true }),
     ];
     const cjsPath = cjsExists ? TSCONF_CJS_PATH : TSCONF_PATH;
     const esmPath = esmExists ? TSCONF_ESM_PATH : TSCONF_PATH;

package/dist/cmd/build-prod.command.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildProdCommand = void 0;
-const fs = require("fs");
+const fs = require("fs-extra");
 const build_copy_command_1 = require("./build-copy.command");
 const tsc_prod_command_1 = require("./tsc-prod.command");
 async function buildProdCommand() {
-    fs.rmSync('./dist', { recursive: true, force: true });
+    fs.emptyDirSync('./dist'); // it doesn't delete the dir itself, to prevent IDE jumping
+    // fs.rmSync('./dist', { recursive: true, force: true })
     (0, build_copy_command_1.buildCopyCommand)();
     await (0, tsc_prod_command_1.tscProdCommand)();
 }

package/dist/cmd/lint-all.command.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.lintAllCommand = void 0;
+const fs = require("fs");
 const yargs = require("yargs");
 const git_util_1 = require("../util/git.util");
 const prettier_util_1 = require("../util/prettier.util");
@@ -21,10 +22,14 @@ async function lintAllCommand() {
         },
     }).argv;
     const hadChangesBefore = await (0, git_util_1.gitHasUncommittedChanges)();
-    // Currently we position ESLint before TSLint, but let's monitor if it's ok
     await (0, eslint_all_command_1.eslintAllCommand)();
     await (0, stylelint_util_1.stylelintAll)();
     await (0, prettier_util_1.runPrettier)();
+    // Running ktlintAll (experimental!)
+    if (fs.existsSync(`node_modules/@naturalcycles/ktlint`)) {
+        const ktlintLib = require('@naturalcycles/ktlint');
+        await ktlintLib.ktlintAll();
+    }
     if (commitOnChanges || failOnChanges) {
         // detect changes
         const hasChanges = await (0, git_util_1.gitHasUncommittedChanges)();
@@ -33,9 +38,7 @@ async function lintAllCommand() {
                 console.log(`lint-all: there are changes before running lint-all, will not commit`);
             }
             else {
-                const msg = 'style(lint-all): ' +
-                    (0, git_util_1.commitMessageToTitleMessage)(await (0, git_util_1.getLastGitCommitMsg)()) +
-                    '\n\n[skip ci]';
+                const msg = 'style(ci): ' + (0, git_util_1.commitMessageToTitleMessage)(await (0, git_util_1.getLastGitCommitMsg)()) + '\n\n[skip ci]';
                 // pull, commit, push changes
                 await (0, git_util_1.gitPull)();
                 await (0, git_util_1.gitCommitAll)(msg);

package/dist/util/jest.util.d.ts

@@ -1,12 +1,11 @@
-export declare function getJestConfigPath(): string | undefined;
-export declare function getJestIntegrationConfigPath(): string | undefined;
-export declare function getJestManualConfigPath(): string | undefined;
+export declare function getJestConfigPath(): string;
+export declare function getJestIntegrationConfigPath(): string;
+export declare function getJestManualConfigPath(): string;
 /**
  * Detects if jest is run with all tests, or with specific tests.
  */
 export declare function isRunningAllTests(): boolean;
 interface RunJestOpt {
-    ci?: boolean;
     integration?: boolean;
     manual?: boolean;
     leaks?: boolean;

package/dist/util/jest.util.js

@@ -8,7 +8,7 @@ const exec_1 = require("@naturalcycles/nodejs-lib/dist/exec");
 const paths_cnst_1 = require("../cnst/paths.cnst");
 const test_util_1 = require("./test.util");
 function getJestConfigPath() {
-    return fs.existsSync(`./jest.config.js`) ? undefined : `${paths_cnst_1.cfgDir}/jest.config.js`;
+    return fs.existsSync(`./jest.config.js`) ? './jest.config.js' : `${paths_cnst_1.cfgDir}/jest.config.js`;
 }
 exports.getJestConfigPath = getJestConfigPath;
 function getJestIntegrationConfigPath() {
@@ -41,16 +41,9 @@ async function runJest(opt = {}) {
         console.log((0, colors_1.dimGrey)(`node_modules/${(0, colors_1.white)('jest')} not found, skipping tests`));
         return;
     }
-    const { ci, integration, manual, leaks } = opt;
+    const { CI, TZ = 'UTC', APP_ENV, JEST_NO_ALPHABETIC, NODE_OPTIONS } = process.env;
+    const { integration, manual, leaks } = opt;
     const processArgs = process.argv.slice(2);
-    // console.log(processArgs) // todo: solve to run it in dev-lib
-    // Allow to override --maxWorkers
-    let maxWorkers = processArgs.find(a => a.startsWith('--maxWorkers'));
-    const args = ['--logHeapUsage', '--passWithNoTests', ...processArgs];
-    const env = {
-        TZ: process.env.TZ || 'UTC',
-        DEBUG_COLORS: '1',
-    };
     let jestConfig;
     if (manual) {
         jestConfig = getJestManualConfigPath();
@@ -61,20 +54,35 @@ async function runJest(opt = {}) {
     else {
         jestConfig = getJestConfigPath();
     }
-    if (jestConfig) {
-        args.push(`--config=${jestConfig}`);
-    }
-    if (ci) {
-        args.push('--ci', '--coverage');
-        maxWorkers = maxWorkers || '--maxWorkers=2';
+    // Allow to override --maxWorkers
+    let maxWorkers = processArgs.find(a => a.startsWith('--maxWorkers'));
+    const args = [
+        `--config=${jestConfig}`,
+        '--logHeapUsage',
+        '--passWithNoTests',
+        ...processArgs,
+    ];
+    const env = {
+        TZ,
+        DEBUG_COLORS: '1',
+    };
+    if (CI) {
+        args.push('--ci');
+        if (!integration && !manual) {
+            // Coverage only makes sense for unit tests, not for integration/manual
+            args.push('--coverage');
+        }
+        // We used to default to 2, but due to memory being an issue for Jest - now we default to 1,
+        // as it's the most memory-efficient way
+        maxWorkers || (maxWorkers = '--maxWorkers=1');
     }
     // Running all tests - will use `--silent` to suppress console-logs, will also set process.env.JEST_SILENT=1
-    if (ci || isRunningAllTests()) {
+    if (CI || isRunningAllTests()) {
         args.push('--silent');
     }
     if (leaks) {
         args.push('--detectOpenHandles', '--detectLeaks');
-        maxWorkers = maxWorkers || '--maxWorkers=1';
+        maxWorkers || (maxWorkers = '--maxWorkers=1');
     }
     if (maxWorkers)
         args.push(maxWorkers);
@@ -83,15 +91,14 @@ async function runJest(opt = {}) {
             JEST_SILENT: '1',
         });
     }
-    if (!integration && !manual && !process.env['APP_ENV']) {
+    if (!integration && !manual && !APP_ENV) {
         Object.assign(env, {
             APP_ENV: 'test',
         });
     }
-    if (!process.env['JEST_NO_ALPHABETIC']) {
+    if (!JEST_NO_ALPHABETIC) {
         args.push(`--testSequencer=${paths_cnst_1.cfgDir}/jest.alphabetic.sequencer.js`);
     }
-    const { NODE_OPTIONS } = process.env;
     if (NODE_OPTIONS) {
         console.log(`${(0, colors_1.dimGrey)('NODE_OPTIONS: ' + NODE_OPTIONS)}`);
     }

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@naturalcycles/dev-lib",
-  "version": "12.13.4",
+  "version": "12.15.0",
   "scripts": {
     "prepare": "husky install",
     "tsn-debug": "tsn testScript.ts",
     "bt": "tsn ./src/bin/bt.ts",
+    "btl": "tsn ./src/bin/btl.ts",
     "build": "tsn ./src/bin/build.ts",
     "tsc-prod": "tsn ./src/bin/tsc-prod.ts",
     "tsc-scripts": "tsn ./src/bin/tsc-scripts.ts",
@@ -77,6 +78,7 @@
   "types": "dist/index.d.ts",
   "bin": {
     "bt": "dist/bin/bt.js",
+    "btl": "dist/bin/btl.js",
     "build": "dist/bin/build.js",
     "build-copy": "dist/bin/build-copy.js",
     "build-prod": "dist/bin/build-prod.js",

package/readme.md

@@ -67,6 +67,7 @@ These commands are available to be called as `yarn <command>`, because they are
 - `build`: "Development build". Checks that "everything compiles". Does
   `del ./dist && tsc && tsc-scripts`
 - `bt`: "Build & Test". Does `del ./dist && tsc && tsc-scripts && test`
+- `btl`: "Build, Test & Lint". Does `lint-all && tsc && test`
 
 - `build-copy`: copies _additional files_ into `dist` folder (e.g `*.json`)
 - `build-prod`: "Production build". Does `del ./dist && build-copy && tsc-prod`
@@ -96,11 +97,10 @@ All test commands set `TZ=UTC`. You can override it by providing `TZ` env variab
 running a test command. Adds `APP_ENV=test` env var (for all runs except integration). Automatically
 adds `--silent` (and `JEST_SILENT` env var) if all tests are run.
 
-- `test`: runs unit tests (all tests _except_ `*.integration.test.ts` and `*.manual.test.ts`)
-- `test-ci`: runs test in CI environment, with coverage. Includes fix for "CircleCI out of memory
-  issue"
+- `test`: runs unit tests (all tests _except_ `*.integration.test.ts` and `*.manual.test.ts`).
+  Detects `CI` env variable, adds `--coverage` if in CI. Uses `default` reporter in `!CI`, otherwise
+  `jest-junit` reporter. Includes fix for "CircleCI out of memory issue"
 - `test-integration`: runs `*.integration.test.ts` with `jest.integration-test.config.js` config.
-- `test-integration-ci`
 - `test-manual`: runs `*.manual.test.ts` with `jest.manual-test.config.js`.
 - `test-leaks`: runs Jest with `--logHeapUsage --detectOpenHandles --detectLeaks` (requires `weak`
   module to be installed in target project).
@@ -149,11 +149,10 @@ Pass `--ext` (e.g `--ext ts,html`) to override the list of ESLint extensions (de
 
 `ktlint` will be used by lint-staged for all `**/*.{kt,kts}` files.
 
-Please install it with `brew install ktlint`.
+~~Please install it with `brew install ktlint`.~~
 
-Currently `ktlint` has a bug of not supporting absolute paths, to work around it use
-[this instruction](https://github.com/pinterest/ktlint/issues/1131#issuecomment-947570851) to
-install a working version.
+Install it **locally** in you project by adding
+[`@naturalcycles/ktlint`](https://github.com/NaturalCycles/ktlint) to your **dev**Dependencies.
 
 #### Other commands