@storm-software/eslint 0.19.0 → 0.20.1

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.18.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.20.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)
 
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->

package/dist/preset.d.mts

@@ -5,6 +5,20 @@ import { Linter } from 'eslint';
 
 
 interface RuleOptions {
+  /**
+   * Checks dependencies in project's package.json for version mismatches
+   * @see https://github.com/nrwl/nx/blob/19.5.1/docs/generated/packages/eslint-plugin/documents/dependency-checks.md
+   */
+  '@nx/dependency-checks'?: Linter.RuleEntry<NxDependencyChecks>
+  /**
+   * Ensure that module boundaries are respected within the monorepo
+   * @see https://github.com/nrwl/nx/blob/19.5.1/docs/generated/packages/eslint-plugin/documents/enforce-module-boundaries.md
+   */
+  '@nx/enforce-module-boundaries'?: Linter.RuleEntry<NxEnforceModuleBoundaries>
+  /**
+   * Checks common nx-plugin configuration files for validity
+   */
+  '@nx/nx-plugin-checks'?: Linter.RuleEntry<NxNxPluginChecks>
   /**
    * Require that function overload signatures be consecutive
    * @see https://typescript-eslint.io/rules/adjacent-overload-signatures
@@ -1449,6 +1463,54 @@ interface RuleOptions {
 }
 
 /* ======= Declarations ======= */
+// ----- @nx/dependency-checks -----
+type NxDependencyChecks = []|[{
+  buildTargets?: string[]
+  ignoredDependencies?: string[]
+  ignoredFiles?: string[]
+  checkMissingDependencies?: boolean
+  checkObsoleteDependencies?: boolean
+  checkVersionMismatches?: boolean
+  includeTransitiveDependencies?: boolean
+  useLocalPathsForWorkspaceDependencies?: boolean
+}]
+// ----- @nx/enforce-module-boundaries -----
+type NxEnforceModuleBoundaries = []|[{
+  enforceBuildableLibDependency?: boolean
+  allowCircularSelfDependency?: boolean
+  checkDynamicDependenciesExceptions?: string[]
+  banTransitiveDependencies?: boolean
+  checkNestedExternalImports?: boolean
+  allow?: string[]
+  buildTargets?: string[]
+  depConstraints?: ({
+    sourceTag?: string
+    onlyDependOnLibsWithTags?: string[]
+    allowedExternalImports?: string[]
+    bannedExternalImports?: string[]
+    notDependOnLibsWithTags?: string[]
+  } | {
+    
+    allSourceTags?: [string, string, ...(string)[]]
+    onlyDependOnLibsWithTags?: string[]
+    allowedExternalImports?: string[]
+    bannedExternalImports?: string[]
+    notDependOnLibsWithTags?: string[]
+  })[]
+}]
+// ----- @nx/nx-plugin-checks -----
+type NxNxPluginChecks = []|[{
+  
+  generatorsJson?: string
+  
+  executorsJson?: string
+  
+  migrationsJson?: string
+  
+  packageJson?: string
+  
+  allowedVersionStrings?: string[]
+}]
 // ----- @typescript-eslint/array-type -----
 type TypescriptEslintArrayType = []|[{
   

package/dist/preset.d.ts

@@ -5,6 +5,20 @@ import { Linter } from 'eslint';
 
 
 interface RuleOptions {
+  /**
+   * Checks dependencies in project's package.json for version mismatches
+   * @see https://github.com/nrwl/nx/blob/19.5.1/docs/generated/packages/eslint-plugin/documents/dependency-checks.md
+   */
+  '@nx/dependency-checks'?: Linter.RuleEntry<NxDependencyChecks>
+  /**
+   * Ensure that module boundaries are respected within the monorepo
+   * @see https://github.com/nrwl/nx/blob/19.5.1/docs/generated/packages/eslint-plugin/documents/enforce-module-boundaries.md
+   */
+  '@nx/enforce-module-boundaries'?: Linter.RuleEntry<NxEnforceModuleBoundaries>
+  /**
+   * Checks common nx-plugin configuration files for validity
+   */
+  '@nx/nx-plugin-checks'?: Linter.RuleEntry<NxNxPluginChecks>
   /**
    * Require that function overload signatures be consecutive
    * @see https://typescript-eslint.io/rules/adjacent-overload-signatures
@@ -1449,6 +1463,54 @@ interface RuleOptions {
 }
 
 /* ======= Declarations ======= */
+// ----- @nx/dependency-checks -----
+type NxDependencyChecks = []|[{
+  buildTargets?: string[]
+  ignoredDependencies?: string[]
+  ignoredFiles?: string[]
+  checkMissingDependencies?: boolean
+  checkObsoleteDependencies?: boolean
+  checkVersionMismatches?: boolean
+  includeTransitiveDependencies?: boolean
+  useLocalPathsForWorkspaceDependencies?: boolean
+}]
+// ----- @nx/enforce-module-boundaries -----
+type NxEnforceModuleBoundaries = []|[{
+  enforceBuildableLibDependency?: boolean
+  allowCircularSelfDependency?: boolean
+  checkDynamicDependenciesExceptions?: string[]
+  banTransitiveDependencies?: boolean
+  checkNestedExternalImports?: boolean
+  allow?: string[]
+  buildTargets?: string[]
+  depConstraints?: ({
+    sourceTag?: string
+    onlyDependOnLibsWithTags?: string[]
+    allowedExternalImports?: string[]
+    bannedExternalImports?: string[]
+    notDependOnLibsWithTags?: string[]
+  } | {
+    
+    allSourceTags?: [string, string, ...(string)[]]
+    onlyDependOnLibsWithTags?: string[]
+    allowedExternalImports?: string[]
+    bannedExternalImports?: string[]
+    notDependOnLibsWithTags?: string[]
+  })[]
+}]
+// ----- @nx/nx-plugin-checks -----
+type NxNxPluginChecks = []|[{
+  
+  generatorsJson?: string
+  
+  executorsJson?: string
+  
+  migrationsJson?: string
+  
+  packageJson?: string
+  
+  allowedVersionStrings?: string[]
+}]
 // ----- @typescript-eslint/array-type -----
 type TypescriptEslintArrayType = []|[{
   

package/dist/preset.mjs

@@ -1,7 +1,9 @@
-import tseslint from 'typescript-eslint';
+import tsEslint from 'typescript-eslint';
 import eslintPluginUnicorn from 'eslint-plugin-unicorn';
 import markdown from 'eslint-plugin-markdown';
 import globals from 'globals';
+import nxPlugin from '@nx/eslint-plugin';
+import jsoncParser from 'jsonc-eslint-parser';
 
 function getDefaultExportFromCjs (x) {
 	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
@@ -340,7 +342,18 @@ const formatConfig = (name, config = []) => {
   });
 };
 
-function stormPreset(options = {}, ...userConfigs) {
+function stormPreset(options = {
+  moduleBoundaries: {
+    enforceBuildableLibDependency: true,
+    allow: [],
+    depConstraints: [
+      {
+        sourceTag: "*",
+        onlyDependOnLibsWithTags: ["*"]
+      }
+    ]
+  }
+}, ...userConfigs) {
   const rules = {
     "unicorn/number-literal-case": 0,
     "unicorn/template-indent": 0,
@@ -368,7 +381,7 @@ function stormPreset(options = {}, ...userConfigs) {
     // https://eslint.org/docs/latest/rules/
     eslint.configs.recommended,
     // https://typescript-eslint.io/
-    ...tseslint.configs.recommended,
+    ...tsEslint.configs.recommended,
     // https://github.com/sindresorhus/eslint-plugin-unicorn
     eslintPluginUnicorn.configs["flat/recommended"],
     // Preset overrides
@@ -407,6 +420,44 @@ function stormPreset(options = {}, ...userConfigs) {
         ...options.markdown?.rules
       }
     },
+    // Nx plugin
+    { plugins: { "@nx": nxPlugin } },
+    {
+      languageOptions: {
+        parser: tsEslint.parser,
+        globals: {
+          ...globals.node
+        }
+      },
+      rules: {
+        "@typescript-eslint/explicit-module-boundary-types": ["error"]
+      }
+    },
+    {
+      files: ["*.json", "*.jsonc"],
+      languageOptions: {
+        parser: jsoncParser
+      },
+      rules: {}
+    },
+    {
+      files: ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      rules: {
+        "@nx/enforce-module-boundaries": [
+          "error",
+          options.moduleBoundaries ? options.moduleBoundaries : {
+            enforceBuildableLibDependency: true,
+            allow: [],
+            depConstraints: [
+              {
+                sourceTag: "*",
+                onlyDependOnLibsWithTags: ["*"]
+              }
+            ]
+          }
+        ]
+      }
+    },
     // User overrides
     ...userConfigs
   ].filter(Boolean);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/eslint",
-  "version": "0.19.0",
+  "version": "0.20.1",
   "type": "module",
   "description": "⚡ A package containing the base ESLint configuration used by Storm Software across many projects.",
   "repository": {