@xylabs/ts-scripts-yarn3 2.12.32 → 2.13.0

package/src/actions/tsconfig-gen-esm.ts

@@ -1,7 +1,7 @@
 import chalk from 'chalk'
 import { readFileSync, writeFileSync } from 'fs'
 
-import { yarnWorkspaces } from '../lib'
+import { createBuildConfig, yarnWorkspaces } from '../lib'
 
 export const tsconfigGenEsm = (pkg?: string) => {
   const workspaces = yarnWorkspaces()
@@ -11,24 +11,10 @@ export const tsconfigGenEsm = (pkg?: string) => {
 
   console.log(chalk.green('Generate Configs [ESM]'))
 
-  const config = JSON.stringify(
-    {
-      compilerOptions: {
-        module: 'ESNEXT',
-        outDir: './dist/esm',
-        target: 'ESNEXT',
-      },
-      exclude: ['**/*.spec.*', '**/*.spec', '**/*.stories.*', '**/*.example.*', '**/spec/*', '**/stories/*'],
-      extends: './tsconfig.json',
-      include: ['src'],
-    },
-    null,
-    2,
-  )
-
   return workspaceList
     .map(({ location, name }) => {
       try {
+        const config = JSON.stringify(createBuildConfig(location, 'ESNext', 'ESNext', 'esm'), null, 2)
         let currentConfig: string | undefined
         try {
           currentConfig = readFileSync(`${location}/.tsconfig.build.esm.json`, { encoding: 'utf8' })

package/src/lib/createBuildConfig.ts

@@ -0,0 +1,35 @@
+import { readFileSync } from 'fs'
+
+import { defaultBuildConfig } from './defaultBuildConfig'
+
+const getGeneralTypescriptConfig = (location: string) => {
+  let generalConfig: string | undefined
+  try {
+    generalConfig = readFileSync(`${location}/tsconfig.json`, { encoding: 'utf8' })
+  } catch (ex) {
+    throw new Error('No tsconfig.json file found')
+  }
+  return JSON.parse(generalConfig)
+}
+
+export const createBuildConfig = (
+  location: string,
+  module: 'ESNext' | 'CommonJS',
+  target: 'ESNext' | 'ES6',
+  outDirSuffix: string,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+): Record<string, any> => {
+  const generalConfigObject = getGeneralTypescriptConfig(location)
+  return {
+    ...generalConfigObject,
+    compilerOptions: {
+      ...defaultBuildConfig.compilerOptions,
+      ...(generalConfigObject.compilerOptions ?? {}),
+      module,
+      outDir: `./${generalConfigObject.compilerOptions?.outDir ?? 'dist'}/${outDirSuffix}`,
+      target,
+    },
+    exclude: [...(generalConfigObject.exclude ?? []), ...defaultBuildConfig.exclude],
+    include: [...(generalConfigObject.include ?? []), ...defaultBuildConfig.include],
+  }
+}

package/src/lib/defaultBuildConfig.ts

@@ -0,0 +1,7 @@
+export const defaultBuildConfig = {
+  "compilerOptions": {
+    rootDir: "src"
+  },
+  exclude: ['**/*.spec.*', '**/*.spec', '**/*.stories.*', '**/*.example.*', '**/spec/*', '**/stories/*'],
+  include: ['src'],
+}

package/src/lib/dependencies/DuplicateDetector.ts

@@ -0,0 +1,62 @@
+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'
+
+interface DependencyEntry {
+  children: Record<string, Record<string, string>>
+  value: string
+}
+
+type DependencyEntries = DependencyEntry[]
+
+interface Results {
+  currentVersion: string | undefined
+  dependency: string
+  duplicateVersions: string[]
+}
+
+export class DuplicateDetector {
+  private dependency: string
+  private dependencyEntries: DependencyEntries
+
+  constructor(output: string, dependency: string) {
+    this.dependency = dependency
+    this.dependencyEntries = multiLineToJSONArray(output)
+  }
+
+  public detect() {
+    const result = this.dependencyEntries.reduce(this.detectReducer, this.resultsFactory(this.dependency))
+    if (result.duplicateVersions.length) {
+      console.log(chalk.yellow(`${EOL}Duplicates found for: ${this.dependency}`))
+      console.log(chalk.grey(`  ${result.duplicateVersions.toString().replaceAll(',', `${EOL}  `)}`, EOL))
+      return 1
+    } else {
+      console.log(`${this.dependency} - OK`)
+      return 0
+    }
+  }
+
+  private detectReducer(acc: Results, entry: DependencyEntry) {
+    const version = Object.entries(entry.children).map(([k]) => k)[0]
+
+    if (!acc.currentVersion) {
+      acc.currentVersion = version
+      return acc
+    }
+
+    if (acc.currentVersion && acc.currentVersion !== version && !version.includes('@virtual:')) {
+      // if first duplicate, push the current version as the first duplicate
+      if (acc.duplicateVersions.length === 0) {
+        acc.duplicateVersions.push(acc.currentVersion)
+      }
+      acc.duplicateVersions.push(version)
+      acc.duplicateVersions = uniq(acc.duplicateVersions)
+    }
+    return acc
+  }
+
+  private resultsFactory = (dependency: string): Results => ({ currentVersion: undefined, dependency, duplicateVersions: [] })
+}

package/src/lib/dependencies/detectDuplicateDependencies.ts

@@ -0,0 +1,42 @@
+import { execSync } from 'child_process'
+
+import { safeExit } from '../safeExit'
+import { DuplicateDetector } from './DuplicateDetector'
+
+export const detectDuplicateDependencies = (depsFromPackageJSON?: string[], DefaultDependencies?: string[]) => {
+  let exitCode = 0
+
+  const dependencies = depsFromPackageJSON?.length ? depsFromPackageJSON : DefaultDependencies
+
+  return safeExit(() => {
+    if (dependencies) {
+      dependencies.forEach((dependency) => {
+        let output: string
+
+        try {
+          const cmd = `yarn why ${dependency} --json`
+          output = execSync(cmd).toString()
+        } catch (e) {
+          console.error(`Error running yarn why: ${e}`)
+          exitCode = 1
+          return
+        }
+
+        if (output) {
+          exitCode = new DuplicateDetector(output, dependency).detect()
+          return
+        } else {
+          console.log(`${dependency} - N/A`)
+          if (depsFromPackageJSON) {
+            console.log(`🚨 Library ${dependency} was requested in package.json but not found`)
+          }
+          exitCode = 1
+          return
+        }
+      })
+      return exitCode
+    } else {
+      console.log('🚨 No dependencies where passed')
+    }
+  })
+}

package/src/lib/dependencies/index.ts

@@ -0,0 +1,2 @@
+export * from './detectDuplicateDependencies'
+export * from './DuplicateDetector'

package/src/lib/index.ts

@@ -1,4 +1,9 @@
+export * from './createBuildConfig'
+export * from './defaultBuildConfig'
+export * from './dependencies'
 export * from './isYarnVersionOrGreater'
+export * from './jsonFormatters'
+export * from './parsedPackageJSON'
 export * from './processEx'
 export * from './runSteps'
 export * from './runStepsAsync'

package/src/lib/jsonFormatters.ts

@@ -0,0 +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 collection = `[${cleanCollection}]`
+  return JSON.parse(collection)
+}

package/src/lib/parsedPackageJSON.ts

@@ -0,0 +1,7 @@
+import { readFileSync } from 'fs'
+
+export const parsedPackageJSON = (path?: string) => {
+  const pathToPackageJSON = path ?? process.env.npm_package_json ?? ''
+  const packageJSON = readFileSync(pathToPackageJSON).toString()
+  return JSON.parse(packageJSON)
+}

package/src/lib/xy/xy.ts

@@ -6,5 +6,8 @@ import { xyLintCommands } from './xyLintCommands'
 import { xyParseOptions } from './xyParseOptions'
 
 export const xy = () => {
-  return xyBuildCommands(xyCommonCommands(xyInstallCommands(xyDeployCommands(xyLintCommands(xyParseOptions()))))).help().argv
+  return xyBuildCommands(xyCommonCommands(xyInstallCommands(xyDeployCommands(xyLintCommands(xyParseOptions())))))
+    .demandCommand(1)
+    .version()
+    .help().argv
 }

package/src/lib/xy/xyInstallCommands.ts

@@ -1,6 +1,6 @@
 import yargs from 'yargs'
 
-import { clean, reinstall, up, updo } from '../../actions'
+import { clean, dupdeps, reinstall, statics, up, updo } from '../../actions'
 
 export const xyInstallCommands = (args: yargs.Argv) => {
   return args
@@ -50,4 +50,26 @@ export const xyInstallCommands = (args: yargs.Argv) => {
         process.exitCode = updo()
       },
     )
+    .command(
+      'statics',
+      'Statics - Confirming Static Packages',
+      (yargs) => {
+        return yargs
+      },
+      (argv) => {
+        if (argv.verbose) console.log('Statics')
+        process.exitCode = statics()
+      },
+    )
+    .command(
+      'dupdeps',
+      'Dupdeps - Duplicate Dependencies in package.json',
+      (yargs) => {
+        return yargs
+      },
+      (argv) => {
+        if (argv.verbose) console.log('Dupdeps')
+        process.exitCode = dupdeps()
+      },
+    )
 }