@xylabs/ts-scripts-yarn3 2.7.0-rc.7 → 2.7.0

package/src/lib/xy.ts

@@ -0,0 +1,344 @@
+import yargs, { Argv } from 'yargs'
+// eslint-disable-next-line import/no-internal-modules
+import { hideBin } from 'yargs/helpers'
+
+import {
+  build,
+  clean,
+  compile,
+  copyAssets,
+  cycle,
+  dead,
+  deps,
+  fix,
+  genDocs,
+  gitlint,
+  gitlintFix,
+  license,
+  lint,
+  lintFast,
+  lintProfile,
+  rebuild,
+  reinstall,
+  relint,
+  sonar,
+  test,
+  tsconfigGen,
+  tsconfigGenClean,
+  up,
+  updo,
+  yarn3Only,
+} from '../actions'
+
+export const parseOptions = async () => {
+  const yargsInstance = yargs(hideBin(process.argv))
+  return await yargsInstance
+    .option('verbose', {
+      alias: 'v',
+      default: false,
+      description: 'Run with verbose logging',
+      type: 'boolean',
+    })
+    .option('target', {
+      alias: 't',
+      choices: ['esm', 'cjs'],
+      description: 'Limit output to specific target',
+      type: 'string',
+    })
+    .option('fix', {
+      alias: 'f',
+      default: false,
+      description: 'Try to fix errors',
+      type: 'boolean',
+    })
+    .option('cache', {
+      alias: 'c',
+      default: false,
+      description: 'Use caching for performance',
+      type: 'boolean',
+    })
+    .option('profile', {
+      alias: 'p',
+      default: false,
+      description: 'Profile action',
+      type: 'boolean',
+    })
+}
+
+export const xy = async (extend: (yargs: Argv) => Promise<Argv> | Argv = (yargs) => yargs) => {
+  const options = await parseOptions()
+  const x = await extend(
+    options
+      .command(
+        'build [package]',
+        'Build - Compile & Lint',
+        (yargs) => {
+          return yargs.positional('package', {
+            describe: 'Specific package to build',
+          })
+        },
+        (argv) => {
+          if (argv.verbose) console.info(`Building: ${argv.package ?? 'all'}`)
+          process.exitCode = build({ target: argv.target as 'esm' | 'cjs' })
+        },
+      )
+      .command(
+        'compile [package]',
+        'Compile with Typescript & Copy Images',
+        (yargs) => {
+          return yargs.positional('package', {
+            describe: 'Specific package to compile',
+          })
+        },
+        async (argv) => {
+          if (argv.verbose) console.info(`Compiling: ${argv.package ?? 'all'}`)
+          process.exitCode = await compile({ target: argv.target as 'esm' | 'cjs' })
+        },
+      )
+      .command(
+        'clean [package]',
+        'Clean - Remove intermediate files',
+        (yargs) => {
+          return yargs.positional('package', {
+            describe: 'Specific package to clean',
+          })
+        },
+        (argv) => {
+          if (argv.verbose) console.info(`Cleaning: ${argv.package ?? 'all'}`)
+          process.exitCode = clean()
+        },
+      )
+      .command(
+        'license [package]',
+        'License - Check licenses of dependencies',
+        (yargs) => {
+          return yargs.positional('package', {
+            describe: 'Specific package to check',
+          })
+        },
+        (argv) => {
+          if (argv.verbose) console.info(`License: ${argv.package ?? 'all'}`)
+          process.exitCode = license()
+        },
+      )
+      .command(
+        'copy-assets [package]',
+        'Copy Assets - Copy the assets from src to dist',
+        (yargs) => {
+          return yargs.positional('package', {
+            describe: 'Specific package to copy assets',
+          })
+        },
+        (argv) => {
+          if (argv.verbose) console.info(`Copying Assets: ${argv.package ?? 'all'}`)
+          process.exitCode = copyAssets({ target: argv.target as 'esm' | 'cjs' })
+        },
+      )
+      .command(
+        'cycle [package]',
+        'Cycle - Check for dependency cycles',
+        (yargs) => {
+          return yargs.positional('package', {
+            describe: 'Specific package to check',
+          })
+        },
+        (argv) => {
+          if (argv.verbose) console.info('Cycle')
+          process.exitCode = cycle()
+        },
+      )
+      .command(
+        'dead [package]',
+        'Dead - Check for dead code',
+        (yargs) => {
+          return yargs.positional('package', {
+            describe: 'Specific package to check',
+          })
+        },
+        (argv) => {
+          if (argv.verbose) console.info('Dead')
+          process.exitCode = dead()
+        },
+      )
+      .command(
+        'lint [package]',
+        'Lint - Run Eslint',
+        (yargs) => {
+          return yargs.positional('package', {
+            describe: 'Specific package to check',
+          })
+        },
+        (argv) => {
+          if (argv.verbose) console.info('Lint')
+          process.exitCode = argv.fix ? fix() : argv.profile ? lintProfile() : argv.cache ? lintFast() : lint()
+        },
+      )
+      .command(
+        'fix [package]',
+        'Fix - Run Eslint w/fix',
+        (yargs) => {
+          return yargs.positional('package', {
+            describe: 'Specific package to check',
+          })
+        },
+        (argv) => {
+          if (argv.verbose) console.info('Fix')
+          process.exitCode = fix()
+        },
+      )
+      .command(
+        'deps [package]',
+        'Deps - Check for unused or missing dependencies',
+        (yargs) => {
+          return yargs.positional('package', {
+            describe: 'Specific package to check',
+          })
+        },
+        (argv) => {
+          if (argv.verbose) console.info('Deps')
+          process.exitCode = deps()
+        },
+      )
+      .command(
+        'gen-docs [package]',
+        'GenDocs - Generate TypeDocs',
+        (yargs) => {
+          return yargs.positional('package', {
+            describe: 'Specific package to generate docs for',
+          })
+        },
+        (argv) => {
+          if (argv.verbose) console.info('Deps')
+          process.exitCode = genDocs()
+        },
+      )
+      .command(
+        'gitlint [package]',
+        'Gitlint - Lint your git config',
+        (yargs) => {
+          return yargs
+        },
+        (argv) => {
+          if (argv.verbose) console.info('Gitlint')
+          process.exitCode = argv.fix ? gitlintFix() : gitlint()
+        },
+      )
+      .command(
+        'rebuild [package]',
+        'Rebuild - Clean, Compile & Lint',
+        (yargs) => {
+          return yargs.positional('package', {
+            describe: 'Specific package to rebuild',
+          })
+        },
+        (argv) => {
+          if (argv.verbose) console.info(`Rebuilding: ${argv.package ?? 'all'}`)
+          process.exitCode = rebuild({ target: argv.target as 'esm' | 'cjs' })
+        },
+      )
+      .command(
+        'relint [package]',
+        'Relint - Clean & Lint',
+        (yargs) => {
+          return yargs.positional('package', {
+            describe: 'Specific package to relint',
+          })
+        },
+        (argv) => {
+          if (argv.verbose) console.info('Relinting')
+          process.exitCode = relint()
+        },
+      )
+      .command(
+        'reinstall',
+        'Reinstall - Clean & Install',
+        (yargs) => {
+          return yargs
+        },
+        (argv) => {
+          if (argv.verbose) console.info('Reinstalling')
+          process.exitCode = reinstall()
+        },
+      )
+      .command(
+        'sonar',
+        'Sonar - Run Sonar Check',
+        (yargs) => {
+          return yargs
+        },
+        (argv) => {
+          if (argv.verbose) console.info('Sonar Check')
+          process.exitCode = sonar()
+        },
+      )
+      .command(
+        'test',
+        'Test - Run Jest Tests',
+        (yargs) => {
+          return yargs
+        },
+        (argv) => {
+          if (argv.verbose) console.info('Testing')
+          process.exitCode = test()
+        },
+      )
+      .command(
+        'tsconfig-gen [package]',
+        'Tsconfig Gen - Generate tsconfog.json file for building',
+        (yargs) => {
+          return yargs.positional('package', {
+            describe: 'Specific package for generation',
+          })
+        },
+        (argv) => {
+          if (argv.verbose) console.info(`TsconfigGen: ${argv.package ?? 'all'}`)
+          process.exitCode = tsconfigGen({ target: argv.target as 'esm' | 'cjs' })
+        },
+      )
+      .command(
+        'tsconfig-clean',
+        'Tsconfig Clean - Remove generated tsconfig.json files',
+        (yargs) => {
+          return yargs
+        },
+        (argv) => {
+          if (argv.verbose) console.info('Tsconfig Clean')
+          process.exitCode = tsconfigGenClean()
+        },
+      )
+      .command(
+        'up',
+        'Up - Update dependencies',
+        (yargs) => {
+          return yargs
+        },
+        (argv) => {
+          if (argv.verbose) console.info('Up')
+          process.exitCode = up()
+        },
+      )
+      .command(
+        'updo',
+        'Updo - Update dependencies [Interactive]',
+        (yargs) => {
+          return yargs
+        },
+        (argv) => {
+          if (argv.verbose) console.info('Updo')
+          process.exitCode = updo()
+        },
+      )
+      .command(
+        'yarn3only',
+        'Yarn3Only - Check if using Yarn v3',
+        (yargs) => {
+          return yargs
+        },
+        (argv) => {
+          if (argv.verbose) console.info('Yarn 3 Check')
+          process.exitCode = yarn3Only()
+        },
+      ),
+  )
+  await x.help().argv
+}

package/tsconfig.json

@@ -1,9 +1,7 @@
 {
   "compilerOptions": {
-    "baseUrl": ".",
     "composite": true,
-    "declaration": true,
-    "rootDir": "."
+    "rootDir": "./src"
   },
-  "extends": "@xylabs/tsconfig"
+  "extends": "../../tsconfig.json"
 }

package/src/bin/tsconfig-gen-cjs.ts

@@ -1,5 +0,0 @@
-#!/usr/bin/env node
-
-import { tsconfigGenCjs } from '../actions'
-
-tsconfigGenCjs()

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

@@ -1,5 +0,0 @@
-#!/usr/bin/env node
-
-import { tsconfigGenEsm } from '../actions'
-
-tsconfigGenEsm()

package/src/bin/tsconfig-gen-test.ts

@@ -1,5 +0,0 @@
-#!/usr/bin/env node
-
-import { tsconfigGenTest } from '../actions'
-
-tsconfigGenTest()