@storm-software/eslint 0.138.1 → 0.139.0

package/README.md

@@ -21,7 +21,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
 
 <h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
 
-[![Version](https://img.shields.io/badge/version-0.138.0-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
+[![Version](https://img.shields.io/badge/version-0.138.1-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
 
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->

package/dist/chunk-7JRBTALJ.js

@@ -0,0 +1,91 @@
+import {
+  correctPaths
+} from "./chunk-G7QVU75O.js";
+import {
+  __name
+} from "./chunk-SHUYVCID.js";
+
+// src/utils/find-workspace-root.ts
+import { existsSync } from "node:fs";
+import { join } from "node:path";
+var MAX_PATH_SEARCH_DEPTH = 30;
+var depth = 0;
+function findFolderUp(startPath, endFileNames = [], endDirectoryNames = []) {
+  const _startPath = startPath ?? process.cwd();
+  if (endDirectoryNames.some((endDirName) => existsSync(join(_startPath, endDirName)))) {
+    return _startPath;
+  }
+  if (endFileNames.some((endFileName) => existsSync(join(_startPath, endFileName)))) {
+    return _startPath;
+  }
+  if (_startPath !== "/" && depth++ < MAX_PATH_SEARCH_DEPTH) {
+    const parent = join(_startPath, "..");
+    return findFolderUp(parent, endFileNames, endDirectoryNames);
+  }
+  return void 0;
+}
+__name(findFolderUp, "findFolderUp");
+var rootFiles = [
+  "storm-workspace.json",
+  "storm-workspace.json",
+  "storm-workspace.yaml",
+  "storm-workspace.yml",
+  "storm-workspace.js",
+  "storm-workspace.ts",
+  ".storm-workspace.json",
+  ".storm-workspace.yaml",
+  ".storm-workspace.yml",
+  ".storm-workspace.js",
+  ".storm-workspace.ts",
+  "lerna.json",
+  "nx.json",
+  "turbo.json",
+  "npm-workspace.json",
+  "yarn-workspace.json",
+  "pnpm-workspace.json",
+  "npm-workspace.yaml",
+  "yarn-workspace.yaml",
+  "pnpm-workspace.yaml",
+  "npm-workspace.yml",
+  "yarn-workspace.yml",
+  "pnpm-workspace.yml",
+  "npm-lock.json",
+  "yarn-lock.json",
+  "pnpm-lock.json",
+  "npm-lock.yaml",
+  "yarn-lock.yaml",
+  "pnpm-lock.yaml",
+  "npm-lock.yml",
+  "yarn-lock.yml",
+  "pnpm-lock.yml",
+  "bun.lockb"
+];
+var rootDirectories = [
+  ".storm-workspace",
+  ".nx",
+  ".github",
+  ".vscode",
+  ".verdaccio"
+];
+function findWorkspaceRootSafe(pathInsideMonorepo) {
+  if (process.env.STORM_WORKSPACE_ROOT || process.env.NX_WORKSPACE_ROOT_PATH) {
+    return correctPaths(process.env.STORM_WORKSPACE_ROOT ?? process.env.NX_WORKSPACE_ROOT_PATH);
+  }
+  return correctPaths(findFolderUp(pathInsideMonorepo ?? process.cwd(), rootFiles, rootDirectories));
+}
+__name(findWorkspaceRootSafe, "findWorkspaceRootSafe");
+function findWorkspaceRoot(pathInsideMonorepo) {
+  const result = findWorkspaceRootSafe(pathInsideMonorepo);
+  if (!result) {
+    throw new Error(`Cannot find workspace root upwards from known path. Files search list includes: 
+${rootFiles.join("\n")}
+Path: ${pathInsideMonorepo ? pathInsideMonorepo : process.cwd()}`);
+  }
+  return result;
+}
+__name(findWorkspaceRoot, "findWorkspaceRoot");
+
+export {
+  findWorkspaceRootSafe,
+  findWorkspaceRoot
+};

package/dist/{chunk-GXNMSXDL.js → chunk-D3EN5HD2.js}

@@ -1,16 +1,19 @@
+import {
+  joinPaths
+} from "./chunk-G7QVU75O.js";
 import {
   __name
 } from "./chunk-SHUYVCID.js";
 
 // src/utils/tsconfig-path.ts
 import { existsSync } from "node:fs";
-function getTsConfigPath() {
+function getTsConfigPath(basePath = "./") {
   let tsconfigPath = "tsconfig.json";
-  if (existsSync("tsconfig.base.json")) {
+  if (existsSync(joinPaths(basePath, "tsconfig.base.json"))) {
     tsconfigPath = "tsconfig.base.json";
-  } else if (existsSync("tsconfig.app.json")) {
+  } else if (existsSync(joinPaths(basePath, "tsconfig.app.json"))) {
     tsconfigPath = "tsconfig.app.json";
-  } else if (existsSync("tsconfig.lib.json")) {
+  } else if (existsSync(joinPaths(basePath, "tsconfig.lib.json"))) {
     tsconfigPath = "tsconfig.lib.json";
   } else {
     console.warn("No tsconfig.json found. Consider adding a tsconfig.json file to your project's ESLint configuration.");

package/dist/preset.js

@@ -8,13 +8,10 @@ import {
 } from "./chunk-7NZUDX62.js";
 import {
   getTsConfigPath
-} from "./chunk-GXNMSXDL.js";
+} from "./chunk-D3EN5HD2.js";
 import {
   banner_plugin_default
 } from "./chunk-VMGPCABA.js";
-import {
-  joinPaths
-} from "./chunk-G7QVU75O.js";
 import "./chunk-ZUIV57VZ.js";
 import {
   GLOB_ASTRO,
@@ -44,6 +41,12 @@ import {
   GLOB_XML,
   GLOB_YAML
 } from "./chunk-AIKLBIPC.js";
+import {
+  findWorkspaceRoot
+} from "./chunk-7JRBTALJ.js";
+import {
+  joinPaths
+} from "./chunk-G7QVU75O.js";
 import {
   __name
 } from "./chunk-SHUYVCID.js";
@@ -113,10 +116,6 @@ __name(astro, "astro");
 import cspellConfig from "@cspell/eslint-plugin/recommended";
 async function cspell(options = {}) {
   const { configFile = "./.vscode/cspell.json", overrides = {} } = options;
-  let workspaceConfigFile = configFile;
-  if (process.env.STORM_WORKSPACE_ROOT || process.env.NX_WORKSPACE_ROOT_PATH) {
-    workspaceConfigFile = joinPaths(process.env.STORM_WORKSPACE_ROOT || process.env.NX_WORKSPACE_ROOT_PATH || "./", configFile);
-  }
   return [
     {
       name: "storm/cspell/rules",
@@ -126,7 +125,7 @@ async function cspell(options = {}) {
         "@cspell/spellchecker": [
           "warn",
           {
-            configFile: workspaceConfigFile,
+            configFile: joinPaths(findWorkspaceRoot(), configFile),
             generateSuggestions: true,
             numSuggestions: 10,
             autoFix: true
@@ -2704,6 +2703,44 @@ async function perfectionist() {
 }
 __name(perfectionist, "perfectionist");
 
+// src/configs/pnpm.ts
+async function pnpm(options = {}) {
+  const { overrides = {} } = options;
+  const [pluginPnpm, parserJsonc] = await Promise.all([
+    interopDefault(import("eslint-plugin-pnpm")),
+    interopDefault(import("jsonc-eslint-parser"))
+  ]);
+  return [
+    {
+      name: "storm/pnpm/setup",
+      plugins: {
+        pnpm: pluginPnpm
+      },
+      ignores: [
+        "**/node_modules/**",
+        "**/dist/**"
+      ],
+      files: [
+        "package.json",
+        "**/package.json"
+      ],
+      languageOptions: {
+        parser: parserJsonc
+      }
+    },
+    {
+      name: "storm/pnpm/rules",
+      rules: {
+        "pnpm/enforce-catalog": "error",
+        "pnpm/valid-catalog": "error",
+        "pnpm/prefer-workspace-settings": "error",
+        ...overrides
+      }
+    }
+  ];
+}
+__name(pnpm, "pnpm");
+
 // src/configs/prettier.ts
 import config from "eslint-config-prettier";
 async function prettier() {
@@ -3414,10 +3451,6 @@ __name(toml, "toml");
 // src/configs/typescript.ts
 async function typescript(options = {}) {
   const { componentExts = [], overrides = {}, overridesTypeAware = {}, parserOptions = {}, tsdoc = "warn", type = "app" } = options;
-  let tsconfigRootDir = process.cwd();
-  if (process.env.STORM_WORKSPACE_ROOT || process.env.NX_WORKSPACE_ROOT_PATH) {
-    tsconfigRootDir = process.env.STORM_WORKSPACE_ROOT || process.env.NX_WORKSPACE_ROOT_PATH;
-  }
   const files = options.files ?? [
     GLOB_TS,
     GLOB_TSX,
@@ -3431,10 +3464,8 @@ async function typescript(options = {}) {
     `${GLOB_MARKDOWN}/**`,
     GLOB_ASTRO_TS
   ];
-  let tsconfigPath = options?.tsconfigPath;
-  if (!tsconfigPath) {
-    tsconfigPath = getTsConfigPath();
-  }
+  const workspaceRoot = findWorkspaceRoot();
+  const tsconfigPath = getTsConfigPath(options?.tsconfigPath ?? workspaceRoot);
   const isTypeAware = !!tsconfigPath;
   const typeAwareRules = {
     "dot-notation": "off",
@@ -3494,7 +3525,7 @@ async function typescript(options = {}) {
               ],
               defaultProject: tsconfigPath
             },
-            tsconfigRootDir
+            tsconfigRootDir: workspaceRoot
           } : {},
           ...parserOptions
         }
@@ -3982,6 +4013,11 @@ function getStormConfig(options, ...userConfigs) {
       stylistic: stylisticOptions
     }));
   }
+  if (options.pnpm ?? true) {
+    configs2.push(pnpm({
+      overrides: getOverrides(options, "pnpm")
+    }));
+  }
   if (options.jsonc ?? true) {
     configs2.push(jsonc({
       overrides: getOverrides(options, "jsonc"),

package/dist/types.d.ts

@@ -3740,6 +3740,21 @@ Backward pagination arguments
    * @see https://perfectionist.dev/rules/sort-variable-declarations
    */
   'perfectionist/sort-variable-declarations'?: Linter.RuleEntry<PerfectionistSortVariableDeclarations>
+  /**
+   * Enforce using "catalog:" in `package.json`
+   * @see https://github.com/antfu/eslint-plugin-pnpm/blob/main/src/rules/enforce-catalog.test.ts
+   */
+  'pnpm/enforce-catalog'?: Linter.RuleEntry<PnpmEnforceCatalog>
+  /**
+   * Prefer having pnpm settings in `pnpm-workspace.yaml` instead of `package.json`. This would requires pnpm v10.6+, see https://github.com/orgs/pnpm/discussions/9037.
+   * @see https://github.com/antfu/eslint-plugin-pnpm/blob/main/src/rules/prefer-workspace-settings.test.ts
+   */
+  'pnpm/prefer-workspace-settings'?: Linter.RuleEntry<PnpmPreferWorkspaceSettings>
+  /**
+   * Enforce using valid catalog in `package.json`
+   * @see https://github.com/antfu/eslint-plugin-pnpm/blob/main/src/rules/valid-catalog.test.ts
+   */
+  'pnpm/valid-catalog'?: Linter.RuleEntry<PnpmValidCatalog>
   /**
    * Require using arrow functions for callbacks
    * @see https://eslint.org/docs/latest/rules/prefer-arrow-callback
@@ -12692,6 +12707,30 @@ type PerfectionistSortVariableDeclarations = []|[{
   
   partitionByNewLine?: boolean
 }]
+// ----- pnpm/enforce-catalog -----
+type PnpmEnforceCatalog = []|[{
+  
+  allowedProtocols?: string[]
+  
+  autofix?: boolean
+  
+  defaultCatalog?: string
+  
+  reuseExistingCatalog?: boolean
+}]
+// ----- pnpm/prefer-workspace-settings -----
+type PnpmPreferWorkspaceSettings = []|[{
+  autofix?: boolean
+}]
+// ----- pnpm/valid-catalog -----
+type PnpmValidCatalog = []|[{
+  
+  autoInsert?: boolean
+  
+  autoInsertDefaultSpecifier?: string
+  
+  autofix?: boolean
+}]
 // ----- prefer-arrow-callback -----
 type PreferArrowCallback = []|[{
   allowNamedFunctions?: boolean
@@ -16290,7 +16329,7 @@ type Yoda = []|[("always" | "never")]|[("always" | "never"), {
   onlyEquality?: boolean
 }]
 // Names of all the configs
-type ConfigNames = 'storm/cspell/rules' | 'storm/astro/setup' | 'storm/astro/rules' | 'storm/formatter/setup' | 'storm/imports/rules' | 'storm/graphql/setup' | 'storm/graphql/rules' | 'storm/graphql/relay' | 'storm/javascript/setup' | 'storm/javascript/banner' | 'storm/javascript/rules' | 'storm/jsx/rules' | 'storm/jsdoc/rules' | 'storm/jsonc/setup' | 'storm/jsonc/rules' | 'storm/markdown/setup' | 'storm/markdown/processor' | 'storm/markdown/parser' | 'storm/markdown/disables' | 'storm/mdx/setup' | 'storm/node/rules' | 'storm/nx/setup' | 'storm/nx/schema' | 'storm/nx/dependency-check' | 'storm/nx/module-boundaries' | 'storm/next/rules' | 'storm/prettier/rules' | 'storm/perfectionist/rules' | 'storm/react/setup' | 'storm/react/rules' | 'storm/react-native/rules' | 'storm/sort/package-json' | 'storm/stylistic/rules' | 'storm/secrets/rules' | 'storm/storybook/setup' | 'storm/storybook/rules' | 'storm/storybook/main' | 'storm/test/setup' | 'storm/test/rules' | 'storm/toml/setup' | 'storm/toml/rules' | 'storm/regexp/rules' | 'storm/typescript/setup' | 'storm/typescript/parser' | 'storm/typescript/type-aware-parser' | 'storm/typescript/rules' | 'storm/typescript/rules-tsdoc' | 'storm/typescript/rules-type-aware' | 'storm/unicorn/rules' | 'storm/unocss' | 'storm/yaml/setup' | 'storm/yaml/rules'
+type ConfigNames = 'storm/cspell/rules' | 'storm/astro/setup' | 'storm/astro/rules' | 'storm/formatter/setup' | 'storm/imports/rules' | 'storm/graphql/setup' | 'storm/graphql/rules' | 'storm/graphql/relay' | 'storm/javascript/setup' | 'storm/javascript/banner' | 'storm/javascript/rules' | 'storm/jsx/rules' | 'storm/jsdoc/rules' | 'storm/jsonc/setup' | 'storm/jsonc/rules' | 'storm/markdown/setup' | 'storm/markdown/processor' | 'storm/markdown/parser' | 'storm/markdown/disables' | 'storm/mdx/setup' | 'storm/node/rules' | 'storm/nx/setup' | 'storm/nx/schema' | 'storm/nx/dependency-check' | 'storm/nx/module-boundaries' | 'storm/next/rules' | 'storm/prettier/rules' | 'storm/perfectionist/rules' | 'storm/pnpm/setup' | 'storm/pnpm/rules' | 'storm/react/setup' | 'storm/react/rules' | 'storm/react-native/rules' | 'storm/sort/package-json' | 'storm/stylistic/rules' | 'storm/secrets/rules' | 'storm/storybook/setup' | 'storm/storybook/rules' | 'storm/storybook/main' | 'storm/test/setup' | 'storm/test/rules' | 'storm/toml/setup' | 'storm/toml/rules' | 'storm/regexp/rules' | 'storm/typescript/setup' | 'storm/typescript/parser' | 'storm/typescript/type-aware-parser' | 'storm/typescript/rules' | 'storm/typescript/rules-tsdoc' | 'storm/typescript/rules-type-aware' | 'storm/unicorn/rules' | 'storm/unocss' | 'storm/yaml/setup' | 'storm/yaml/rules'
 
 /**
  * Vendor types from Prettier so we don't rely on the dependency.
@@ -16836,6 +16875,14 @@ interface OptionsConfig extends OptionsComponentExts, OptionsJavascript, Options
      * Enable Nx monorepo support.
      */
     nx?: OptionsNx;
+    /**
+     * Enable PNPM related rules.
+     *
+     * @see https://github.com/antfu/pnpm-workspace-utils/tree/main/packages/eslint-plugin-pnpm
+     *
+     * @defaultValue true
+     */
+    pnpm?: boolean | OptionsOverrides;
     /**
      * Enable JSX related rules.
      *

package/dist/utils/find-workspace-root.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Find the monorepo root directory, searching upwards from `path`.
+ *
+ * @param pathInsideMonorepo - The path inside the monorepo to start searching from
+ * @returns The monorepo root directory
+ */
+declare function findWorkspaceRootSafe(pathInsideMonorepo?: string): string | undefined;
+/**
+ * Find the monorepo root directory, searching upwards from `path`.
+ *
+ * @param pathInsideMonorepo - The path inside the monorepo to start searching from
+ * @returns The monorepo root directory
+ */
+declare function findWorkspaceRoot(pathInsideMonorepo?: string): string;
+
+export { findWorkspaceRoot, findWorkspaceRootSafe };

package/dist/utils/find-workspace-root.js

@@ -0,0 +1,10 @@
+import {
+  findWorkspaceRoot,
+  findWorkspaceRootSafe
+} from "../chunk-7JRBTALJ.js";
+import "../chunk-G7QVU75O.js";
+import "../chunk-SHUYVCID.js";
+export {
+  findWorkspaceRoot,
+  findWorkspaceRootSafe
+};

package/dist/utils/index.js

@@ -1,9 +1,6 @@
 import {
   DEFAULT_IGNORES
 } from "../chunk-NXBMVNV2.js";
-import {
-  formatConfig
-} from "../chunk-FTXILLLE.js";
 import {
   ACRONYMS_LIST,
   GLOB_ALL_SRC,
@@ -40,6 +37,9 @@ import {
   GLOB_XML,
   GLOB_YAML
 } from "../chunk-AIKLBIPC.js";
+import {
+  formatConfig
+} from "../chunk-FTXILLLE.js";
 import "../chunk-SHUYVCID.js";
 export {
   ACRONYMS_LIST,

package/dist/utils/tsconfig-path.d.ts

@@ -1,3 +1,3 @@
-declare function getTsConfigPath(): string;
+declare function getTsConfigPath(basePath?: string): string;
 
 export { getTsConfigPath };

package/dist/utils/tsconfig-path.js

@@ -1,6 +1,7 @@
 import {
   getTsConfigPath
-} from "../chunk-GXNMSXDL.js";
+} from "../chunk-D3EN5HD2.js";
+import "../chunk-G7QVU75O.js";
 import "../chunk-SHUYVCID.js";
 export {
   getTsConfigPath

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/eslint",
-  "version": "0.138.1",
+  "version": "0.139.0",
   "type": "module",
   "description": "⚡ A package containing the base ESLint configuration used by Storm Software across many projects.",
   "repository": {
@@ -186,6 +186,7 @@
     "eslint-plugin-no-secrets": "^2.2.1",
     "eslint-plugin-paths": "^1.1.0",
     "eslint-plugin-perfectionist": "^4.9.0",
+    "eslint-plugin-pnpm": "^0.1.2",
     "eslint-plugin-prettier": "^5.2.3",
     "eslint-plugin-regexp": "^2.7.0",
     "eslint-plugin-toml": "^0.12.0",