@xylabs/ts-scripts-yarn3 3.2.42 → 3.3.0

package/src/actions/package/copy-assets.ts

@@ -1,6 +1,7 @@
+import path from 'node:path/posix'
+
 import chalk from 'chalk'
 import cpy from 'cpy'
-import path from 'path/posix'
 
 export interface PackageCopyAssetsParams {
   target?: 'esm' | 'cjs'
@@ -19,9 +20,9 @@ const copyTargetAssets = async (target: 'esm' | 'cjs', name: string, location: s
     if (values.length > 0) {
       console.log(chalk.green(`Copying Assets [${target.toUpperCase()}] - ${name} - ${location}`))
     }
-    values.forEach((value) => {
+    for (const value of values) {
       console.log(`${value.split('/').pop()} => ./dist/${target}`)
-    })
+    }
     return 0
   } catch (ex) {
     const error = ex as Error
@@ -34,11 +35,14 @@ export const packageCopyAssets = async ({ target }: PackageCopyAssetsParams) =>
   const pkg = process.env.INIT_CWD ?? './'
   const pkgName = process.env.npm_package_name ?? 'Unknown'
   switch (target) {
-    case 'esm':
+    case 'esm': {
       return await copyTargetAssets('esm', pkgName, pkg)
-    case 'cjs':
+    }
+    case 'cjs': {
       return await copyTargetAssets('cjs', pkgName, pkg)
-    default:
+    }
+    default: {
       return (await copyTargetAssets('esm', pkgName, pkg)) || (await copyTargetAssets('cjs', pkgName, pkg))
+    }
   }
 }

package/src/actions/package/deps.ts

@@ -1,8 +1,9 @@
 /* eslint-disable max-statements */
+import { existsSync, readFileSync } from 'node:fs'
+import { cwd } from 'node:process'
+
 import chalk from 'chalk'
 import depcheck, { special } from 'depcheck'
-import { existsSync, readFileSync } from 'fs'
-import { cwd } from 'process'
 
 import { checkResult } from '../../lib'
 
@@ -18,20 +19,19 @@ const defaultIgnoreDevDeps = [
 const defaultIgnoreDevPatterns = ['*.stories.*', '*.spec.*', 'spec', 'stories', 'tsconfig.json']
 
 const reportUnused = (name: string, unused: depcheck.Results['dependencies']) => {
-  if (unused.length) {
+  if (unused.length > 0) {
     const message = [chalk.yellow(`${unused.length} Unused ${name}`)]
-    unused.forEach((value) => message.push(chalk.gray(`  ${value}`)))
+    for (const value of unused) message.push(chalk.gray(`  ${value}`))
     console.log(message.join('\n'))
   }
 }
 
 const reportMissing = (name: string, missing: depcheck.Results['missing']) => {
-  if (Object.keys(missing).length) {
+  if (Object.keys(missing).length > 0) {
     const message = [chalk.yellow(`${Object.entries(missing).length} Missing ${name}`)]
-    Object.entries(missing).forEach(([key, value]) => {
-      message.push(`${key}`)
-      message.push(chalk.gray(`  ${value.at(0)}`))
-    })
+    for (const [key, value] of Object.entries(missing)) {
+      message.push(`${key}`, chalk.gray(`  ${value.at(0)}`))
+    }
     console.log(chalk.yellow(message.join('\n')))
   }
 }
@@ -68,9 +68,8 @@ export const packageDeps = async () => {
 
   const packageContent = existsSync(`${pkg}/package.json`) ? JSON.parse(readFileSync(`${pkg}/package.json`, { encoding: 'utf8' })) : undefined
 
-  const rawIgnore = existsSync(`${pkg}/.depcheckrc`)
-    ? readFileSync(`${pkg}/.depcheckrc`, { encoding: 'utf8' }).replace('ignores:', '"ignores":')
-    : undefined
+  const rawIgnore =
+    existsSync(`${pkg}/.depcheckrc`) ? readFileSync(`${pkg}/.depcheckrc`, { encoding: 'utf8' }).replace('ignores:', '"ignores":') : undefined
   let ignoreMatches: string[] = []
   try {
     ignoreMatches = rawIgnore ? (JSON.parse(`{${rawIgnore}}`).ignores as string[]) : []
@@ -92,16 +91,16 @@ export const packageDeps = async () => {
   const missingDevDeps = Object.keys(usedDevDeps).filter((key) => !declaredDevDeps.includes(key) && !declaredDeps.includes(key))
 
   const missingDepsObject: Record<string, string[]> = {}
-  missingDeps.forEach((key) => {
+  for (const key of missingDeps) {
     missingDepsObject[key] = missing[key] ?? [`devDep should be dep [${key}]`]
-  })
+  }
 
   const missingDevDepsObject: Record<string, string[]> = {}
-  missingDevDeps.forEach((key) => {
+  for (const key of missingDevDeps) {
     if (missing[key]) {
       missingDevDepsObject[key] = missing[key]
     }
-  })
+  }
 
   const errorCounts = [
     unusedDeps.length,
@@ -123,12 +122,12 @@ export const packageDeps = async () => {
   reportUnused('dependencies', unusedDeps)
   reportUnused('devDependencies', unusedDevDeps)
 
-  if (Object.entries(invalidDirs).length) {
-    Object.entries(invalidDirs).forEach(([key, value]) => console.warn(chalk.gray(`Invalid Dir: ${key}: ${value}`)))
+  if (Object.entries(invalidDirs).length > 0) {
+    for (const [key, value] of Object.entries(invalidDirs)) console.warn(chalk.gray(`Invalid Dir: ${key}: ${value}`))
   }
 
-  if (Object.entries(invalidFiles).length) {
-    Object.entries(invalidFiles).forEach(([key, value]) => console.warn(chalk.gray(`Invalid File: ${key}: ${value}`)))
+  if (Object.entries(invalidFiles).length > 0) {
+    for (const [key, value] of Object.entries(invalidFiles)) console.warn(chalk.gray(`Invalid File: ${key}: ${value}`))
   }
 
   reportMissing('dependencies', missingDepsObject)

package/src/actions/package/gen-docs.ts

@@ -19,10 +19,8 @@ const ExitCodes = {
 export const packageGenDocs = async () => {
   const pkg = process.env.INIT_CWD
 
-  if (pkg) {
-    if (!existsSync(path.join(pkg, 'typedoc.json'))) {
-      return
-    }
+  if (pkg && !existsSync(path.join(pkg, 'typedoc.json'))) {
+    return
   }
 
   const app = await Application.bootstrap({

package/src/actions/package/publint.ts

@@ -1,5 +1,6 @@
+import { promises as fs } from 'node:fs'
+
 import chalk from 'chalk'
-import { promises as fs } from 'fs'
 import { Message } from 'publint'
 
 export interface PackagePublintParams {
@@ -46,19 +47,22 @@ export const packagePublint = async (params?: PackagePublintParams) => {
 
   //we filter out invalid file formats for the esm folder since it is intentionally done
   const validMessages = messages.filter(validMessage)
-  validMessages.forEach((message: Message) => {
+  for (const message of validMessages) {
     switch (message.type) {
-      case 'error':
+      case 'error': {
         console.error(chalk.red(`[${message.code}] ${formatMessage(message, pkg)}`))
         break
-      case 'warning':
+      }
+      case 'warning': {
         console.warn(chalk.yellow(`[${message.code}] ${formatMessage(message, pkg)}`))
         break
-      default:
+      }
+      default: {
         console.log(chalk.white(`[${message.code}] ${formatMessage(message, pkg)}`))
         break
+      }
     }
-  })
+  }
 
   if (params?.verbose) {
     console.log(chalk.gray(`Publint [Finish]: ${pkgDir} [${validMessages.length}]`))

package/src/actions/reinstall.ts

@@ -1,4 +1,4 @@
-import { closeSync, openSync, rmSync } from 'fs'
+import { closeSync, openSync, rmSync } from 'node:fs'
 
 import { runSteps, yarnWorkspaces } from '../lib'
 
@@ -20,6 +20,7 @@ export const reinstall = () => {
         return 1
       }
     })
+    // eslint-disable-next-line unicorn/no-array-reduce
     .reduce((prev, result) => prev || result, 0)
 
   return result || runSteps('Reinstall', [['yarn', 'install --network-timeout 10000']])

package/src/actions/relint.ts

@@ -1,4 +1,4 @@
-import { rmSync } from 'fs'
+import { rmSync } from 'node:fs'
 
 import { runSteps, yarnWorkspaces } from '../lib'
 
@@ -17,6 +17,7 @@ export const relint = () => {
         return 1
       }
     })
+    // eslint-disable-next-line unicorn/no-array-reduce
     .reduce((prev, result) => prev || result, 0)
   return result || runSteps('Relint', [['yarn', ['eslint', '.', '--cache']]])
 }

package/src/lib/createBuildConfig.ts

@@ -1,4 +1,4 @@
-import { readFileSync } from 'fs'
+import { readFileSync } from 'node:fs'
 
 import { defaultBuildConfig } from './defaultBuildConfig'
 
@@ -6,7 +6,7 @@ const getGeneralTypescriptConfig = (location: string) => {
   let generalConfig: string | undefined
   try {
     generalConfig = readFileSync(`${location}/tsconfig.json`, { encoding: 'utf8' })
-  } catch (ex) {
+  } catch {
     return false
   }
   return JSON.parse(generalConfig)
@@ -27,7 +27,7 @@ export const createBuildConfig = (
     ...generalConfigObject,
     compilerOptions: {
       ...defaultBuildConfig.compilerOptions,
-      ...(generalConfigObject.compilerOptions ?? {}),
+      ...generalConfigObject.compilerOptions,
       module,
       outDir: `./${generalConfigObject.compilerOptions?.outDir ?? 'dist'}/${outDirSuffix}`,
       target,

package/src/lib/dependencies/DuplicateDetector.ts

@@ -1,7 +1,8 @@
+import { EOL } from 'node:os'
+
 import chalk from 'chalk'
 // eslint-disable-next-line import/no-internal-modules
 import uniq from 'lodash/uniq'
-import { EOL } from 'os'
 
 import { multiLineToJSONArray } from '../jsonFormatters'
 
@@ -22,12 +23,12 @@ const trimVirtualMeta = (value: string): string => {
 
 const trimObjectDependencyVirtualMeta = (obj: Record<string, ChildFields>): Record<string, ChildFields> => {
   const resultObj: Record<string, ChildFields> = {}
-  Object.entries(obj).forEach(([key, value]) => {
+  for (const [key, value] of Object.entries(obj)) {
     resultObj[trimVirtualMeta(key)] = {
       descriptor: trimVirtualMeta(value.descriptor),
       locator: trimVirtualMeta(value.locator),
     }
-  })
+  }
   return resultObj
 }
 
@@ -60,8 +61,9 @@ export class DuplicateDetector {
   }
 
   public detect() {
+    // eslint-disable-next-line unicorn/no-array-reduce
     const result = this.dependencyEntries.reduce(this.detectReducer, this.resultsFactory(this.dependency))
-    if (result.duplicateVersions.length) {
+    if (result.duplicateVersions.length > 0) {
       console.log(chalk.yellow(`${EOL}Duplicates found for: ${this.dependency}`))
       console.log(chalk.grey(`  ${result.duplicateVersions.toString().replaceAll(',', `${EOL}  `)}`, EOL))
       return 1

package/src/lib/dependencies/detectDuplicateDependencies.ts

@@ -1,4 +1,4 @@
-import { execSync } from 'child_process'
+import { execSync } from 'node:child_process'
 
 import { safeExit } from '../safeExit'
 import { DuplicateDetector } from './DuplicateDetector'
@@ -10,7 +10,7 @@ export const detectDuplicateDependencies = (depsFromPackageJSON?: string[], Defa
 
   return safeExit(() => {
     if (dependencies) {
-      dependencies.forEach((dependency) => {
+      for (const dependency of dependencies) {
         let output: string
 
         try {
@@ -19,21 +19,24 @@ export const detectDuplicateDependencies = (depsFromPackageJSON?: string[], Defa
         } catch (e) {
           console.error(`Error running yarn why: ${e}`)
           exitCode = 1
-          return exitCode
+          exitCode
+          continue
         }
 
         if (output) {
           exitCode = new DuplicateDetector(output, dependency).detect()
-          return exitCode
+          exitCode
+          continue
         } else {
           console.log(`${dependency} - N/A`)
           if (depsFromPackageJSON) {
             exitCode = 1
             console.log(`🚨 Library ${dependency} was requested in package.json but not found`)
           }
-          return exitCode
+          exitCode
+          continue
         }
-      })
+      }
       return exitCode
     } else {
       console.log('🚨 No dependencies where passed')

package/src/lib/file/ReadFileSyncOptions.ts

@@ -1,3 +1,3 @@
 export type ReadFileSyncOptions = BufferEncoding | { encoding: BufferEncoding; flags?: string }
 
-export const defaultReadFileSyncOptions: ReadFileSyncOptions = { encoding: 'utf-8' }
+export const defaultReadFileSyncOptions: ReadFileSyncOptions = { encoding: 'utf8' }

package/src/lib/jsonFormatters.ts

@@ -1,6 +1,6 @@
 export const multiLineToJSONArray = (output: string) => {
-  const withCommas = output.replace(/\r\n/g, '').replace(/\n/g, ',')
-  const cleanCollection = withCommas.substring(0, withCommas.length - 1)
+  const withCommas = output.replaceAll('\r\n', '').replaceAll('\n', ',')
+  const cleanCollection = withCommas.slice(0, Math.max(0, withCommas.length - 1))
   const collection = `[${cleanCollection}]`
   return JSON.parse(collection)
 }

package/src/lib/parsedPackageJSON.ts

@@ -1,4 +1,4 @@
-import { readFileSync } from 'fs'
+import { readFileSync } from 'node:fs'
 
 export const parsedPackageJSON = (path?: string) => {
   const pathToPackageJSON = path ?? process.env.npm_package_json ?? ''

package/src/lib/runSteps.ts

@@ -1,6 +1,7 @@
+import { spawnSync, SpawnSyncOptionsWithBufferEncoding } from 'node:child_process'
+import { existsSync } from 'node:fs'
+
 import chalk from 'chalk'
-import { spawnSync, SpawnSyncOptionsWithBufferEncoding } from 'child_process'
-import { existsSync } from 'fs'
 
 import { checkResult } from './checkResult'
 import { safeExit } from './safeExit'
@@ -14,14 +15,13 @@ export const runSteps = (name: string, steps: ScriptStep[], exitOnFail = true, m
     const pkgName = process.env.npm_package_name
     console.log(chalk.green(`${name} [${pkgName}]`))
     let totalStatus = 0
-    for (let i = 0; i < steps.length; i++) {
-      const [command, args, config] = steps[i]
+    for (const [i, [command, args, config]] of steps.entries()) {
       if (messages?.[i]) {
         console.log(chalk.gray(messages?.[i]))
       }
       const argList = Array.isArray(args) ? args : args.split(' ')
       if (command === 'node' && !existsSync(argList[0])) {
-        throw Error(`File not found [${argList[0]}]`)
+        throw new Error(`File not found [${argList[0]}]`)
       }
       const status =
         spawnSync(command, Array.isArray(args) ? args : args.split(' '), {

package/src/lib/runStepsAsync.ts

@@ -1,6 +1,7 @@
+import { spawn } from 'node:child_process'
+import { existsSync } from 'node:fs'
+
 import chalk from 'chalk'
-import { spawn } from 'child_process'
-import { existsSync } from 'fs'
 
 import { checkResult } from './checkResult'
 import { ScriptStep } from './runSteps'
@@ -14,7 +15,7 @@ export const runStepAsync = (name: string, step: ScriptStep, exitOnFail = true,
     }
     const argList = Array.isArray(args) ? args : args.split(' ')
     if (command === 'node' && !existsSync(argList[0])) {
-      throw Error(`File not found [${argList[0]}]`)
+      throw new Error(`File not found [${argList[0]}]`)
     }
     spawn(command, Array.isArray(args) ? args : args.split(' '), {
       ...config,
@@ -44,8 +45,8 @@ export const runStepsAsync = async (name: string, steps: ScriptStep[], exitOnFai
     const pkgName = process.env.npm_package_name
     console.log(chalk.green(`${name} [${pkgName}]`))
     let result = 0
-    for (let i = 0; i < steps.length; i++) {
-      result += await runStepAsync(name, steps[i], exitOnFail, messages?.[i])
+    for (const [i, step] of steps.entries()) {
+      result += await runStepAsync(name, step, exitOnFail, messages?.[i])
     }
     return result
   })

package/src/lib/yarn/isYarnVersionOrGreater.ts

@@ -1,9 +1,9 @@
-import { spawnSync } from 'child_process'
+import { spawnSync } from 'node:child_process'
 
 export const isYarnVersionOrGreater = (major: number, minor?: number, patch?: number): [boolean, string] => {
   const result = spawnSync('yarn', ['-v'], { encoding: 'utf8', shell: true })
   const version = result.stdout.toString().replaceAll('\n', '')
-  const versionNumbers = version.split('.').map((ver) => parseInt(ver))
+  const versionNumbers = version.split('.').map((ver) => Number.parseInt(ver))
   const majorDelta = versionNumbers[0] - major
   const minorDelta = versionNumbers[1] - (minor ?? versionNumbers[1])
   const patchDelta = versionNumbers[2] - (patch ?? versionNumbers[2])

package/src/lib/yarn/workspace/yarnWorkspaces.ts

@@ -1,4 +1,4 @@
-import { spawnSync } from 'child_process'
+import { spawnSync } from 'node:child_process'
 
 import { Workspace } from './Workspace'
 

package/src/loadPackageConfig.ts

@@ -1,4 +1,5 @@
-import { readFile } from 'fs/promises'
+import { readFile } from 'node:fs/promises'
+
 import { PackageJson } from 'types-package-json'
 
 export type PackageJsonEx = PackageJson & { type: 'module' | 'commonjs' }

package/src/xy/xyLintCommands.ts

@@ -31,7 +31,10 @@ export const xyLintCommands = (args: Argv) => {
       async (argv) => {
         if (argv.verbose) console.log('Lint')
         const start = Date.now()
-        process.exitCode = argv.fix ? fix() : argv.profile ? lintProfile() : await lint({ pkg: argv.package as string })
+        process.exitCode =
+          argv.fix ? fix()
+          : argv.profile ? lintProfile()
+          : await lint({ pkg: argv.package as string })
         console.log(chalk.blue(`Finished in ${Date.now() - start}ms`))
       },
     )