DEPRECATE: move env/logger/main code to @dr-js/core

dr-js · dr-js · commit efbeac7eb330 · 2021-08-13T17:40:38.000+08:00
diff --git a/SPEC.md b/SPEC.md
@@ -8,15 +8,15 @@
 + 📄 [source/babel.js](source/babel.js)
   - `getBabelConfig`, `getWebpackBabelConfig`
 + 📄 [source/ci.js](source/ci.js)
-  - `commonInfoPatchCombo`
+  - `commonInfoPatchCombo`, `runInfoPatchCombo`
 + 📄 [source/docker.js](source/docker.js)
   - `checkImageExist`, `checkLocalImage`, `checkPullImage`, `compose`, `composeSync`, `docker`, `dockerSync`, `dockerWithTee`, `getContainerLsList`, `getContainerPsList`, `matchContainerLsList`, `matchContainerPsList`, `patchContainerLsListStartedAt`, `pullImage`, `runDocker`, `runDockerWithTee`
 + 📄 [source/fileProcessor.js](source/fileProcessor.js)
   - `fileProcessorBabel`, `fileProcessorWebpack`, `processFileList`
 + 📄 [source/license.js](source/license.js)
   - `writeLicenseFile`
 + 📄 [source/main.js](source/main.js)
-  - `argvFlag`, `commonCombo`, `commonInfoPatchCombo`, `existsSync`, `readFileSync`, `resolve`, `runMain`, `sep`, `writeFileSync`
+  - `argvFlag`, `commonCombo`, `commonInfoPatchCombo`, `existsSync`, `readFileSync`, `resolve`, `runInfoPatchCombo`, `runMain`, `sep`, `writeFileSync`
 + 📄 [source/minify.js](source/minify.js)
   - `getTerserOption`, `minifyFileListWithTerser`, `minifyFileWithTerser`
 + 📄 [source/output.js](source/output.js)
diff --git a/script/packResource.js b/script/packResource.js
@@ -4,8 +4,8 @@ import { readJSON, writeText } from '@dr-js/core/module/node/fs/File.js'
 import { resetDirectory } from '@dr-js/core/module/node/fs/Directory.js'
 import { modifyCopy } from '@dr-js/core/module/node/fs/Modify.js'
 import { writePackageJSON } from '@dr-js/core/module/node/module/PackageJSON.js'
+import { getKitLogger } from '@dr-js/core/module/node/kit.js'
 
-import { getLogger } from 'source/node/logger.js'
 import { packOutput, publishOutput } from 'source/output.js'
 import { getFromPackExport, writePackExportInitJSON } from 'source-bin/function.js'
 
@@ -65,7 +65,7 @@ const doPackResource = async ({
   configJSONFile, pathOutput,
   outputName, outputVersion, outputDescription,
   isPublish = false, isPublishDev = false, isDryRun = false,
-  logger = getLogger('pack')
+  logger = getKitLogger({ title: 'pack' })
 }) => {
   const { packageJSON, exportPairList } = await loadConfig({ configJSONFile, logger })
   if (outputName) packageJSON.name = outputName
diff --git a/source/ci.js b/source/ci.js
@@ -7,32 +7,38 @@ import { getPathNpm } from '@dr-js/core/module/node/module/Software/npm.js'
 
 import { commonCombo } from './output.js'
 
+const runInfoPatchCombo = ({ RUN, padLog, log }) => {
+  padLog('Log info')
+  log(`system: ${process.platform}-${release()}[${arch()}]`)
+  log(`node: ${process.version}`)
+  log(`npm: ${require(resolve(getPathNpm(), './package.json')).version}`)
+  log(`with: ${[ '@dr-js/core', '@dr-js/dev' ].map((v) => `${v}@${require(`${v}/package.json`).version}`).join(', ')}`)
+
+  if (process.platform === 'win32') {
+    padLog('Patch git') // fix win32 CI cause `something to commit` test error: https://github.com/actions/checkout/issues/135#issuecomment-602171132
+    RUN('git config core.autocrlf false')
+    RUN('git config core.eol lf')
+    RUN('git rm --cached -r .') // reset Git index, `rm .git/index` also work, check: https://stackoverflow.com/questions/5787937/git-status-shows-files-as-changed-even-though-contents-are-the-same/41041699#41041699
+    RUN('git reset --hard')
+  }
+}
+
 // NOTE: test local ci-patch with command like:
 //   DRY_RUN=1 npx dr-js-dev-*.tgz -eI .github/ci-patch.js
 
-const commonInfoPatchCombo = (logger, initConfig) => {
+const commonInfoPatchCombo = (logger, initConfig) => { // TODO: DEPRECATE
   const { config, RUN, ...extra } = commonCombo(logger, initConfig)
 
   // patch config
   config.IS_WIN32 = process.platform === 'win32' // TODO: DEPRECATE
   config.COMMAND_SUDO_NPM = config.IS_WIN32 ? 'npm.cmd' : 'sudo npm' // win32 has no sudo & need .cmd extension // TODO: DEPRECATE
-
-  logger.padLog('Log info')
-  logger.log(`system: ${process.platform}-${release()}[${arch()}]`)
-  logger.log(`node: ${process.version}`)
-  logger.log(`npm: ${require(resolve(getPathNpm(), './package.json')).version}`)
-  logger.log(`with: ${[ '@dr-js/core', '@dr-js/dev' ].map((v) => `${v}@${require(`${v}/package.json`).version}`).join(', ')}`)
   logger.log(`config:\n${prettyStringifyConfigObject(config, '  ', '    ')}`)
-
-  if (process.platform === 'win32') {
-    logger.padLog('Patch git') // fix win32 CI cause `something to commit` test error: https://github.com/actions/checkout/issues/135#issuecomment-602171132
-    RUN('git config core.autocrlf false')
-    RUN('git config core.eol lf')
-    RUN('git rm --cached -r .') // reset Git index, `rm .git/index` also work, check: https://stackoverflow.com/questions/5787937/git-status-shows-files-as-changed-even-though-contents-are-the-same/41041699#41041699
-    RUN('git reset --hard')
-  }
+  runInfoPatchCombo({ ...logger, RUN })
 
   return { config, RUN, ...extra }
 }
 
-export { commonInfoPatchCombo }
+export {
+  runInfoPatchCombo,
+  commonInfoPatchCombo // TODO: DEPRECATE
+}
diff --git a/source/ci.test.js b/source/ci.test.js
@@ -1,13 +1,13 @@
-import { getLogger } from 'source/node/logger.js'
-import { commonInfoPatchCombo } from './ci.js'
+import { getKit } from '@dr-js/core/module/node/kit.js'
+import { runInfoPatchCombo } from './ci.js'
 
 const { describe, it, info = console.log } = globalThis
 
 describe('CI', () => {
-  it('commonInfoPatchCombo()', async () => {
-    process.env.DRY_RUN = true
-    const result = commonInfoPatchCombo(getLogger('test-ci', false, 32, info))
-    delete process.env.DRY_RUN
-    __DEV__ && console.log(result)
+  it('runInfoPatchCombo()', async () => {
+    runInfoPatchCombo(getKit({
+      title: 'test-ci', isQuiet: false, padWidth: 32, logFunc: info,
+      isDryrun: true
+    }))
   })
 })
diff --git a/source/main.js b/source/main.js
@@ -1,37 +1,25 @@
 import { resolve, sep } from 'path'
 import { readFileSync, writeFileSync, existsSync } from 'fs'
-
-import { clock } from '@dr-js/core/module/common/time.js'
-import { time } from '@dr-js/core/module/common/format.js'
 import { isString } from '@dr-js/core/module/common/check.js'
-
-import { argvFlag } from './node/env.js'
-import { getLogger } from './node/logger.js'
-import { commonCombo } from './output.js'
-import { commonInfoPatchCombo } from './ci.js'
+import { getKit, runKit } from '@dr-js/core/module/node/kit.js'
 
 const runMain = (
   mainAsyncFunc,
-  loggerOrTitle = process.argv.slice(2).join('+'),
+  kitLoggerOrTitle = process.argv.slice(2).join('+'),
   ...args
-) => {
-  const startTime = clock()
-  const logger = isString(loggerOrTitle)
-    ? getLogger(loggerOrTitle, argvFlag('quiet'))
-    : loggerOrTitle
-  new Promise((resolve) => resolve(mainAsyncFunc(logger, ...args))).then(
-    () => { logger.padLog(`done in ${time(clock() - startTime)}`) },
-    (error) => {
-      console.warn(error)
-      logger.padLog(`error after ${time(clock() - startTime)}: ${error}`)
-      process.exit(-1)
-    }
-  )
-}
+) => runKit(
+  (kit) => mainAsyncFunc(kit, ...args),
+  isString(kitLoggerOrTitle)
+    ? { title: kitLoggerOrTitle }
+    : { kit: { ...getKit(), ...kitLoggerOrTitle } }
+)
 
 export {
-  runMain,
+  runMain, // TODO: DEPRECATE
   // quick import // TODO: DEPRECATE: move to `combo.js`
-  argvFlag, commonCombo, commonInfoPatchCombo,
-  resolve, sep, readFileSync, writeFileSync, existsSync
+  resolve, sep, readFileSync, writeFileSync, existsSync // TODO: DEPRECATE
 }
+
+export { commonCombo } from './output.js' // TODO: DEPRECATE
+export { runInfoPatchCombo, commonInfoPatchCombo } from './ci.js' // TODO: DEPRECATE
+export { argvFlag } from '@dr-js/core/module/node/kit.js' // TODO: DEPRECATE
diff --git a/source/node/env.js b/source/node/env.js
@@ -1,31 +1,15 @@
-const loadEnvKey = (key) => {
-  try {
-    return JSON.parse(process.env[ key ])
-  } catch (error) { return null }
-}
-const saveEnvKey = (key, value) => {
-  try {
-    process.env[ key ] = JSON.stringify(value)
-  } catch (error) {}
-}
-const syncEnvKey = (key, defaultValue) => {
-  const value = loadEnvKey(key) || defaultValue
-  saveEnvKey(key, value)
-  return value
-}
+import { syncEnvKey } from '@dr-js/core/module/node/kit.js'
 
 const __VERBOSE__ = syncEnvKey('__DEV_VERBOSE__', process.argv.includes('verbose'))
 
 const checkFlag = (flagList, checkFlagList) => flagList.find((flag) => checkFlagList.includes(flag))
 
-const argvFlag = (...checkFlagList) => checkFlag(process.argv, checkFlagList)
-
 export {
-  loadEnvKey,
-  saveEnvKey,
-  syncEnvKey,
-
   __VERBOSE__,
-  checkFlag,
-  argvFlag
+  checkFlag
 }
+
+export {
+  loadEnvKey, saveEnvKey, syncEnvKey, // TODO: DEPRECATE
+  argvFlag // TODO: DEPRECATE
+} from '@dr-js/core/module/node/kit.js'
diff --git a/source/node/logger.js b/source/node/logger.js
@@ -1,50 +1,15 @@
-import { clock } from '@dr-js/core/module/common/time.js'
-import { time } from '@dr-js/core/module/common/format.js'
-import { clamp } from '@dr-js/core/module/common/math/base.js'
+import { getKitLogger } from '@dr-js/core/module/node/kit.js'
 
-import { configureTerminalColor } from '@dr-js/core/module/node/module/TerminalColor.js'
-
-import { loadEnvKey, saveEnvKey, __VERBOSE__ } from './env.js'
-
-const EMPTY_FUNC = () => {}
-
-const TerminalColor = configureTerminalColor()
-const getLogger = (
+const getLogger = ( // TODO: DEPRECATE: confuse with `node/module/Logger.js` from `@dr-js/core`, use `kit` or `kitLogger`
   title = 'dev',
   quiet = false,
-  padWidth = clamp((process.stdout.isTTY && process.stdout.columns) || 80, 64, 240),
-  logFunc = console.log
-) => {
-  const envTitle = loadEnvKey('__DEV_LOGGER_TITLE__')
-  title = envTitle ? `${title}|${envTitle}` : title
-  saveEnvKey('__DEV_LOGGER_TITLE__', title)
-
-  const startTime = clock()
-  let prevTime = clock()
-  const getPadTime = () => {
-    const currentTime = clock()
-    prevTime = currentTime
-    return time(currentTime - startTime)
-  }
-  const getStepTime = () => {
-    const currentTime = clock()
-    const stepTime = currentTime - prevTime
-    prevTime = currentTime
-    return time(stepTime)
-  }
-
-  const padLog = (...args) => {
-    const start = `## ${args.join(' ')} `
-    const end = ` [${title}|${getPadTime()}]`
-    logFunc(`\n${start.padEnd(padWidth - end.length, '-')}${TerminalColor.fg.yellow(end)}`)
-  }
-  const stepLog = (...args) => logFunc(`- ${TerminalColor.fg.yellow(`(+${getStepTime()})`)} ${args.join(' ')}`)
-  const log = (...args) => logFunc(TerminalColor.fg.darkGray(`- ${args.join(' ')}`))
-  const devLog = __VERBOSE__ ? log : EMPTY_FUNC
-
-  return quiet
-    ? { padLog: stepLog, stepLog: devLog, log: devLog, devLog: EMPTY_FUNC }
-    : { padLog, stepLog, log, devLog }
-}
-
-export { getLogger }
+  padWidth,
+  logFunc
+) => getKitLogger({
+  title,
+  isQuiet: quiet,
+  padWidth,
+  logFunc
+})
+
+export { getLogger } // TODO: DEPRECATE: confuse with `node/module/Logger.js` from `@dr-js/core`, use `kit` or `kitLogger`
diff --git a/source/output.js b/source/output.js
@@ -1,59 +1,34 @@
 import { ok } from 'assert'
-import { resolve } from 'path'
-import { homedir, tmpdir } from 'os'
 import { statSync, readFileSync, writeFileSync } from 'fs'
 import { binary } from '@dr-js/core/module/common/format.js'
 import { isBasicObject } from '@dr-js/core/module/common/check.js'
 import { getFirstBinPath } from '@dr-js/core/module/common/module/PackageJSON.js'
 import { getFileList, resetDirectory } from '@dr-js/core/module/node/fs/Directory.js'
 import { modifyCopy, modifyRename, modifyDelete } from '@dr-js/core/module/node/fs/Modify.js'
-import { resolveCommand } from '@dr-js/core/module/node/system/ResolveCommand.js'
-import { runSync, runStdout, runDetached } from '@dr-js/core/module/node/run.js'
+import { runStdout } from '@dr-js/core/module/node/run.js'
+import { argvFlag, getKitPathCombo, getKitRun } from '@dr-js/core/module/node/kit.js'
 
-import { findUpPackageRoot, toPackageTgzName, runNpm } from '@dr-js/core/module/node/module/Software/npm.js'
+import { toPackageTgzName, runNpm } from '@dr-js/core/module/node/module/Software/npm.js'
 import { runGitStdout, runGitStdoutSync } from '@dr-js/core/module/node/module/Software/git.js'
 
-import { __VERBOSE__, argvFlag } from './node/env.js'
+import { __VERBOSE__ } from './node/env.js'
 import { FILTER_TEST_PATH } from './node/preset.js'
 import { getFileListFromPathList } from './node/file.js'
 import { writeLicenseFile } from './license.js'
 
-const fromPathCombo = ({
-  PATH_ROOT = findUpPackageRoot(process.cwd()),
-  PATH_OUTPUT = 'output-gitignore/', // relative
-  PATH_TEMP = '.temp-gitignore/', // relative
-  PATH_HOME = homedir(),
-  PATH_OSTEMP = tmpdir()
-} = {}) => {
-  // allow use relative path from PATH_ROOT
-  PATH_OUTPUT = resolve(PATH_ROOT, PATH_OUTPUT)
-  PATH_TEMP = resolve(PATH_ROOT, PATH_TEMP)
-  PATH_HOME = resolve(PATH_ROOT, PATH_HOME)
-  PATH_OSTEMP = resolve(PATH_ROOT, PATH_OSTEMP)
-  return {
-    PATH_ROOT, fromRoot: (...args) => resolve(PATH_ROOT, ...args),
-    PATH_OUTPUT, fromOutput: (...args) => resolve(PATH_OUTPUT, ...args),
-    PATH_TEMP, fromTemp: (...args) => resolve(PATH_TEMP, ...args),
-    PATH_HOME, fromHome: (...args) => resolve(PATH_HOME, ...args),
-    PATH_OSTEMP, fromOsTemp: (...args) => resolve(PATH_OSTEMP, ...args)
-  }
-}
-
-const commonCombo = (
+const commonCombo = ( // TODO: DEPRECATE
   logger,
   config = {
     DRY_RUN: Boolean(process.env.DRY_RUN),
     QUIET_RUN: argvFlag('quiet') || Boolean(process.env.QUIET_RUN)
   }
 ) => {
-  const pathConfig = fromPathCombo(config)
-  const RUN = (argListOrString, optionOrIsDetached) => { // TODO: DEPRECATE: move `isDetached` in to option object
-    const { isDetached = false, ...option } = isBasicObject(optionOrIsDetached) ? optionOrIsDetached : { isDetached: Boolean(optionOrIsDetached) }
-    const argList = Array.isArray(argListOrString) ? [ ...argListOrString ] : argListOrString.split(' ').filter(Boolean) // prepend `'bash', '-c'` to run in bash shell
-    argList[ 0 ] = resolveCommand(argList[ 0 ], pathConfig.PATH_ROOT) // mostly for finding `npm.cmd` on win32
-    if (config.DRY_RUN) !config.QUIET_RUN && logger.log(`[${config.DRY_RUN ? 'RUN|DRY' : isDetached ? 'RUN|DETACHED' : 'RUN'}] "${argList.join(' ')}"`)
-    else return (isDetached ? runDetached : runSync)(argList, { cwd: pathConfig.PATH_ROOT, stdio: config.QUIET_RUN ? [ 'ignore', 'ignore', 'inherit' ] : 'inherit', ...option })
-  }
+  const pathConfig = getKitPathCombo(config)
+  const kitRun = getKitRun({ ...config, ...pathConfig, log: logger.log, isQuiet: config.QUIET_RUN, isDryRun: config.DRY_RUN })
+  const RUN = (argListOrString, optionOrIsDetached) => kitRun.RUN( // TODO: DEPRECATE: move `isDetached` in to option object
+    argListOrString,
+    isBasicObject(optionOrIsDetached) ? optionOrIsDetached : { isDetached: Boolean(optionOrIsDetached) }
+  )
   return { config, ...pathConfig, RUN }
 }
 
@@ -213,11 +188,15 @@ const REGEXP_PUBLISH_VERSION = /^\d+\.\d+\.\d+$/ // 0.0.0
 const REGEXP_PUBLISH_VERSION_DEV = /^\d+\.\d+\.\d+-dev\.\d+$/ // 0.0.0-dev.0
 
 export {
-  fromPathCombo, commonCombo,
+  commonCombo,
   initOutput,
   packOutput,
   clearOutput,
   verifyOutputBin,
   verifyNoGitignore, verifyGitStatusClean,
   publishOutput, getPublishFlag, verifyPublishVersion, REGEXP_PUBLISH_VERSION, REGEXP_PUBLISH_VERSION_DEV
 }
+
+export {
+  getKitPathCombo as fromPathCombo // TODO: DEPRECATE
+} from '@dr-js/core/module/node/kit.js'
diff --git a/source/output.test.js b/source/output.test.js
@@ -6,16 +6,15 @@ import { stringifyEqual, doThrow, doNotThrow, doThrowAsync, doNotThrowAsync } fr
 import { STAT_ERROR, getPathLstat } from '@dr-js/core/module/node/fs/Path.js'
 import { resetDirectory } from '@dr-js/core/module/node/fs/Directory.js'
 import { modifyDelete } from '@dr-js/core/module/node/fs/Modify.js'
+import { getKitLogger } from '@dr-js/core/module/node/kit.js'
 
 import {
-  fromPathCombo,
   initOutput,
   packOutput,
   // verifyOutputBin,
   verifyNoGitignore,
   publishOutput, getPublishFlag, verifyPublishVersion
 } from './output.js'
-import { getLogger } from './node/logger.js'
 
 const { describe, it, before, after, info = console.log } = globalThis
 
@@ -30,20 +29,18 @@ describe('Output', () => {
   const fromTestRoot = (...args) => resolve(PATH_TEST_ROOT, ...args)
   const fromRoot = (...args) => resolve(PATH_ROOT, ...args) // use outer package
   const logList = []
-  const logger = getLogger(undefined, undefined, undefined, (log) => {
-    logList.unshift(log)
-    logList.length = 8
-    info(log)
+  const logger = getKitLogger({
+    logFunc: (log) => {
+      logList.unshift(log)
+      logList.length = 8
+      info(log)
+    }
   })
   const verifyLog = (expectLog) => {
     if (logList.some((log) => log && log.includes(expectLog))) return
     throw new Error(`[verifyLog] expectLog: ${expectLog}, get:\n${logList.map((log) => indentLine(log, '  > ', ' >> ')).join('\n')}`)
   }
 
-  it('fromPathCombo()', async () => {
-    info(fromPathCombo({ PATH_ROOT: '/aa/bb' }).fromOutput('cc', 'dd'))
-  })
-
   it('initOutput()', async () => {
     const fromOutput = (...args) => fromTestRoot('output-initOutput', ...args)
     const replaceReadmeNonPackageContent = '\n\nTEST_REPLACE_README_NON_PACKAGE_CONTENT'
diff --git a/source/webpack.js b/source/webpack.js
