@xylabs/ts-scripts-yarn3 7.4.22 → 7.4.24

package/dist/index.d.ts

@@ -412,6 +412,8 @@ declare const packagePublint: ({ strict, verbose }?: PackagePublintParams) => Pr
 
 declare const packageRecompile: () => Promise<number>;
 
+declare function packageLintMonorepo(fix?: boolean): number;
+
 interface PublintParams {
     pkg?: string;
     verbose?: boolean;
@@ -524,4 +526,4 @@ declare const xy: () => Promise<{
 
 declare const xyParseOptions: () => Argv;
 
-export { type BuildParams, CROSS_PLATFORM_NEWLINE, type CleanPackageParams, type CleanParams, type CompileConfig, type CompileParams, type CopyAssetsParams, type CycleParams, DEFAULT_README_BODY, DEFAULT_README_TEMPLATE, type DepLintOptions, type DeplintConfig, DuplicateDetector, type DynamicShareConfig, type EntryMode, type GenDocsPackageParams, type GenDocsParams, INIT_CWD, LEGACY_COMMANDS_PREFIX, type LintPackageParams, type LintParams, type LiveShareConfig, type PackageCompileTscConfig, type PackageCompileTsupConfig, type PackageCopyAssetsParams, type PackageJsonEx, type PackagePublintParams, type PathConfig, type PublintPackageParams, type PublintParams, type ReadFileSyncOptions, type ReadmeConfig, type ReadmeGenParams, type ReadmeInitParams, type RebuildParams, type RecompilePackageParams, type RecompileParams, type RelintPackageParams, type RelintParams, type ScriptStep, WINDOWS_NEWLINE_REGEX, type Workspace, XYLABS_COMMANDS_PREFIX, XYLABS_RULES_PREFIX, XYLABS_SKILLS_PREFIX, type XyConfig, type XyConfigBase, type XyConfigLegacy, type XyTscConfig, type XyTsupConfig, applyLogoConfig, build, bundleDts, checkResult, claudeClean, claudeCommandTemplates, claudeCommands, claudeMdLocalTemplate, claudeMdProjectTemplate, claudeMdRuleTemplates, claudeRules, claudeSettings, claudeSkillTemplates, claudeSkills, clean, cleanAll, cleanDocs, cleanPackage, compile, compileAll, compilePackage, copyAssets, createBuildConfig, cycle, cycleAll, cyclePackage, dead, defaultBuildConfig, defaultReadFileSyncOptions, deleteGlob, deplint, deploy, deployMajor, deployMinor, deployNext, detectDuplicateDependencies, dupdeps, empty, fix, genDocs, genDocsAll, genDocsPackage, generateIgnoreFiles, generateReadmeFiles, gitignore, gitignoreGen, gitignoreTemplate, gitlint, gitlintFix, isYarnVersionOrGreater, knip, license, lint, lintAllPackages, lintPackage, loadConfig, loadPackageConfig, multiLineToJSONArray, notEmpty, npmignoreGen, packageClean, packageCleanOutputs, packageCleanTypescript, packageCompile, packageCompileTsc, packageCompileTscTypes, packageCompileTsup, packageCopyAssets, packageCycle, packageGenDocs, packageLint, packagePublint, packageRecompile, parsedPackageJSON, processEx, publint, publintAll, publintPackage, publish, readLines, readNonEmptyLines, readmeGen, readmeInit, rebuild, recompile, recompileAll, recompilePackage, reinstall, relint, relintAllPackages, relintPackage, resolveTemplatePath, retest, runStepAsync, runSteps, runStepsAsync, runXy, runXyWithWarning, safeExit, safeExitAsync, scaffoldTemplate, sonar, statics, test, tryReadFileSync, tsupOptions, union, up, updateYarnPlugins, updateYarnVersion, updo, withErrnoException, withError, writeLines, xy, xyBuildCommands, xyCommonCommands, xyDeployCommands, xyInstallCommands, xyLintCommands, xyParseOptions, yarn3Only, yarnWorkspace, yarnWorkspaces };
+export { type BuildParams, CROSS_PLATFORM_NEWLINE, type CleanPackageParams, type CleanParams, type CompileConfig, type CompileParams, type CopyAssetsParams, type CycleParams, DEFAULT_README_BODY, DEFAULT_README_TEMPLATE, type DepLintOptions, type DeplintConfig, DuplicateDetector, type DynamicShareConfig, type EntryMode, type GenDocsPackageParams, type GenDocsParams, INIT_CWD, LEGACY_COMMANDS_PREFIX, type LintPackageParams, type LintParams, type LiveShareConfig, type PackageCompileTscConfig, type PackageCompileTsupConfig, type PackageCopyAssetsParams, type PackageJsonEx, type PackagePublintParams, type PathConfig, type PublintPackageParams, type PublintParams, type ReadFileSyncOptions, type ReadmeConfig, type ReadmeGenParams, type ReadmeInitParams, type RebuildParams, type RecompilePackageParams, type RecompileParams, type RelintPackageParams, type RelintParams, type ScriptStep, WINDOWS_NEWLINE_REGEX, type Workspace, XYLABS_COMMANDS_PREFIX, XYLABS_RULES_PREFIX, XYLABS_SKILLS_PREFIX, type XyConfig, type XyConfigBase, type XyConfigLegacy, type XyTscConfig, type XyTsupConfig, applyLogoConfig, build, bundleDts, checkResult, claudeClean, claudeCommandTemplates, claudeCommands, claudeMdLocalTemplate, claudeMdProjectTemplate, claudeMdRuleTemplates, claudeRules, claudeSettings, claudeSkillTemplates, claudeSkills, clean, cleanAll, cleanDocs, cleanPackage, compile, compileAll, compilePackage, copyAssets, createBuildConfig, cycle, cycleAll, cyclePackage, dead, defaultBuildConfig, defaultReadFileSyncOptions, deleteGlob, deplint, deploy, deployMajor, deployMinor, deployNext, detectDuplicateDependencies, dupdeps, empty, fix, genDocs, genDocsAll, genDocsPackage, generateIgnoreFiles, generateReadmeFiles, gitignore, gitignoreGen, gitignoreTemplate, gitlint, gitlintFix, isYarnVersionOrGreater, knip, license, lint, lintAllPackages, lintPackage, loadConfig, loadPackageConfig, multiLineToJSONArray, notEmpty, npmignoreGen, packageClean, packageCleanOutputs, packageCleanTypescript, packageCompile, packageCompileTsc, packageCompileTscTypes, packageCompileTsup, packageCopyAssets, packageCycle, packageGenDocs, packageLint, packageLintMonorepo, packagePublint, packageRecompile, parsedPackageJSON, processEx, publint, publintAll, publintPackage, publish, readLines, readNonEmptyLines, readmeGen, readmeInit, rebuild, recompile, recompileAll, recompilePackage, reinstall, relint, relintAllPackages, relintPackage, resolveTemplatePath, retest, runStepAsync, runSteps, runStepsAsync, runXy, runXyWithWarning, safeExit, safeExitAsync, scaffoldTemplate, sonar, statics, test, tryReadFileSync, tsupOptions, union, up, updateYarnPlugins, updateYarnVersion, updo, withErrnoException, withError, writeLines, xy, xyBuildCommands, xyCommonCommands, xyDeployCommands, xyInstallCommands, xyLintCommands, xyParseOptions, yarn3Only, yarnWorkspace, yarnWorkspaces };

package/dist/index.mjs

@@ -1065,8 +1065,8 @@ var DEFAULT_SETTINGS = {
       "Skill"
     ],
     deny: [
-      "Bash(git push --force*)",
-      "Bash(git reset --hard*)",
+      "Bash(git push --force *)",
+      "Bash(git reset --hard *)",
       "Bash(rm -rf /*)"
     ]
   }
@@ -3272,6 +3272,161 @@ var packageRecompile = async () => {
   return await packageClean() || await packageCompile();
 };
 
+// src/actions/package-lint.ts
+import { readFileSync as readFileSync15, writeFileSync as writeFileSync6 } from "fs";
+import PATH9 from "path";
+import chalk42 from "chalk";
+import picomatch2 from "picomatch";
+function emptyResult() {
+  return {
+    errors: [],
+    fixable: [],
+    warnings: []
+  };
+}
+function readRootPackageJson(cwd5) {
+  const raw = readFileSync15(PATH9.resolve(cwd5, "package.json"), "utf8");
+  return JSON.parse(raw);
+}
+function writeRootPackageJson(cwd5, pkg) {
+  const path14 = PATH9.resolve(cwd5, "package.json");
+  writeFileSync6(path14, `${JSON.stringify(pkg, null, 2)}
+`, "utf8");
+}
+function isMonorepo(pkg) {
+  const workspaces = pkg.workspaces;
+  return Array.isArray(workspaces) && workspaces.length > 0;
+}
+function checkPackagesFolder(workspaces) {
+  const result = emptyResult();
+  for (const { location, name } of workspaces) {
+    if (location === ".") continue;
+    if (!location.startsWith("packages/") && !location.startsWith("packages\\")) {
+      result.errors.push(`${name} (${location}) is not inside a packages/ folder`);
+    }
+  }
+  return result;
+}
+function checkRootPrivate(pkg) {
+  const result = emptyResult();
+  if (!pkg.private) {
+    result.fixable.push("Root package.json must be private to prevent accidental publishing");
+  }
+  return result;
+}
+function fixRootPrivate(cwd5, pkg) {
+  pkg.private = true;
+  writeRootPackageJson(cwd5, pkg);
+  console.log(chalk42.green('  \u2714 Fixed: set "private": true in root package.json'));
+}
+function checkNoPublishConfigOnPrivate(pkg) {
+  const result = emptyResult();
+  if (pkg.private && pkg.publishConfig) {
+    result.fixable.push("Root package.json has publishConfig but is private \u2014 publishConfig is unnecessary");
+  }
+  return result;
+}
+function fixNoPublishConfigOnPrivate(cwd5, pkg) {
+  delete pkg.publishConfig;
+  writeRootPackageJson(cwd5, pkg);
+  console.log(chalk42.green("  \u2714 Fixed: removed publishConfig from private root package.json"));
+}
+function checkDiscoverable(pkg, workspaces) {
+  const result = emptyResult();
+  const globs = pkg.workspaces;
+  const matchers = globs.map((glob3) => picomatch2(glob3));
+  const isMatch = (location) => matchers.some((m) => m(location));
+  for (const { location, name } of workspaces) {
+    if (location === ".") continue;
+    if (!isMatch(location)) {
+      result.errors.push(`${name} (${location}) is not matched by any workspace glob in package.json`);
+    }
+  }
+  return result;
+}
+function logResults(label, result, fix2) {
+  let errors = 0;
+  let fixed = 0;
+  for (const error of result.errors) {
+    console.log(chalk42.red(`  \u2717 ${error}`));
+    errors++;
+  }
+  for (const fixable of result.fixable) {
+    if (fix2) {
+      fixed++;
+    } else {
+      console.log(chalk42.red(`  \u2717 ${fixable} (fixable)`));
+      errors++;
+    }
+  }
+  for (const warning of result.warnings) {
+    console.log(chalk42.yellow(`  \u26A0 ${warning}`));
+  }
+  if (errors === 0 && fixed === 0 && result.warnings.length === 0) {
+    console.log(chalk42.green(`  \u2713 ${label}`));
+  }
+  return { errors, fixed };
+}
+function runChecks(entries, cwd5, pkg, fix2) {
+  let totalErrors = 0;
+  let totalFixed = 0;
+  for (const entry of entries) {
+    const result = entry.check();
+    const log = logResults(entry.label, result, fix2);
+    if (fix2 && entry.fix && result.fixable.length > 0) {
+      entry.fix(cwd5, pkg);
+    }
+    totalErrors += log.errors;
+    totalFixed += log.fixed;
+  }
+  return { errors: totalErrors, fixed: totalFixed };
+}
+function logSummary(errors, fixed) {
+  if (fixed > 0) {
+    console.log(chalk42.green(`
+  Fixed ${fixed} issue(s)`));
+  }
+  if (errors > 0) {
+    console.log(chalk42.red(`
+  ${errors} error(s) found`));
+  } else if (fixed === 0) {
+    console.log(chalk42.green("\n  All checks passed"));
+  }
+}
+function packageLintMonorepo(fix2 = false) {
+  const cwd5 = INIT_CWD() ?? process.cwd();
+  let pkg;
+  try {
+    pkg = readRootPackageJson(cwd5);
+  } catch {
+    console.error(chalk42.red("Could not read package.json"));
+    return 1;
+  }
+  if (!isMonorepo(pkg)) {
+    console.log(chalk42.gray("Not a monorepo \u2014 skipping package-lint checks"));
+    return 0;
+  }
+  console.log(chalk42.green("Package Lint"));
+  const workspaces = yarnWorkspaces();
+  const checks = [
+    {
+      check: () => checkRootPrivate(pkg),
+      fix: fixRootPrivate,
+      label: "Root package is private"
+    },
+    {
+      check: () => checkNoPublishConfigOnPrivate(pkg),
+      fix: fixNoPublishConfigOnPrivate,
+      label: "No publishConfig on private root"
+    },
+    { check: () => checkPackagesFolder(workspaces), label: "All packages are in packages/ folder" },
+    { check: () => checkDiscoverable(pkg, workspaces), label: "All packages are discoverable from workspace globs" }
+  ];
+  const { errors, fixed } = runChecks(checks, cwd5, pkg, fix2);
+  logSummary(errors, fixed);
+  return errors > 0 ? 1 : 0;
+}
+
 // src/actions/publint.ts
 var publint = async ({ verbose, pkg }) => {
   return pkg === void 0 ? publintAll({ verbose }) : await publintPackage({ pkg, verbose });
@@ -3325,7 +3480,7 @@ var rebuild = ({ target }) => {
 };
 
 // src/actions/recompile.ts
-import chalk42 from "chalk";
+import chalk43 from "chalk";
 var recompile = async ({
   verbose,
   target,
@@ -3361,7 +3516,7 @@ var recompileAll = async ({
   const incrementalOptions = incremental ? ["--since", "-Apt", "--topological-dev"] : ["--parallel", "-Apt", "--topological-dev"];
   const jobsOptions = jobs ? ["-j", `${jobs}`] : [];
   if (jobs) {
-    console.log(chalk42.blue(`Jobs set to [${jobs}]`));
+    console.log(chalk43.blue(`Jobs set to [${jobs}]`));
   }
   const result = await runStepsAsync(`Recompile${incremental ? "-Incremental" : ""} [All]`, [
     [
@@ -3392,7 +3547,7 @@ var recompileAll = async ({
     ]
   ]);
   console.log(
-    `${chalk42.gray("Recompiled in")} [${chalk42.magenta(((Date.now() - start) / 1e3).toFixed(2))}] ${chalk42.gray("seconds")}`
+    `${chalk43.gray("Recompiled in")} [${chalk43.magenta(((Date.now() - start) / 1e3).toFixed(2))}] ${chalk43.gray("seconds")}`
   );
   return result;
 };
@@ -3423,13 +3578,13 @@ var reinstall = () => {
 };
 
 // src/actions/relint.ts
-import chalk43 from "chalk";
+import chalk44 from "chalk";
 var relintPackage = ({
   pkg,
   fix: fix2,
   verbose
 }) => {
-  console.log(chalk43.gray(`${fix2 ? "Fix" : "Lint"} [${pkg}]`));
+  console.log(chalk44.gray(`${fix2 ? "Fix" : "Lint"} [${pkg}]`));
   const start = Date.now();
   const result = runSteps(`${fix2 ? "Fix" : "Lint"}  [${pkg}]`, [
     ["yarn", [
@@ -3439,7 +3594,7 @@ var relintPackage = ({
       fix2 ? "package-fix" : verbose ? "package-lint-verbose" : "package-lint"
     ]]
   ]);
-  console.log(chalk43.gray(`${fix2 ? "Fixed in" : "Linted in"} [${chalk43.magenta(((Date.now() - start) / 1e3).toFixed(2))}] ${chalk43.gray("seconds")}`));
+  console.log(chalk44.gray(`${fix2 ? "Fixed in" : "Linted in"} [${chalk44.magenta(((Date.now() - start) / 1e3).toFixed(2))}] ${chalk44.gray("seconds")}`));
   return result;
 };
 var relint = ({
@@ -3459,13 +3614,13 @@ var relint = ({
   });
 };
 var relintAllPackages = ({ fix: fix2 = false } = {}) => {
-  console.log(chalk43.gray(`${fix2 ? "Fix" : "Lint"} [All-Packages]`));
+  console.log(chalk44.gray(`${fix2 ? "Fix" : "Lint"} [All-Packages]`));
   const start = Date.now();
   const fixOptions = fix2 ? ["--fix"] : [];
   const result = runSteps(`${fix2 ? "Fix" : "Lint"}  [All-Packages]`, [
     ["yarn", ["eslint", ...fixOptions]]
   ]);
-  console.log(chalk43.gray(`${fix2 ? "Fixed in" : "Linted in"} [${chalk43.magenta(((Date.now() - start) / 1e3).toFixed(2))}] ${chalk43.gray("seconds")}`));
+  console.log(chalk44.gray(`${fix2 ? "Fixed in" : "Linted in"} [${chalk44.magenta(((Date.now() - start) / 1e3).toFixed(2))}] ${chalk44.gray("seconds")}`));
   return result;
 };
 
@@ -3483,10 +3638,10 @@ var sonar = () => {
 };
 
 // src/actions/statics.ts
-import chalk44 from "chalk";
+import chalk45 from "chalk";
 var DefaultDependencies = ["axios", "@xylabs/pixel", "react", "graphql", "react-router", "@mui/material", "@mui/system"];
 var statics = () => {
-  console.log(chalk44.green("Check Required Static Dependencies"));
+  console.log(chalk45.green("Check Required Static Dependencies"));
   const statics2 = parsedPackageJSON()?.xy?.deps?.statics;
   return detectDuplicateDependencies(statics2, DefaultDependencies);
 };
@@ -4075,7 +4230,7 @@ var xyInstallCommands = (args) => {
 };
 
 // src/xy/lint/cycleCommand.ts
-import chalk45 from "chalk";
+import chalk46 from "chalk";
 var cycleCommand = {
   command: "cycle [package]",
   describe: "Cycle - Check for dependency cycles",
@@ -4086,12 +4241,12 @@ var cycleCommand = {
     const start = Date.now();
     if (argv.verbose) console.log("Cycle");
     process.exitCode = await cycle({ pkg: argv.package });
-    console.log(chalk45.blue(`Finished in ${Date.now() - start}ms`));
+    console.log(chalk46.blue(`Finished in ${Date.now() - start}ms`));
   }
 };
 
 // src/xy/lint/deplintCommand.ts
-import chalk46 from "chalk";
+import chalk47 from "chalk";
 var deplintCommand = {
   command: "deplint [package]",
   describe: "Deplint - Run Deplint",
@@ -4129,12 +4284,12 @@ var deplintCommand = {
       peerDeps: !!argv.peerDeps,
       verbose: !!argv.verbose
     });
-    console.log(chalk46.blue(`Finished in ${Date.now() - start}ms`));
+    console.log(chalk47.blue(`Finished in ${Date.now() - start}ms`));
   }
 };
 
 // src/xy/lint/fixCommand.ts
-import chalk47 from "chalk";
+import chalk48 from "chalk";
 var fixCommand = {
   command: "fix [package]",
   describe: "Fix - Run Eslint w/fix",
@@ -4145,12 +4300,12 @@ var fixCommand = {
     const start = Date.now();
     if (argv.verbose) console.log("Fix");
     process.exitCode = fix();
-    console.log(chalk47.blue(`Finished in ${Date.now() - start}ms`));
+    console.log(chalk48.blue(`Finished in ${Date.now() - start}ms`));
   }
 };
 
 // src/xy/lint/knipCommand.ts
-import chalk48 from "chalk";
+import chalk49 from "chalk";
 var knipCommand = {
   command: "knip",
   describe: "Knip - Run Knip",
@@ -4161,12 +4316,12 @@ var knipCommand = {
     if (argv.verbose) console.log("Knip");
     const start = Date.now();
     process.exitCode = knip();
-    console.log(chalk48.blue(`Knip finished in ${Date.now() - start}ms`));
+    console.log(chalk49.blue(`Knip finished in ${Date.now() - start}ms`));
   }
 };
 
 // src/xy/lint/lintCommand.ts
-import chalk49 from "chalk";
+import chalk50 from "chalk";
 var lintCommand = {
   command: "lint [package]",
   describe: "Lint - Run Eslint",
@@ -4195,12 +4350,29 @@ var lintCommand = {
       cache: argv.cache,
       verbose: !!argv.verbose
     });
-    console.log(chalk49.blue(`Finished in ${Date.now() - start}ms`));
+    console.log(chalk50.blue(`Finished in ${Date.now() - start}ms`));
+  }
+};
+
+// src/xy/lint/packageLintCommand.ts
+var packageLintCommand = {
+  builder: (yargs2) => {
+    return yargs2.option("fix", {
+      default: false,
+      description: "Auto-fix fixable issues",
+      type: "boolean"
+    });
+  },
+  command: "package-lint",
+  describe: "Package Lint - Check monorepo package structure",
+  handler: (argv) => {
+    if (argv.verbose) console.log("Package Lint");
+    process.exitCode = packageLintMonorepo(!!argv.fix);
   }
 };
 
 // src/xy/lint/publintCommand.ts
-import chalk50 from "chalk";
+import chalk51 from "chalk";
 var publintCommand = {
   command: "publint [package]",
   describe: "Publint - Run Publint",
@@ -4211,12 +4383,12 @@ var publintCommand = {
     if (argv.verbose) console.log("Publint");
     const start = Date.now();
     process.exitCode = await publint({ pkg: argv.package, verbose: !!argv.verbose });
-    console.log(chalk50.blue(`Finished in ${Date.now() - start}ms`));
+    console.log(chalk51.blue(`Finished in ${Date.now() - start}ms`));
   }
 };
 
 // src/xy/lint/relintCommand.ts
-import chalk51 from "chalk";
+import chalk52 from "chalk";
 var relintCommand = {
   command: "relint [package]",
   describe: "Relint - Clean & Lint",
@@ -4227,12 +4399,12 @@ var relintCommand = {
     if (argv.verbose) console.log("Relinting");
     const start = Date.now();
     process.exitCode = relint();
-    console.log(chalk51.blue(`Finished in ${Date.now() - start}ms`));
+    console.log(chalk52.blue(`Finished in ${Date.now() - start}ms`));
   }
 };
 
 // src/xy/lint/sonarCommand.ts
-import chalk52 from "chalk";
+import chalk53 from "chalk";
 var sonarCommand = {
   command: "sonar",
   describe: "Sonar - Run Sonar Check",
@@ -4243,17 +4415,17 @@ var sonarCommand = {
     const start = Date.now();
     if (argv.verbose) console.log("Sonar Check");
     process.exitCode = sonar();
-    console.log(chalk52.blue(`Finished in ${Date.now() - start}ms`));
+    console.log(chalk53.blue(`Finished in ${Date.now() - start}ms`));
   }
 };
 
 // src/xy/lint/index.ts
 var xyLintCommands = (args) => {
-  return args.command(cycleCommand).command(lintCommand).command(deplintCommand).command(fixCommand).command(relintCommand).command(publintCommand).command(knipCommand).command(sonarCommand);
+  return args.command(cycleCommand).command(lintCommand).command(deplintCommand).command(fixCommand).command(relintCommand).command(publintCommand).command(knipCommand).command(packageLintCommand).command(sonarCommand);
 };
 
 // src/xy/xy.ts
-import chalk53 from "chalk";
+import chalk54 from "chalk";
 
 // src/xy/xyParseOptions.ts
 import yargs from "yargs";
@@ -4286,8 +4458,8 @@ var xyParseOptions = () => {
 var xy = async () => {
   const options = xyParseOptions();
   return await xyBuildCommands(xyCommonCommands(xyInstallCommands(xyDeployCommands(xyLintCommands(options))))).demandCommand(1).command("*", "", () => {
-    console.error(chalk53.yellow(`Command not found [${chalk53.magenta(process.argv[2])}]`));
-    console.log(chalk53.gray("Try 'yarn xy --help' for list of commands"));
+    console.error(chalk54.yellow(`Command not found [${chalk54.magenta(process.argv[2])}]`));
+    console.log(chalk54.gray("Try 'yarn xy --help' for list of commands"));
   }).version().help().argv;
 };
 export {
@@ -4372,6 +4544,7 @@ export {
   packageCycle,
   packageGenDocs,
   packageLint,
+  packageLintMonorepo,
   packagePublint,
   packageRecompile,
   parsedPackageJSON,