@xylabs/ts-scripts-yarn3 2.5.15

package/package.json

@@ -0,0 +1,109 @@
+{
+  "name": "@xylabs/ts-scripts-yarn3",
+  "author": {
+    "email": "support@xylabs.com",
+    "name": "XY Labs Development Team",
+    "url": "https://xylabs.com"
+  },
+  "bin": {
+    "build": "dist/cjs/build.js",
+    "clean": "dist/cjs/clean.js",
+    "compile": "dist/cjs/compile.js",
+    "compile:cjs": "dist/cjs/compile-cjs.js",
+    "compile:esm": "dist/cjs/compile-esm.js",
+    "compile:package-cjs": "dist/cjs/compile-package-cjs.js",
+    "compile:package-esm": "dist/cjs/compile-package-esm.js",
+    "cycle": "dist/cjs/cycle.js",
+    "dead": "dist/cjs/dead.js",
+    "deploy": "dist/cjs/deploy.js",
+    "deploy3": "dist/cjs/deploy3.js",
+    "deps": "dist/cjs/deps.js",
+    "deps:package": "dist/cjs/deps-package.js",
+    "fix": "dist/cjs/fix.js",
+    "gitlint": "dist/cjs/gitlint.js",
+    "gitlint-fix": "dist/cjs/gitlint-fix.js",
+    "lint": "dist/cjs/lint.js",
+    "migrate": "dist/cjs/migrate.js",
+    "rebuild": "dist/cjs/rebuild.js",
+    "reinstall": "dist/cjs/reinstall.js",
+    "sonar": "dist/cjs/sonar.js",
+    "test": "dist/cjs/test.js",
+    "up": "dist/cjs/up.js",
+    "up3": "dist/cjs/up3.js",
+    "updo": "dist/cjs/updo.js",
+    "updo3": "dist/cjs/updo3.js",
+    "xylabs-build": "dist/cjs/build.js",
+    "xylabs-clean": "dist/cjs/clean.js",
+    "xylabs-compile": "dist/cjs/compile.js",
+    "xylabs-cycle": "dist/cjs/cycle.js",
+    "xylabs-dead": "dist/cjs/dead.js",
+    "xylabs-deploy": "dist/cjs/deploy.js",
+    "xylabs-deps": "dist/cjs/deps.js",
+    "xylabs-fix": "dist/cjs/fix.js",
+    "xylabs-gitlint": "dist/cjs/gitlint.js",
+    "xylabs-gitlint-fix": "dist/cjs/gitlint-fix.js",
+    "xylabs-lint": "dist/cjs/lint.js",
+    "xylabs-rebuild": "dist/cjs/rebuild.js",
+    "xylabs-reinstall": "dist/cjs/reinstall.js",
+    "xylabs-sonar": "dist/cjs/sonar.js",
+    "xylabs-test": "dist/cjs/test.js",
+    "xylabs-up": "dist/cjs/up.js",
+    "xylabs-updo": "dist/cjs/updo.js",
+    "xylabs-yarn3only": "dist/cjs/yarn3only.js",
+    "yarn3only": "dist/cjs/yarn3only.js"
+  },
+  "bugs": {
+    "email": "support@xylabs.com",
+    "url": "https://github.com/xylabs/config/issues"
+  },
+  "dependencies": {
+    "@types/jest": "^28.1.6",
+    "@types/node": "^18.6.4",
+    "@xylabs/eslint-config": "^2.5.15",
+    "@xylabs/sdk-js": "^2.6.3",
+    "chalk": "5.0.1",
+    "copyfiles": "^2.4.1",
+    "depcheck": "^1.4.3",
+    "eslint": "^8.21.0",
+    "eslint-plugin-sonarjs": "^0.14.0",
+    "jest": "^28.1.3",
+    "jest-sorted": "^1.0.14",
+    "node-cmd": "^5.0.0",
+    "npm-check-updates": "^16.0.5",
+    "npm-package-json-lint": "^6.3.0",
+    "npm-package-json-lint-config-default": "^5.0.0",
+    "parse-git-config": "^3.0.0",
+    "prettier": "^2.7.1",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^28.0.7",
+    "ts-prune": "^0.10.3",
+    "typescript": "^4.7.4"
+  },
+  "description": "TypeScript project scripts",
+  "devDependencies": {
+    "@types/node": "^18.6.4",
+    "@types/parse-git-config": "^3.0.1",
+    "@xylabs/tsconfig": "^2.5.15",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.2.1"
+  },
+  "homepage": "https://xylabs.com",
+  "keywords": [
+    "xylabs",
+    "utility",
+    "typescript"
+  ],
+  "license": "LGPL-3.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/xylabs/config.git"
+  },
+  "engines": {
+    "node": ">=14.16"
+  },
+  "sideEffects": false,
+  "version": "2.5.15"
+}

package/src/build.ts

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+import { runSteps } from './lib'
+
+runSteps('Build', [
+  ['yarn', 'compile'],
+  ['yarn', 'gen-docs'],
+])

package/src/clean-package.ts

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { INIT_CWD, runSteps } from './lib'
+
+runSteps('Clean Package', [['yarn', `rimraf -q ${INIT_CWD()}/dist`]])

package/src/clean.ts

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { runSteps } from './lib'
+
+runSteps('Clean', [['yarn', 'yarn workspaces foreach -pA run clean:package']])

package/src/compile-cjs.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { runSteps } from './lib'
+
+runSteps('Compile [CJS]', [['yarn', 'workspaces foreach -ptA run compile:package:cjs']])

package/src/compile-esm.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { runSteps } from './lib'
+
+runSteps('Compile [ESM]', [['yarn', 'workspaces foreach -ptA run compile:package:esm']])

package/src/compile-package-cjs.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { INIT_CWD, runSteps } from './lib'
+
+runSteps('Compile Package [CJS]', [['yarn', `tsc -p ${INIT_CWD()}/tsconfig.build.cjs.json`]])

package/src/compile-package-esm.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { INIT_CWD, runSteps } from './lib'
+
+runSteps('Compile Package [ESM]', [['yarn', `tsc -p ${INIT_CWD()}/tsconfig.build.esm.json`]])

package/src/compile.ts

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+
+import { runSteps } from './lib'
+
+runSteps('Compile', [
+  ['yarn', 'compile:esm'],
+  ['yarn', 'compile:cjs'],
+])

package/src/cycle.ts

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+
+import { runSteps } from './lib'
+
+const rules = {
+  'import/no-cycle': [1, { maxDepth: 10 }],
+  'import/no-internal-modules': ['off'],
+}
+
+runSteps('Cycle', [['yarn', `eslint ${Object.entries(rules).map(([rule, value]) => ` --rule "${rule}: ${JSON.stringify(value)}"`)} .`]])

package/src/dead.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { runSteps } from './lib'
+
+runSteps('Dead', [['yarn', 'ts-prune']])

package/src/deploy.ts

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+
+import { runSteps } from './lib'
+
+runSteps('Deploy', [
+  ['yarn', 'cycle'],
+  ['yarn', 'build'],
+  ['yarn', 'version patch -i'],
+  ['yarn', 'npm publish'],
+])

package/src/deps-package.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { INIT_CWD, runSteps } from './lib'
+
+runSteps('Deps Package', [['yarn', ['depcheck', INIT_CWD()]]])

package/src/deps.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { runSteps } from './lib'
+
+runSteps('Deps', [['yarn', 'workspaces foreach -pAv run deps:package']])

package/src/fix.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { runSteps } from './lib'
+
+runSteps('Fix', [['yarn', 'eslint . --fix']])

package/src/gitlint-fix.ts

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+import chalk from 'chalk'
+import { execSync } from 'child_process'
+import { sync } from 'parse-git-config'
+
+import { safeExit } from './lib'
+
+safeExit(() => {
+  console.log(`\nGitlint Fix Start [${process.cwd()}]\n`)
+
+  const gitConfig = sync()
+
+  if (gitConfig.core.ignorecase) {
+    execSync('git config core.ignorecase false', { stdio: 'inherit' })
+    console.warn(chalk.yellow('\nGitlint Fix: Updated core.ignorecase to be false\n'))
+  }
+
+  if (gitConfig.core.autocrlf !== false) {
+    execSync('git config core.autocrlf false', { stdio: 'inherit' })
+    console.warn(chalk.yellow('\nGitlint Fix: Updated core.autocrlf to be false\n'))
+  }
+
+  if (gitConfig.core.eol !== 'lf') {
+    execSync('git config core.eol lf', { stdio: 'inherit' })
+    console.warn(chalk.yellow('\nGitlint Fix: Updated core.eol to be "lf"\n'))
+  }
+
+  return 1
+})

package/src/gitlint.ts

@@ -0,0 +1,49 @@
+#!/usr/bin/env node
+import chalk from 'chalk'
+import { sync } from 'parse-git-config'
+
+import { safeExit } from './lib'
+
+safeExit(() => {
+  console.log(`\nGitlint Start [${process.cwd()}]\n`)
+  let valid = 0
+  let warnings = 0
+  const errors = 0
+  const gitConfig = sync()
+
+  const warn = (message: string) => {
+    console.warn(chalk.yellow(`Warning: ${message}`))
+    warnings++
+  }
+
+  if (gitConfig.core.ignorecase) {
+    warn('Please set core.ignorecase to FALSE in .git/config file [run yarn gitlint-fix]')
+  } else {
+    valid++
+  }
+
+  if (gitConfig.core.autocrlf !== false) {
+    warn('Please set core.autocrlf to FALSE in .git/config file [run yarn gitlint-fix]')
+  } else {
+    valid++
+  }
+
+  if (gitConfig.core.eol !== 'lf') {
+    warn('Please set core.eol to "lf" in .git/config file [run yarn gitlint-fix]')
+  } else {
+    valid++
+  }
+
+  const resultMessages: string[] = []
+  if (valid > 0) {
+    resultMessages.push(chalk.green(`Passed: ${valid}`))
+  }
+  if (warnings > 0) {
+    resultMessages.push(chalk.yellow(`Warnings: ${warnings}`))
+  }
+  if (errors > 0) {
+    resultMessages.push(chalk.red(` Errors: ${errors}`))
+  }
+  console.warn(`Gitlint Finish [ ${resultMessages.join(' | ')} ]\n`)
+  return warnings + errors === 0 ? 1 : 0
+})

package/src/lib/index.ts

@@ -0,0 +1,7 @@
+export * from './isYarnVersionOrGreater'
+export * from './processEx'
+export * from './runSteps'
+export * from './safeExit'
+export * from './withErrnoException'
+export * from './withError'
+export * from './yarnInitCwd'

package/src/lib/isYarnVersionOrGreater.ts

@@ -0,0 +1,16 @@
+import { spawnSync } from 'child_process'
+
+export const isYarnVersionOrGreater = (major: number, minor?: number, patch?: number): [boolean, string] => {
+  const result = spawnSync('yarn', ['-v'])
+  const version = result.stdout.toString().replaceAll('\n', '')
+  const versionNumbers = version.split('.').map((ver) => parseInt(ver))
+  const majorDelta = versionNumbers[0] - major
+  const minorDelta = versionNumbers[1] - (minor ?? versionNumbers[1])
+  const patchDelta = versionNumbers[2] - (patch ?? versionNumbers[2])
+
+  const majorOk = majorDelta >= 0
+  const minorOk = majorDelta > 0 || minorDelta >= 0
+  const patchOk = majorDelta > 0 || minorDelta > 0 || patchDelta >= 0
+
+  return [majorOk && minorOk && patchOk, version]
+}

package/src/lib/processEx.ts

@@ -0,0 +1,28 @@
+import chalk from 'chalk'
+
+import { withErrnoException } from './withErrnoException'
+import { withError } from './withError'
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const processEx = (ex: any) => {
+  const error = typeof ex === 'string' ? Error(ex) : ex
+  const exitCode =
+    withErrnoException(error, (error) => {
+      if (error.code === 'ENOENT') {
+        console.error(chalk.red(`'${error.path}' not found.`))
+      } else {
+        console.error(chalk.red(`Errno: ${error.code}`))
+      }
+      return error.errno ?? -1
+    }) ??
+    withError(error, (error) => {
+      console.error(chalk.red(`${error.name}: ${error.message}`))
+      return -1
+    }) ??
+    (() => {
+      console.error(chalk.red(`Unexpected Error: ${JSON.stringify(ex, null, 2)}`))
+      return -1
+    })()
+  //This allows us to use a previously set exit code
+  process.exit(process.exitCode ?? exitCode)
+}

package/src/lib/runSteps.ts

@@ -0,0 +1,19 @@
+import chalk from 'chalk'
+import { spawnSync } from 'child_process'
+
+import { safeExit } from './safeExit'
+
+export type ScriptStep = [/*command*/ string, /*arg*/ string | string[]]
+
+export const runSteps = (name: string, steps: ScriptStep[]) => {
+  safeExit(() => {
+    console.log(chalk.green(`${name} [${process.cwd()}]`))
+    for (let i = 0; i < steps.length; i++) {
+      const [command, args] = steps[i]
+      const status = spawnSync(command, Array.isArray(args) ? args : args.split(' '), { stdio: 'inherit' }).status
+      if (status) {
+        return status
+      }
+    }
+  })
+}

package/src/lib/safeExit.ts

@@ -0,0 +1,13 @@
+/** Catch child process a crash and returns the code */
+
+import { processEx } from './processEx'
+
+const safeExit = (func: () => number | null | undefined | void) => {
+  try {
+    process.exit(func() ?? 0)
+  } catch (ex) {
+    processEx(ex)
+  }
+}
+
+export { safeExit }

package/src/lib/withErrnoException.ts

@@ -0,0 +1,6 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { withError } from './withError'
+
+export const withErrnoException = <T extends NodeJS.ErrnoException = NodeJS.ErrnoException>(ex: any, closure: (error: T) => number) => {
+  return withError<T>(ex, closure, (ex: any) => ex.errno !== undefined)
+}

package/src/lib/withError.ts

@@ -0,0 +1,8 @@
+export const withError = <T extends Error = Error>(
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  ex: any,
+  closure: (error: T) => number,
+  predicate = (ex: T) => ex.name !== undefined && ex.message !== undefined
+) => {
+  return predicate(ex as T) ? closure(ex as T) : undefined
+}

package/src/lib/yarnInitCwd.ts

@@ -0,0 +1,3 @@
+import { assertEx } from '@xylabs/sdk-js'
+
+export const INIT_CWD = () => assertEx(process.env.INIT_CWD, 'Missing INIT_CWD')

package/src/lint.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { runSteps } from './lib'
+
+runSteps('Lint', [['yarn', 'eslint .']])

package/src/rebuild.ts

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+
+import { runSteps } from './lib'
+
+runSteps('Rebuild', [
+  ['yarn', 'clean'],
+  ['yarn', 'build'],
+])

package/src/reinstall.ts

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+
+import { runSteps } from './lib'
+
+runSteps('Reinstall', [
+  ['yarn', 'rimraf ./yarn.lock'],
+  ['yarn', 'rimraf ./node_modules'],
+  ['yarn', 'yarn install --network-timeout 10000'],
+])

package/src/sonar.ts

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { runSteps } from './lib'
+
+runSteps('Sonar', [['yarn', 'eslint -c sonar.eslintrc .']])

package/src/test.ts

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { runSteps } from './lib'
+
+runSteps('Test', [['yarn', 'jest .']])

package/src/types/node-cmd.d.ts

@@ -0,0 +1 @@
+declare module 'node-cmd'

package/src/up.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { runSteps } from './lib'
+
+runSteps('Up', [['yarn', 'outdated']])

package/src/updo.ts

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+
+import { runSteps } from './lib'
+
+runSteps('Updo', [
+  ['yarn', 'install'],
+  ['yarn', 'upgrade-interactive'],
+  ['yarn', 'dedupe'],
+])

package/src/yarn3only.ts

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+
+import { isYarnVersionOrGreater, processEx, safeExit } from './lib'
+safeExit(() => {
+  const [valid, version] = isYarnVersionOrGreater(3)
+  if (!valid) {
+    processEx(`Invalid Yarn version [${version}]`)
+  }
+})

package/tsconfig.build.cjs.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "module": "CommonJS",
+    "outDir": "./dist/cjs",
+    "rootDir": "./src",
+    "target": "ES6"
+  },
+  "exclude": ["src/**/*.spec.ts"],
+  "extends": "./tsconfig.json",
+  "include": ["src"]
+}

package/tsconfig.build.esm.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "module": "ESNext",
+    "outDir": "./dist/esm",
+    "rootDir": "./src",
+    "target": "ES2022"
+  },
+  "exclude": ["src/**/*.spec.ts"],
+  "extends": "./tsconfig.json",
+  "include": ["src"]
+}

package/tsconfig.json

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

package/tsconfig.test.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["**/*.spec.ts"]
+}