feat: update deps, strengthen types

BREAKING CHANGE: following the deps, requires nodejs v16

Author: antongolub

.github/workflows/ci.yaml

@@ -81,7 +81,7 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-20.04 ]
-        node-version: [ 14, 18 ]
+        node-version: [ 16, 18 ]
     name: Test (Node v${{ matrix.node-version }}, OS ${{ matrix.os }})
     runs-on: ${{ matrix.os }}
     steps:

jest.config.json

@@ -2,7 +2,10 @@
   "preset": "ts-jest",
   "collectCoverage": true,
   "transform": {
-    "^.+\\.tsx?$": "ts-jest"
+    "^.+\\.tsx?$": ["ts-jest", {
+      "useESM": true,
+      "tsconfig": "<rootDir>/tsconfig.test.json"
+    }]
   },
   "extensionsToTreatAsEsm": [".ts"],
   "coveragePathIgnorePatterns": [
@@ -34,12 +37,6 @@
     "mjs",
     "cjs"
   ],
-  "globals": {
-    "ts-jest": {
-      "useESM": true,
-      "tsconfig": "<rootDir>/tsconfig.test.json"
-    }
-  },
   "snapshotResolver": "<rootDir>/jest.snapshot.cjs",
   "resolver": "<rootDir>/jest.resolver.cjs"
 }

package.json

@@ -27,7 +27,7 @@
     "test": "npm-run-all -p -l lint test:unit test:depcheck test:depaudit",
     "test:unit": "mkdirp src/test/temp && cross-env NODE_OPTIONS='--experimental-vm-modules' jest --config=jest.config.json --runInBand",
     "test:deps": "npm-run-all -p -l test:depcheck test:depauditfix",
-    "test:depcheck": "cross-env npm_config_yes=true npx -p depcheck -p @babel/[email protected] depcheck --ignores typedoc,tslib,flowgen,@qiwi/dts-bundle,eslint-config-*",
+    "test:depcheck": "cross-env npm_config_yes=true npx -p depcheck -p @babel/[email protected] depcheck --ignores typedoc,tslib,flowgen,@qiwi/dts-bundle,eslint-config-*,@types/jest",
     "test:depaudit": "yarn audit --level=moderate --groups=dependencies; [[ $? -ge 4 ]] && exit 1 || exit 0",
     "test:depauditfix": "npm_config_yes=true npx yarn-audit-fix --audit-level=moderate",
     "clean": "rimraf target typings flow-typed",
@@ -63,37 +63,37 @@
   },
   "dependencies": {
     "@qiwi/dts-bundle": "^0.7.5",
-    "chalk": "^5.0.1",
+    "chalk": "^5.2.0",
     "find-up": "^6.3.0",
-    "flowgen": "1.19.0",
-    "fs-extra": "^10.1.0",
-    "globby": "^13.1.1",
-    "meow": "^10.1.2",
-    "nanoid": "^3.3.4",
-    "pkg-dir": "^6.0.1",
+    "flowgen": "1.20.1",
+    "fs-extra": "^11.1.0",
+    "globby": "^13.1.3",
+    "meow": "^11.0.0",
+    "nanoid": "^4.0.0",
+    "pkg-dir": "^7.0.0",
     "tempy": "^3.0.0",
-    "tslib": "^2.4.0"
+    "tslib": "^2.4.1"
   },
   "devDependencies": {
-    "@jest/globals": "^28.1.0",
+    "@jest/globals": "^29.3.1",
     "@qiwi/npm-run-all": "^4.1.7",
     "@types/fs-extra": "^9.0.13",
-    "@types/jest": "^27.5.1",
+    "@types/jest": "^29.2.4",
     "@types/yargs-parser": "^21.0.0",
     "coveralls": "^3.1.1",
-    "cpy-cli": "^4.1.0",
+    "cpy-cli": "^4.2.0",
     "cross-env": "^7.0.3",
-    "eslint": "^8.16.0",
+    "eslint": "^8.30.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-config-qiwi": "^1.17.1",
-    "jest": "^28.1.0",
-    "prettier": "^2.6.2",
-    "prettier-config-qiwi": "^1.7.1",
+    "eslint-config-qiwi": "^2.0.6",
+    "jest": "^29.3.1",
+    "prettier": "^2.8.1",
+    "prettier-config-qiwi": "^2.0.1",
     "rimraf": "^3.0.2",
-    "ts-jest": "^28.0.3",
-    "typedoc": "^0.22.15",
-    "typescript": "^4.7.2",
-    "yargs-parser": "^21.0.1"
+    "ts-jest": "^29.0.3",
+    "typedoc": "^0.23.22",
+    "typescript": "^4.9.4",
+    "yargs-parser": "^21.1.1"
   },
   "prettier": "prettier-config-qiwi",
   "author": "QIWI <[email protected]>",

src/main/ts/dts.ts

@@ -4,7 +4,7 @@
 import fse from 'fs-extra'
 import { globbySync } from 'globby'
 import { nanoid } from 'nanoid'
-import { join } from 'path'
+import { join } from 'node:path'
 
 import { IContext, IExecPipe } from './interface'
 import { invoke } from './util'

src/main/ts/interface.ts

@@ -1,11 +1,11 @@
 /** @module @qiwi/libdefkit */
 /** */
 
-import { StdioOptions } from 'child_process'
+import { StdioOptions } from 'node:child_process'
 
 export type ICmdInvokeOptions = {
   cmd: string
-  args?: string[] | Record<string, any>
+  args?: string[] | TFlags
   cwd?: string
   silent?: boolean
   stdio?: StdioOptions
@@ -26,7 +26,8 @@ export type IContext = ICliFlags & {
   cache: string
   cwd: string
   name: string
-  [key: string]: any
-}
+} & TFlags
+
+export type TFlags = Record<string, string | boolean | number | Array<string | boolean | number>>
 
 export type IExecPipe = (ctx: IContext) => IContext | void

src/main/ts/libdefkit.ts

@@ -2,7 +2,7 @@
 /** */
 
 import fs from 'fs-extra'
-import { join } from 'path'
+import { join } from 'node:path'
 import { temporaryDirectory } from 'tempy'
 
 import { pipe as dtsgen } from './dts'

src/main/ts/util.ts

@@ -2,13 +2,13 @@
 /** */
 
 import chalk from 'chalk'
-import cp, { StdioOptions } from 'child_process'
+import cp, { StdioOptions } from 'node:child_process'
 import { findUpSync, pathExistsSync } from 'find-up'
 import { fileURLToPath } from 'node:url'
-import { dirname, resolve } from 'path'
+import { dirname, resolve } from 'node:path'
 import { packageDirectorySync } from 'pkg-dir'
 
-import { ICmdInvokeOptions } from './interface'
+import {ICmdInvokeOptions, TFlags} from './interface'
 
 const __dirname = dirname(fileURLToPath(import.meta.url))
 
@@ -42,17 +42,17 @@ export const invoke = ({
   const result = cp.spawnSync(_cmd, _args, { cwd, stdio })
 
   if (result.error || result.status) {
-    throw result
+    throw Object.assign(new Error(result.stderr.toString().trim()), result)
   }
 
   return result.stdout?.toString().trim() ?? result.stdout
 }
 
 const checkValue = (
   key: string,
-  value: any,
-  omitlist: any[],
-  picklist: any[],
+  value: TFlags[string],
+  omitlist: string[],
+  picklist: string[],
 ): boolean =>
   value !== 'false' &&
   !omitlist.includes(key) &&
@@ -62,7 +62,7 @@ const formatFlag = (key: string): string =>
   (key.length === 1 ? '-' : '--') + key
 
 export const formatFlags = (
-  flags: Record<string, any> = {},
+  flags: TFlags = {},
   picklist: string[] = [],
 ): string[] =>
   Object.keys(flags).reduce<string[]>((memo, key: string) => {
@@ -71,18 +71,20 @@ export const formatFlags = (
     const flag = formatFlag(key)
 
     if (checkValue(key, value, omitlist, picklist)) {
-      memo.push(flag)
+      [value].flat().forEach((v) => {
+        memo.push(flag)
 
-      if (value !== true) {
-        memo.push(value)
-      }
+        if (v !== true) {
+          memo.push(v + '')
+        }
+      })
     }
 
     return memo
   }, [])
 
 export const formatArgs = (
-  args: Record<string, any> | string[] = {},
+  args: string[] | TFlags = {},
   picklist?: string[],
 ): string[] => (Array.isArray(args) ? args : formatFlags(args, picklist))
 
@@ -101,5 +103,5 @@ export const getClosestBin = (
   cwd: string = process.cwd(),
 ): string =>
   findBin(cmd, cwd) ||
-  findBin(cmd, packageDirectorySync({ cwd: __dirname })) ||
+  findBin(cmd, packageDirectorySync({ cwd: __dirname }) as string) ||
   cmd

src/test/ts/libdefkit.ts

@@ -1,7 +1,7 @@
 import '@jest/globals'
 
 import { fileURLToPath } from 'node:url'
-import { dirname, join, resolve } from 'path'
+import { dirname, join, resolve } from 'node:path'
 
 import { execute } from '../../main/ts'
 

src/test/ts/libdefkit.ts.snap

@@ -1,9 +1,9 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`libdefkit #execute returns proper dts bundle 1`] = `
-Object {
+{
   "cache": "<cache>",
-  "customTypings": Array [
+  "customTypings": [
     "customTypings/**/*.d.ts",
   ],
   "cwd": "<cwd>",
@@ -13,7 +13,7 @@ Object {
 }
 // Generated by dts-bundle v0.7.5
 // Dependencies for this module:
-//   ../../../../../../../../child_process
+//   ../../../../../../../../node:child_process
 
 declare module '@qiwi/libdefkit/target/es6' {
     /** */
@@ -32,10 +32,10 @@ declare module '@qiwi/libdefkit/target/es6/libdefkit' {
 
 declare module '@qiwi/libdefkit/target/es6/interface' {
     /** */
-    import { StdioOptions } from 'child_process';
+    import { StdioOptions } from 'node:child_process';
     export type ICmdInvokeOptions = {
         cmd: string;
-        args?: string[] | Record<string, any>;
+        args?: string[] | TFlags;
         cwd?: string;
         silent?: boolean;
         stdio?: StdioOptions;
@@ -54,8 +54,8 @@ declare module '@qiwi/libdefkit/target/es6/interface' {
         cache: string;
         cwd: string;
         name: string;
-        [key: string]: any;
-    };
+    } & TFlags;
+    export type TFlags = Record<string, string | boolean | number | Array<string | boolean | number>>;
     export type IExecPipe = (ctx: IContext) => IContext | void;
 }
 
@@ -67,7 +67,7 @@ declare module '@qiwi/libdefkitfake' {
   "entry": "@qiwi/libdefkit/target/es6",
   "flowOut": "<cwd>/src/test/temp/index.flow.js",
   "name": "@qiwi/libdefkit",
-  "tsconfig": Array [
+  "tsconfig": [
     "tsconfig.es6.json",
   ],
 }

src/test/ts/util.ts

@@ -1,11 +1,12 @@
 import { jest } from '@jest/globals'
-import cp from 'child_process'
+import cp from 'node:child_process'
 import fse from 'fs-extra'
 import { fileURLToPath } from 'node:url'
-import { dirname, resolve } from 'path'
+import { dirname, resolve } from 'node:path'
+import process from 'node:process'
 import parseArguments from 'yargs-parser'
 
-import { ICmdInvokeOptions } from '../../main/ts/interface'
+import {ICmdInvokeOptions, TFlags} from '../../main/ts/interface'
 import {
   formatArgs,
   getClosestBin,
@@ -17,12 +18,20 @@ import {
 const dotcmd = process.platform === 'win32' ? '.cmd' : ''
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = dirname(__filename)
+const spawnResult = ({status = 0, stdout = '', stderr = ''} = {}): ReturnType<typeof cp.spawnSync> => ({
+  status,
+  stdout: Buffer.from(stdout),
+  stderr: Buffer.from(stderr),
+  pid: process.pid,
+  signal: null,
+  output: [],
+})
 const fakeExistsSync = jest.fn((cmd) => cmd !== 'not-found' + dotcmd)
 const fakeSpawnSync = jest.fn((cmd: string) => {
-  const results: Record<string, any> = {
-    error: { status: 1, stderr: 'some error' },
-    def: { status: 0, stdout: 'foobar' },
-    null: { status: 0, stdout: null },
+  const results: Record<string, ReturnType<typeof cp.spawnSync>> = {
+    error: spawnResult({ status: 1, stderr: 'some error' }),
+    def: spawnResult({ stdout: 'foobar' }),
+    empty: spawnResult({ stdout: '' }),
   }
 
   return results[cmd.replace(dotcmd, '')] || results.def
@@ -31,10 +40,7 @@ const fakeSpawnSync = jest.fn((cmd: string) => {
 beforeAll(() => {
   jest.spyOn(cp, 'spawnSync').mockImplementation(fakeSpawnSync)
   jest.spyOn(fse, 'existsSync').mockImplementation(fakeExistsSync)
-  // @ts-ignore
-  jest.spyOn(process, 'exit').mockImplementation(() => {
-    /* noop */
-  })
+  jest.spyOn(process, 'exit').mockImplementation(() => undefined as never)
 })
 afterEach(jest.clearAllMocks)
 afterAll(jest.resetAllMocks)
@@ -48,7 +54,7 @@ describe('util', () => {
       ICmdInvokeOptions,
       string?,
       (string | null)?,
-      any?,
+      (Parameters<typeof spawnResult>[0] | null)?,
     ][] = [
       ['uses global cmd ref', { cmd: 'tsc' }, 'tsc'],
       [
@@ -65,10 +71,10 @@ describe('util', () => {
         'foobar',
       ],
       [
-        'returns null if stdout is null',
-        { cmd: 'null', silent: true },
-        'null',
-        null,
+        'returns "" if stdout is empty',
+        { cmd: 'empty', silent: true },
+        'empty',
+        '',
       ],
       [
         'throws error if result.signal is not equal 0',
@@ -89,7 +95,7 @@ describe('util', () => {
           }
 
           if (expectedError) {
-            expect(() => invoke(opts)).toThrowError(new Error(expectedError))
+            expect(() => invoke(opts)).toThrowError(new Error(expectedError.stderr?.toString()))
           } else {
             expect(invoke(opts)).toEqual(
               expectedResult === null ? expectedResult : expect.any(String),
@@ -109,7 +115,7 @@ describe('util', () => {
 
   describe('#formatArgs', () => {
     it('return proper values', () => {
-      const cases: [Record<string, any>, string[], string[]][] = [
+      const cases: [TFlags, string[], string[]][] = [
         [{ _: [], '--': [] }, [], []],
         [{ foo: 'bar' }, [], ['--foo', 'bar']],
         [{ f: true }, [], ['-f']],