@xylabs/ts-scripts-yarn3 2.17.16 → 2.18.0

package/package.json

@@ -8,6 +8,7 @@
   "bin": {
     "build": "dist/cjs/bin/build.js",
     "clean": "dist/cjs/bin/clean.js",
+    "clean-docs": "dist/cjs/bin/clean-docs.js",
     "compile": "dist/cjs/bin/compile.js",
     "compile-cjs": "dist/cjs/bin/compile-cjs.js",
     "compile-esm": "dist/cjs/bin/compile-esm.js",
@@ -65,9 +66,9 @@
   "dependencies": {
     "@babel/core": "^7.22.5",
     "@babel/preset-env": "^7.22.5",
-    "@types/node": "~18.16.18",
-    "@typescript-eslint/eslint-plugin": "^5.60.0",
-    "@typescript-eslint/parser": "^5.60.0",
+    "@types/node": "^20.3.2",
+    "@typescript-eslint/eslint-plugin": "^5.60.1",
+    "@typescript-eslint/parser": "^5.60.1",
     "chalk": "^4.1.2",
     "cpy": "^8.1.2",
     "depcheck": "^1.4.3",
@@ -77,13 +78,13 @@
     "eslint-plugin-sonarjs": "^0.19.0",
     "jest": "^29.5.0",
     "jest-environment-jsdom": "^29.5.0",
-    "jest-extended": "^3.2.4",
+    "jest-extended": "^4.0.0",
     "jest-mock-extended": "^3.0.4",
     "jest-sorted": "^1.0.14",
     "license-checker": "^25.0.1",
     "lodash": "^4.17.21",
     "node-cmd": "^5.0.0",
-    "npm-check-updates": "^16.10.12",
+    "npm-check-updates": "^16.10.13",
     "npm-package-json-lint": "^6.4.0",
     "npm-package-json-lint-config-default": "^5.0.0",
     "parse-git-config": "^3.0.0",
@@ -104,9 +105,9 @@
     "@types/license-checker": "^25.0.3",
     "@types/lodash": "^4.14.195",
     "@types/parse-git-config": "^3.0.1",
-    "@xylabs/eslint-config": "^2.17.16",
-    "@xylabs/tsconfig": "^2.17.16",
-    "typescript": "^5.1.3"
+    "@xylabs/eslint-config": "^2.18.0",
+    "@xylabs/tsconfig": "^2.18.0",
+    "typescript": "^5.1.5"
   },
   "peerDependencies": {
     "typescript": "^4 || ^5"
@@ -153,5 +154,5 @@
     "compile": "tsc --build tsconfig.build.cjs.json && tsc --build tsconfig.build.esm.json"
   },
   "sideEffects": false,
-  "version": "2.17.16"
+  "version": "2.18.0"
 }

package/src/actions/build.ts

@@ -24,6 +24,7 @@ export const build = async ({ incremental, jobs, target, verbose, pkg }: BuildPa
   const result = await runStepsAsync(`Build${incremental ? '-Incremental' : ''} [${pkg ?? 'All'}]`, [
     ['yarn', ['xy', 'recompile', ...pkgOptions, ...targetOptions, ...verboseOptions, ...jobsOptions, ...incrementalOptions]],
     ['yarn', ['xy', 'relint', ...pkgOptions, ...verboseOptions, ...incrementalOptions]],
+    ['yarn', ['xy', 'gen-docs', ...pkgOptions, ...verboseOptions, ...incrementalOptions]],
     ['yarn', ['xy', 'deps', ...pkgOptions, ...verboseOptions, ...jobsOptions, ...incrementalOptions]],
   ])
   console.log(`${chalk.gray('Built in')} [${chalk.magenta(((Date.now() - start) / 1000).toFixed(2))}] ${chalk.gray('seconds')}`)

package/src/actions/clean-docs.ts

@@ -0,0 +1,12 @@
+import chalk from 'chalk'
+import path from 'path'
+import { rimrafSync } from 'rimraf'
+
+import { yarnWorkspaces } from '../lib'
+
+export const cleanDocs = () => {
+  const pkgName = process.env.npm_package_name
+  console.log(chalk.green(`Cleaning Docs [${pkgName}]`))
+  yarnWorkspaces().map(({ location }) => rimrafSync(path.join(location, 'docs'), { glob: true }))
+  return 0
+}

package/src/actions/clean.ts

@@ -1,4 +1,5 @@
 import { runSteps } from '../lib'
+import { cleanDocs } from './clean-docs'
 import { cleanESLint } from './clean-eslint'
 import { cleanJest } from './clean-jest'
 
@@ -7,5 +8,5 @@ export interface CleanParams {
 }
 
 export const clean = () => {
-  return cleanJest() + cleanESLint() + runSteps('Clean', [['yarn', 'workspaces foreach -pA run package-clean']])
+  return cleanJest() + cleanESLint() + cleanDocs() + runSteps('Clean', [['yarn', 'workspaces foreach -pA run package-clean']])
 }

package/src/actions/gitignore-gen.ts

@@ -0,0 +1,5 @@
+import { generateIgnoreFiles } from '../lib'
+
+const filename = '.gitignore'
+
+export const gitignoreGen = (pkg?: string) => generateIgnoreFiles(filename, pkg)

package/src/actions/index.ts

@@ -1,5 +1,6 @@
 export * from './build'
 export * from './clean'
+export * from './clean-docs'
 export * from './compile'
 export * from './copy-assets'
 export * from './cycle'
@@ -12,12 +13,14 @@ export * from './deps'
 export * from './dupdeps'
 export * from './fix'
 export * from './gen-docs'
+export * from './gitignore-gen'
 export * from './gitlint'
 export * from './gitlint-fix'
 export * from './license'
 export * from './lint'
 export * from './lint-clean'
 export * from './lint-profile'
+export * from './npmignore-gen'
 export * from './package'
 export * from './rebuild'
 export * from './recompile'

package/src/actions/npmignore-gen.ts

@@ -0,0 +1,5 @@
+import { generateIgnoreFiles } from '../lib'
+
+const filename = '.npmignore'
+
+export const npmignoreGen = (pkg?: string) => generateIgnoreFiles(filename, pkg)

package/src/actions/package/recompile.ts

@@ -1,7 +1,6 @@
 import { packageClean } from './clean'
-import { packageCompileCjs } from './compile-cjs'
-import { packageCompileEsm } from './compile-esm'
+import { packageCompile } from './compile'
 
 export const packageRecompile = async () => {
-  return (await Promise.all([packageClean(), packageCompileEsm(), packageCompileCjs()])).reduce((prev, value) => prev + value, 0)
+  return (await Promise.all([packageClean(), packageCompile()])).reduce((prev, value) => prev + value, 0)
 }

package/src/actions/rebuild.ts

@@ -8,7 +8,6 @@ export interface RebuildParams {
 export const rebuild = ({ target }: RebuildParams) => {
   return runSteps('Rebuild', [
     ['yarn', 'xy clean'],
-    ['yarn', target ? `xy compile -t ${target}` : 'xy compile'],
-    ['yarn', 'xy relint'],
+    ['yarn', target ? `xy build -t ${target}` : 'xy build'],
   ])
 }

package/src/lib/file/ReadFileSyncOptions.ts

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

package/src/lib/file/constants.ts

@@ -0,0 +1,2 @@
+export const WINDOWS_NEWLINE_REGEX = /\r\n/g
+export const CROSS_PLATFORM_NEWLINE = '\n'

package/src/lib/file/fileLines.ts

@@ -0,0 +1,18 @@
+import { existsSync, PathLike, readFileSync, WriteFileOptions, writeFileSync } from 'node:fs'
+
+import { notEmpty } from '../string'
+import { CROSS_PLATFORM_NEWLINE, WINDOWS_NEWLINE_REGEX } from './constants'
+import { defaultReadFileSyncOptions, ReadFileSyncOptions } from './ReadFileSyncOptions'
+
+export const readLines = (uri: PathLike, options: ReadFileSyncOptions = defaultReadFileSyncOptions): string[] =>
+  existsSync(uri) ? readFileSync(uri, options).replace(WINDOWS_NEWLINE_REGEX, CROSS_PLATFORM_NEWLINE).split(CROSS_PLATFORM_NEWLINE) : []
+
+export const readNonEmptyLines = (uri: PathLike, options: ReadFileSyncOptions = defaultReadFileSyncOptions): string[] =>
+  readLines(uri, options).filter(notEmpty)
+
+export const writeLines = (uri: PathLike, lines: string[], options: WriteFileOptions = defaultReadFileSyncOptions) => {
+  const existing = existsSync(uri) ? readFileSync(uri, options) : undefined
+  const desired = lines.join(CROSS_PLATFORM_NEWLINE)
+  // Check if the file is different before writing
+  if (existing !== desired) writeFileSync(uri, desired, options)
+}

package/src/lib/file/index.ts

@@ -0,0 +1,4 @@
+export * from './constants'
+export * from './fileLines'
+export * from './ReadFileSyncOptions'
+export * from './tryReadFileSync'

package/src/lib/file/tryReadFileSync.ts

@@ -0,0 +1,7 @@
+import { existsSync, PathLike, readFileSync } from 'node:fs'
+
+import { defaultReadFileSyncOptions, ReadFileSyncOptions } from './ReadFileSyncOptions'
+
+export const tryReadFileSync = (uri: PathLike, options: ReadFileSyncOptions = defaultReadFileSyncOptions): string | undefined => {
+  return existsSync(uri) ? readFileSync(uri, options) : undefined
+}

package/src/lib/generateIgnoreFiles.ts

@@ -0,0 +1,27 @@
+import chalk from 'chalk'
+
+import { readNonEmptyLines, writeLines } from './file'
+import { union } from './string'
+import { INIT_CWD, yarnWorkspace, yarnWorkspaces } from './yarn'
+
+const mergeEntries = (a: string[], b: string[]): string[] => [...union(a, b)].sort()
+
+export const generateIgnoreFiles = (filename: string, pkg?: string) => {
+  console.log(chalk.green(`Generate ${filename} Files`))
+  const cwd = INIT_CWD() ?? '.'
+  const workspaces = pkg ? [yarnWorkspace(pkg)] : yarnWorkspaces()
+  const readEntries = (location: string): string[] => readNonEmptyLines(`${location}/${filename}`)
+  const writeEntries = (location: string, entries: string[]) => writeLines(`${location}/${filename}`, entries)
+  const results = workspaces.map(({ location, name }) => {
+    try {
+      writeEntries(location, mergeEntries(readEntries(cwd), readEntries(location)))
+      return 0
+    } catch (ex) {
+      const error = ex as Error
+      console.error(`Generate ${filename} Files [${name}] [${error.message}]`)
+      return 1
+    }
+  })
+  const succeeded = results.every((result) => result === 0)
+  return succeeded ? 0 : 1
+}

package/src/lib/index.ts

@@ -2,7 +2,8 @@ export * from './checkResult'
 export * from './createBuildConfig'
 export * from './defaultBuildConfig'
 export * from './dependencies'
-export * from './isYarnVersionOrGreater'
+export * from './file'
+export * from './generateIgnoreFiles'
 export * from './jsonFormatters'
 export * from './parsedPackageJSON'
 export * from './processEx'
@@ -11,8 +12,8 @@ export * from './runStepsAsync'
 export * from './runXy'
 export * from './runXyWithWarning'
 export * from './safeExit'
+export * from './string'
 export * from './withErrnoException'
 export * from './withError'
 export * from './xy'
-export * from './yarnInitCwd'
-export * from './yarnWorkspaces'
+export * from './yarn'

package/src/lib/string/empty.ts

@@ -0,0 +1,2 @@
+export const empty = (value?: string | undefined): boolean => value?.trim().length === 0
+export const notEmpty = (value?: string | undefined): boolean => !empty(value)

package/src/lib/string/index.ts

@@ -0,0 +1,2 @@
+export * from './empty'
+export * from './union'

package/src/lib/string/union.ts

@@ -0,0 +1 @@
+export const union = (a: string[], b: string[]): Set<string> => new Set([...new Set(a), ...new Set(b)])

package/src/lib/xy/xyCommonCommands.ts

@@ -1,12 +1,15 @@
 import yargs from 'yargs'
 
 import {
+  cleanDocs,
   dead,
   deps,
   genDocs,
+  gitignoreGen,
   gitlint,
   gitlintFix,
   license,
+  npmignoreGen,
   retest,
   test,
   tsconfigGen,
@@ -71,6 +74,15 @@ export const xyCommonCommands = (args: yargs.Argv) => {
         process.exitCode = genDocs({ incremental: !!argv.incremental, pkg: argv.package as string })
       },
     )
+    .command(
+      'clean-docs',
+      'CleanDocs - Clean TypeDocs',
+      (yargs) => yargs,
+      (argv) => {
+        if (argv.verbose) console.log('Cleaning TypeDocs: all')
+        process.exitCode = cleanDocs()
+      },
+    )
     .command(
       'gitlint [package]',
       'Gitlint - Lint your git config',
@@ -82,6 +94,28 @@ export const xyCommonCommands = (args: yargs.Argv) => {
         process.exitCode = argv.fix ? gitlintFix() : gitlint()
       },
     )
+    .command(
+      'gitignore-gen',
+      'GitIgnore Gen - Generate .gitignore files',
+      (yargs) => {
+        return yargs
+      },
+      (argv) => {
+        if (argv.verbose) console.log('GitIgnore Gen')
+        process.exitCode = gitignoreGen()
+      },
+    )
+    .command(
+      'npmignore-gen',
+      'NpmIgnore Gen - Generate .npmignore files',
+      (yargs) => {
+        return yargs
+      },
+      (argv) => {
+        if (argv.verbose) console.log('NpmIgnore Gen')
+        process.exitCode = npmignoreGen()
+      },
+    )
     .command(
       'retest',
       'Re-Test - Run Jest Tests with cleaned cache',

package/src/lib/yarn/index.ts

@@ -0,0 +1,3 @@
+export * from './isYarnVersionOrGreater'
+export * from './workspace'
+export * from './yarnInitCwd'

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

@@ -0,0 +1,4 @@
+export interface Workspace {
+  location: string
+  name: string
+}

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

@@ -0,0 +1,3 @@
+export * from './Workspace'
+export * from './yarnWorkspace'
+export * from './yarnWorkspaces'

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

@@ -0,0 +1,8 @@
+import { Workspace } from './Workspace'
+import { yarnWorkspaces } from './yarnWorkspaces'
+
+export const yarnWorkspace = (pkg: string): Workspace => {
+  const workspace = yarnWorkspaces().find(({ name }) => name === pkg)
+  if (!workspace) throw new Error(`Workspace ${pkg} not found`)
+  return workspace
+}

package/src/lib/{yarnWorkspaces.ts → yarn/workspace/yarnWorkspaces.ts}

@@ -1,9 +1,6 @@
 import { spawnSync } from 'child_process'
 
-export interface Workspace {
-  location: string
-  name: string
-}
+import { Workspace } from './Workspace'
 
 export const yarnWorkspaces = (): Workspace[] => {
   const result = spawnSync('yarn', ['workspaces', 'list', '--json', '--recursive'], { encoding: 'utf8', shell: true })
@@ -12,6 +9,8 @@ export const yarnWorkspaces = (): Workspace[] => {
   }
   const list = result.stdout
     .toString()
+    // NOTE: This probably doesn't work on Windows
+    // TODO: Replace /r/n with /n first
     .split('\n')
     .slice(0, -1)
     .map((item) => {

package/.depcheckrc

@@ -1,13 +0,0 @@
-ignores: [
-  "@xylabs/rollup-config",
-  "npm-package-json-lint-config-default",
-  "npm-check-updates",
-  "eslint-plugin-sonarjs",
-  "copyfiles",
-  "jest",
-  "jest-sorted",
-  "ts-jest",
-  "rollup",
-  "node-cmd",
-  "tslib"
-]

package/.tsconfig.build.cjs.json

@@ -1,30 +0,0 @@
-{
-  "compilerOptions": {
-    "rootDir": "src",
-    "rootDirs": [
-      "package.json"
-    ],
-    "composite": true,
-    "declarationDir": "./dist/types",
-    "typeRoots": [],
-    "module": "CommonJS",
-    "outDir": "./dist/cjs",
-    "target": "ES6"
-  },
-  "extends": "@xylabs/tsconfig",
-  "include": [
-    "src",
-    "src"
-  ],
-  "exclude": [
-    "**/build",
-    "**/dist",
-    "**/node_modules",
-    "**/*.spec.*",
-    "**/*.spec",
-    "**/*.stories.*",
-    "**/*.example.*",
-    "**/spec/*",
-    "**/stories/*"
-  ]
-}

package/.tsconfig.build.esm.json

@@ -1,30 +0,0 @@
-{
-  "compilerOptions": {
-    "rootDir": "src",
-    "rootDirs": [
-      "package.json"
-    ],
-    "composite": true,
-    "declarationDir": "./dist/types",
-    "typeRoots": [],
-    "module": "ESNext",
-    "outDir": "./dist/esm",
-    "target": "ESNext"
-  },
-  "extends": "@xylabs/tsconfig",
-  "include": [
-    "src",
-    "src"
-  ],
-  "exclude": [
-    "**/build",
-    "**/dist",
-    "**/node_modules",
-    "**/*.spec.*",
-    "**/*.spec",
-    "**/*.stories.*",
-    "**/*.example.*",
-    "**/spec/*",
-    "**/stories/*"
-  ]
-}