@storm-software/eslint 0.107.1 → 0.107.3

package/dist/preset.d.cts

@@ -1,4 +1,5 @@
 import { Linter } from 'eslint';
+import { GetStormRulesConfigOptions } from './rules/storm.cjs';
 
 /* eslint-disable */
 /* prettier-ignore */
@@ -7006,12 +7007,6 @@ type YmlSpacedComment =
       }
     ];
 
-interface GetStormRulesConfigOptions {
-    typescriptEslintConfigType?: string;
-    useUnicorn?: boolean;
-    useNx?: boolean;
-}
-
 /**
  * The module boundary dependency constraints.
  */

package/dist/preset.d.ts

@@ -1,4 +1,5 @@
 import { Linter } from 'eslint';
+import { GetStormRulesConfigOptions } from './rules/storm.js';
 
 /* eslint-disable */
 /* prettier-ignore */
@@ -7006,12 +7007,6 @@ type YmlSpacedComment =
       }
     ];
 
-interface GetStormRulesConfigOptions {
-    typescriptEslintConfigType?: string;
-    useUnicorn?: boolean;
-    useNx?: boolean;
-}
-
 /**
  * The module boundary dependency constraints.
  */

package/dist/preset.js

@@ -1,9 +1,363 @@
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+import {
+  formatConfig
+} from "./chunk-FTXILLLE.js";
+import {
+  ignores
+} from "./chunk-VJ6CKC4P.js";
+import {
+  getStormRulesConfig
+} from "./chunk-E7T4SNH3.js";
+import {
+  ts_docs_default
+} from "./chunk-723HQUNP.js";
+import {
+  banner_plugin_default
+} from "./chunk-LSG5T3ZK.js";
+import "./chunk-Y67QTC5U.js";
+import {
+  CODE_BLOCK,
+  TS_FILE
+} from "./chunk-RTM5LCEB.js";
+import {
+  __name
+} from "./chunk-SHUYVCID.js";
+
+// src/preset.ts
 import eslint from "@eslint/js";
 import next from "@next/eslint-plugin-next";
 import nxPlugin from "@nx/eslint-plugin/nx.js";
-import { formatLogMessage, writeDebug, writeError, writeFatal, writeInfo } from "@storm-software/config-tools";
+
+// ../config-tools/src/types.ts
+var LogLevel = {
+  SILENT: 0,
+  FATAL: 10,
+  ERROR: 20,
+  WARN: 30,
+  SUCCESS: 35,
+  INFO: 40,
+  DEBUG: 60,
+  TRACE: 70,
+  ALL: 100
+};
+var LogLevelLabel = {
+  SILENT: "silent",
+  FATAL: "fatal",
+  ERROR: "error",
+  WARN: "warn",
+  INFO: "info",
+  DEBUG: "debug",
+  TRACE: "trace",
+  ALL: "all"
+};
+
+// ../config/src/constants.ts
+var STORM_DEFAULT_DOCS = "https://docs.stormsoftware.com";
+var STORM_DEFAULT_HOMEPAGE = "https://stormsoftware.com";
+var STORM_DEFAULT_LICENSING = "https://license.stormsoftware.com";
+
+// ../config/src/schema.ts
+import z from "zod";
+var DarkColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#1d1e22").describe("The dark background color of the workspace");
+var LightColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#f4f4f5").describe("The light background color of the workspace");
+var BrandColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#1fb2a6").describe("The primary brand specific color of the workspace");
+var AlternateColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).optional().describe("The alternate brand specific color of the workspace");
+var AccentColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).optional().describe("The secondary brand specific color of the workspace");
+var LinkColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).optional().describe("The color used to display hyperlink text");
+var HelpColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#8256D0").describe("The second brand specific color of the workspace");
+var SuccessColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#12B66A").describe("The success color of the workspace");
+var InfoColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#0070E0").describe("The informational color of the workspace");
+var WarningColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#fcc419").describe("The warning color of the workspace");
+var DangerColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#D8314A").describe("The danger color of the workspace");
+var FatalColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).optional().describe("The fatal color of the workspace");
+var PositiveColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#4ade80").describe("The positive number color of the workspace");
+var NegativeColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#ef4444").describe("The negative number color of the workspace");
+var DarkThemeColorConfigSchema = z.object({
+  foreground: LightColorSchema,
+  background: DarkColorSchema,
+  brand: BrandColorSchema,
+  alternate: AlternateColorSchema,
+  accent: AccentColorSchema,
+  link: LinkColorSchema,
+  help: HelpColorSchema,
+  success: SuccessColorSchema,
+  info: InfoColorSchema,
+  warning: WarningColorSchema,
+  danger: DangerColorSchema,
+  fatal: FatalColorSchema,
+  positive: PositiveColorSchema,
+  negative: NegativeColorSchema
+});
+var LightThemeColorConfigSchema = z.object({
+  foreground: DarkColorSchema,
+  background: LightColorSchema,
+  brand: BrandColorSchema,
+  alternate: AlternateColorSchema,
+  accent: AccentColorSchema,
+  link: LinkColorSchema,
+  help: HelpColorSchema,
+  success: SuccessColorSchema,
+  info: InfoColorSchema,
+  warning: WarningColorSchema,
+  danger: DangerColorSchema,
+  fatal: FatalColorSchema,
+  positive: PositiveColorSchema,
+  negative: NegativeColorSchema
+});
+var MultiThemeColorConfigSchema = z.object({
+  dark: DarkThemeColorConfigSchema,
+  light: LightThemeColorConfigSchema
+});
+var SingleThemeColorConfigSchema = z.object({
+  dark: DarkColorSchema,
+  light: LightColorSchema,
+  brand: BrandColorSchema,
+  alternate: AlternateColorSchema,
+  accent: AccentColorSchema,
+  link: LinkColorSchema,
+  help: HelpColorSchema,
+  success: SuccessColorSchema,
+  info: InfoColorSchema,
+  warning: WarningColorSchema,
+  danger: DangerColorSchema,
+  fatal: FatalColorSchema,
+  positive: PositiveColorSchema,
+  negative: NegativeColorSchema
+});
+var RegistryUrlConfigSchema = z.string().trim().toLowerCase().url().optional().describe("A remote registry URL used to publish distributable packages");
+var RegistryConfigSchema = z.object({
+  github: RegistryUrlConfigSchema,
+  npm: RegistryUrlConfigSchema,
+  cargo: RegistryUrlConfigSchema,
+  cyclone: RegistryUrlConfigSchema,
+  container: RegistryUrlConfigSchema
+}).default({}).describe("A list of remote registry URLs used by Storm Software");
+var ColorConfigSchema = SingleThemeColorConfigSchema.or(MultiThemeColorConfigSchema).describe("Colors used for various workspace elements");
+var ColorConfigMapSchema = z.union([
+  z.object({
+    "base": ColorConfigSchema
+  }),
+  z.record(z.string(), ColorConfigSchema)
+]);
+var WorkspaceBotConfigSchema = z.object({
+  name: z.string().trim().default("Stormie-Bot").describe("The workspace bot user's name (this is the bot that will be used to perform various tasks)"),
+  email: z.string().trim().email().default("bot@stormsoftware.com").describe("The email of the workspace bot")
+}).describe("The workspace's bot user's config used to automated various operations tasks");
+var WorkspaceDirectoryConfigSchema = z.object({
+  cache: z.string().trim().optional().describe("The directory used to store the environment's cached file data"),
+  data: z.string().trim().optional().describe("The directory used to store the environment's data files"),
+  config: z.string().trim().optional().describe("The directory used to store the environment's configuration files"),
+  temp: z.string().trim().optional().describe("The directory used to store the environment's temp files"),
+  log: z.string().trim().optional().describe("The directory used to store the environment's temp files"),
+  build: z.string().trim().default("dist").describe("The directory used to store the workspace's distributable files after a build (relative to the workspace root)")
+}).describe("Various directories used by the workspace to store data, cache, and configuration files");
+var StormConfigSchema = z.object({
+  $schema: z.string().trim().default("https://cdn.jsdelivr.net/npm/@storm-software/config/schemas/storm.schema.json").optional().nullish().describe("The URL to the JSON schema file that describes the Storm configuration file"),
+  extends: z.string().trim().optional().describe("The path to a base JSON file to use as a configuration preset file"),
+  name: z.string().trim().toLowerCase().optional().describe("The name of the service/package/scope using this configuration"),
+  namespace: z.string().trim().toLowerCase().optional().describe("The namespace of the package"),
+  organization: z.string().trim().default("storm-software").describe("The organization of the workspace"),
+  repository: z.string().trim().url().optional().describe("The repo URL of the workspace (i.e. GitHub)"),
+  license: z.string().trim().default("Apache-2.0").describe("The license type of the package"),
+  homepage: z.string().trim().url().default(STORM_DEFAULT_HOMEPAGE).describe("The homepage of the workspace"),
+  docs: z.string().trim().url().default(STORM_DEFAULT_DOCS).describe("The base documentation site for the workspace"),
+  licensing: z.string().trim().url().default(STORM_DEFAULT_LICENSING).describe("The base licensing site for the workspace"),
+  branch: z.string().trim().default("main").describe("The branch of the workspace"),
+  preid: z.string().optional().describe("A tag specifying the version pre-release identifier"),
+  owner: z.string().trim().default("@storm-software/admin").describe("The owner of the package"),
+  bot: WorkspaceBotConfigSchema,
+  env: z.enum([
+    "development",
+    "staging",
+    "production"
+  ]).default("production").describe("The current runtime environment name for the package"),
+  workspaceRoot: z.string().trim().default("").describe("The root directory of the workspace"),
+  externalPackagePatterns: z.array(z.string()).default([]).describe("The build will use these package patterns to determine if they should be external to the bundle"),
+  skipCache: z.boolean().default(false).describe("Should all known types of workspace caching be skipped?"),
+  directories: WorkspaceDirectoryConfigSchema,
+  packageManager: z.enum([
+    "npm",
+    "yarn",
+    "pnpm",
+    "bun"
+  ]).default("npm").describe("The JavaScript/TypeScript package manager used by the repository"),
+  timezone: z.string().trim().default("America/New_York").describe("The default timezone of the workspace"),
+  locale: z.string().trim().default("en-US").describe("The default locale of the workspace"),
+  logLevel: z.enum([
+    "silent",
+    "fatal",
+    "error",
+    "warn",
+    "info",
+    "debug",
+    "trace",
+    "all"
+  ]).default("info").describe("The log level used to filter out lower priority log messages. If not provided, this is defaulted using the `environment` config value (if `environment` is set to `production` then `level` is `error`, else `level` is `debug`)."),
+  registry: RegistryConfigSchema,
+  configFile: z.string().trim().nullable().default(null).describe("The filepath of the Storm config. When this field is null, no config file was found in the current workspace."),
+  colors: ColorConfigSchema.or(ColorConfigMapSchema).describe("Storm theme config values used for styling various package elements"),
+  extensions: z.record(z.any()).optional().default({}).describe("Configuration of each used extension")
+}).describe("Storm Workspace config values used during various dev-ops processes. This type is a combination of the StormPackageConfig and StormProject types. It represents the config of the entire monorepo.");
+
+// ../config-tools/src/utilities/get-default-config.ts
+import { existsSync, readFileSync } from "node:fs";
+import { join } from "node:path";
+var DEFAULT_COLOR_CONFIG = {
+  "light": {
+    "background": "#fafafa",
+    "foreground": "#1d1e22",
+    "brand": "#1fb2a6",
+    "alternate": "#db2777",
+    "help": "#5C4EE5",
+    "success": "#087f5b",
+    "info": "#0550ae",
+    "warning": "#e3b341",
+    "danger": "#D8314A",
+    "positive": "#22c55e",
+    "negative": "#dc2626"
+  },
+  "dark": {
+    "background": "#1d1e22",
+    "foreground": "#cbd5e1",
+    "brand": "#2dd4bf",
+    "alternate": "#db2777",
+    "help": "#818cf8",
+    "success": "#10b981",
+    "info": "#58a6ff",
+    "warning": "#f3d371",
+    "danger": "#D8314A",
+    "positive": "#22c55e",
+    "negative": "#dc2626"
+  }
+};
+
+// ../config-tools/src/logger/chalk.ts
+import chalk from "chalk";
+var chalkDefault = {
+  hex: /* @__PURE__ */ __name((_) => (message) => message, "hex"),
+  bgHex: /* @__PURE__ */ __name((_) => ({
+    whiteBright: /* @__PURE__ */ __name((message) => message, "whiteBright")
+  }), "bgHex"),
+  whiteBright: /* @__PURE__ */ __name((message) => message, "whiteBright"),
+  bold: {
+    hex: /* @__PURE__ */ __name((_) => (message) => message, "hex"),
+    bgHex: /* @__PURE__ */ __name((_) => ({
+      whiteBright: /* @__PURE__ */ __name((message) => message, "whiteBright")
+    }), "bgHex"),
+    whiteBright: /* @__PURE__ */ __name((message) => message, "whiteBright")
+  }
+};
+var getChalk = /* @__PURE__ */ __name(() => {
+  let _chalk = chalk;
+  if (!_chalk?.hex || !_chalk?.bold?.hex || !_chalk?.bgHex || !_chalk?.whiteBright) {
+    _chalk = chalkDefault;
+  }
+  return _chalk;
+}, "getChalk");
+
+// ../config-tools/src/logger/get-log-level.ts
+var getLogLevel = /* @__PURE__ */ __name((label) => {
+  switch (label) {
+    case "all":
+      return LogLevel.ALL;
+    case "trace":
+      return LogLevel.TRACE;
+    case "debug":
+      return LogLevel.DEBUG;
+    case "info":
+      return LogLevel.INFO;
+    case "warn":
+      return LogLevel.WARN;
+    case "error":
+      return LogLevel.ERROR;
+    case "fatal":
+      return LogLevel.FATAL;
+    case "silent":
+      return LogLevel.SILENT;
+    default:
+      return LogLevel.INFO;
+  }
+}, "getLogLevel");
+
+// ../config-tools/src/logger/console.ts
+var getLogFn = /* @__PURE__ */ __name((logLevel = LogLevel.INFO, config = {}) => {
+  const _chalk = getChalk();
+  const colors = !config.colors?.dark && !config.colors?.["base"] && !config.colors?.["base"]?.dark ? DEFAULT_COLOR_CONFIG : config.colors?.dark && typeof config.colors.dark === "string" ? config.colors : config.colors?.["base"]?.dark && typeof config.colors["base"].dark === "string" ? config.colors["base"].dark : config.colors?.["base"] ? config.colors?.["base"] : DEFAULT_COLOR_CONFIG;
+  const configLogLevel = config.logLevel || process.env.STORM_LOG_LEVEL || LogLevelLabel.INFO;
+  if (typeof logLevel === "number" && (logLevel >= getLogLevel(configLogLevel) || logLevel <= LogLevel.SILENT) || typeof logLevel === "string" && getLogLevel(logLevel) >= getLogLevel(configLogLevel)) {
+    return (_) => {
+    };
+  }
+  if (typeof logLevel === "number" && LogLevel.FATAL >= logLevel || typeof logLevel === "string" && LogLevel.FATAL >= getLogLevel(logLevel)) {
+    return (message) => {
+      console.error(`${_chalk.bold.hex(colors.fatal ?? "#7d1a1a")(">")} ${_chalk.bold.bgHex(colors.fatal ?? "#7d1a1a").whiteBright(" \u{1F480} Fatal ")}  ${_chalk.hex(colors.fatal ?? "#7d1a1a")(formatLogMessage(message))}
+`);
+    };
+  }
+  if (typeof logLevel === "number" && LogLevel.ERROR >= logLevel || typeof logLevel === "string" && LogLevel.ERROR >= getLogLevel(logLevel)) {
+    return (message) => {
+      console.error(`${_chalk.bold.hex(colors.danger ?? "#f85149")(">")} ${_chalk.bold.bgHex(colors.danger ?? "#f85149").whiteBright(" \u2718  Error ")}  ${_chalk.hex(colors.danger ?? "#f85149")(formatLogMessage(message))}
+`);
+    };
+  }
+  if (typeof logLevel === "number" && LogLevel.WARN >= logLevel || typeof logLevel === "string" && LogLevel.WARN >= getLogLevel(logLevel)) {
+    return (message) => {
+      console.warn(`${_chalk.bold.hex(colors.warning ?? "#e3b341")(">")} ${_chalk.bold.bgHex(colors.warning ?? "#e3b341").whiteBright("  \u26A0 Warn  ")}  ${_chalk.hex(colors.warning ?? "#e3b341")(formatLogMessage(message))}
+`);
+    };
+  }
+  if (typeof logLevel === "number" && LogLevel.SUCCESS >= logLevel || typeof logLevel === "string" && LogLevel.SUCCESS >= getLogLevel(logLevel)) {
+    return (message) => {
+      console.info(`${_chalk.bold.hex(colors.success ?? "#56d364")(">")} ${_chalk.bold.bgHex(colors.success ?? "#56d364").whiteBright(" \u2713 Success ")}  ${_chalk.hex(colors.success ?? "#56d364")(formatLogMessage(message))}
+`);
+    };
+  }
+  if (typeof logLevel === "number" && LogLevel.INFO >= logLevel || typeof logLevel === "string" && LogLevel.INFO >= getLogLevel(logLevel)) {
+    return (message) => {
+      console.info(`${_chalk.bold.hex(colors.info ?? "#58a6ff")(">")} ${_chalk.bold.bgHex(colors.info ?? "#58a6ff").whiteBright("  \u2139 Info  ")}  ${_chalk.hex(colors.info ?? "#58a6ff")(formatLogMessage(message))}
+`);
+    };
+  }
+  if (typeof logLevel === "number" && LogLevel.TRACE >= logLevel || typeof logLevel === "string" && LogLevel.TRACE >= getLogLevel(logLevel)) {
+    return (message) => {
+      console.debug(`${_chalk.bold.hex(colors.brand ?? "#1fb2a6")(">")} ${_chalk.bold.bgHex(colors.brand ?? "#1fb2a6").whiteBright(" \u{1F6E0}  Debug ")}  ${_chalk.hex(colors.brand ?? "#1fb2a6")(formatLogMessage(message))}
+`);
+    };
+  }
+  return (message) => {
+    console.log(`${_chalk.bold.hex(colors.brand ?? "#1fb2a6")(">")} ${_chalk.bold.bgHex(colors.brand ?? "#1fb2a6").whiteBright(" \u2709 System ")}  ${_chalk.hex(colors.brand ?? "#1fb2a6")(formatLogMessage(message))}
+`);
+  };
+}, "getLogFn");
+var writeFatal = /* @__PURE__ */ __name((message, config) => getLogFn(LogLevel.FATAL, config)(message), "writeFatal");
+var writeError = /* @__PURE__ */ __name((message, config) => getLogFn(LogLevel.ERROR, config)(message), "writeError");
+var writeInfo = /* @__PURE__ */ __name((message, config) => getLogFn(LogLevel.INFO, config)(message), "writeInfo");
+var writeDebug = /* @__PURE__ */ __name((message, config) => getLogFn(LogLevel.DEBUG, config)(message), "writeDebug");
+var MAX_DEPTH = 4;
+var formatLogMessage = /* @__PURE__ */ __name((message, options = {}, depth = 0) => {
+  if (depth > MAX_DEPTH) {
+    return "<max depth>";
+  }
+  const prefix = options.prefix ?? "-";
+  const skip = options.skip ?? [];
+  return typeof message === "undefined" || message === null || !message && typeof message !== "boolean" ? "<none>" : typeof message === "string" ? message : Array.isArray(message) ? `
+${message.map((item, index) => ` ${prefix}> #${index} = ${formatLogMessage(item, {
+    prefix: `${prefix}-`,
+    skip
+  }, depth + 1)}`).join("\n")}` : typeof message === "object" ? `
+${Object.keys(message).filter((key) => !skip.includes(key)).map((key) => ` ${prefix}> ${key} = ${_isFunction(message[key]) ? "<function>" : typeof message[key] === "object" ? formatLogMessage(message[key], {
+    prefix: `${prefix}-`,
+    skip
+  }, depth + 1) : message[key]}`).join("\n")}` : message;
+}, "formatLogMessage");
+var _isFunction = /* @__PURE__ */ __name((value) => {
+  try {
+    return value instanceof Function || typeof value === "function" || !!(value?.constructor && value?.call && value?.apply);
+  } catch (e) {
+    return false;
+  }
+}, "_isFunction");
+
+// src/preset.ts
 import { defu } from "defu";
 import json from "eslint-plugin-json";
 import markdown from "eslint-plugin-markdown";
@@ -16,12 +370,6 @@ import unicorn from "eslint-plugin-unicorn";
 import yml from "eslint-plugin-yml";
 import globalsObj from "globals";
 import tsEslint from "typescript-eslint";
-import { getStormRulesConfig } from "./rules/storm";
-import tsdocRules from "./rules/ts-docs";
-import banner from "./utils/banner-plugin";
-import { CODE_BLOCK, TS_FILE } from "./utils/constants";
-import { formatConfig } from "./utils/format-config";
-import { ignores } from "./utils/ignores";
 function getStormConfig(options = {
   rules: {},
   ignores: [],
@@ -162,13 +510,13 @@ function getStormConfig(options = {
       plugins: {
         tsdoc
       },
-      rules: tsdocRules
+      rules: ts_docs_default
     });
     configs.push({
       // ...banner.configs!["recommended"],
       name: "banner",
       plugins: {
-        banner
+        banner: banner_plugin_default
       },
       files: [
         TS_FILE
@@ -358,7 +706,7 @@ function getStormConfig(options = {
   }
 }
 __name(getStormConfig, "getStormConfig");
-const areFilesEqual = /* @__PURE__ */ __name((files1, files2) => {
+var areFilesEqual = /* @__PURE__ */ __name((files1, files2) => {
   if (files1 === files2) {
     return true;
   } else if (!files1 || !files2) {