@storm-software/eslint 0.31.2 → 0.33.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.28.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.32.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

@@ -7,12 +7,12 @@ 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
+   * @see https://github.com/nrwl/nx/blob/19.5.3/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
+   * @see https://github.com/nrwl/nx/blob/19.5.3/docs/generated/packages/eslint-plugin/documents/enforce-module-boundaries.md
    */
   '@nx/enforce-module-boundaries'?: Linter.RuleEntry<NxEnforceModuleBoundaries>
   /**
@@ -780,27 +780,7 @@ interface RuleOptions {
    * @see https://typescript-eslint.io/rules/use-unknown-in-catch-callback-variable
    */
   '@typescript-eslint/use-unknown-in-catch-callback-variable'?: Linter.RuleEntry<[]>
-  'json/*'?: Linter.RuleEntry<Json/*>
-  'json/colon-expected'?: Linter.RuleEntry<JsonColonExpected>
-  'json/comma-expected'?: Linter.RuleEntry<JsonCommaExpected>
-  'json/comma-or-close-backet-expected'?: Linter.RuleEntry<JsonCommaOrCloseBacketExpected>
-  'json/comma-or-close-brace-expected'?: Linter.RuleEntry<JsonCommaOrCloseBraceExpected>
-  'json/comment-not-permitted'?: Linter.RuleEntry<JsonCommentNotPermitted>
-  'json/duplicate-key'?: Linter.RuleEntry<JsonDuplicateKey>
-  'json/enum-value-mismatch'?: Linter.RuleEntry<JsonEnumValueMismatch>
-  'json/invalid-character'?: Linter.RuleEntry<JsonInvalidCharacter>
-  'json/invalid-escape-character'?: Linter.RuleEntry<JsonInvalidEscapeCharacter>
-  'json/invalid-unicode'?: Linter.RuleEntry<JsonInvalidUnicode>
-  'json/json'?: Linter.RuleEntry<JsonJson>
-  'json/property-expected'?: Linter.RuleEntry<JsonPropertyExpected>
-  'json/schema-resolve-error'?: Linter.RuleEntry<JsonSchemaResolveError>
-  'json/trailing-comma'?: Linter.RuleEntry<JsonTrailingComma>
-  'json/undefined'?: Linter.RuleEntry<JsonUndefined>
-  'json/unexpected-end-of-comment'?: Linter.RuleEntry<JsonUnexpectedEndOfComment>
-  'json/unexpected-end-of-number'?: Linter.RuleEntry<JsonUnexpectedEndOfNumber>
-  'json/unexpected-end-of-string'?: Linter.RuleEntry<JsonUnexpectedEndOfString>
-  'json/unknown'?: Linter.RuleEntry<JsonUnknown>
-  'json/value-expected'?: Linter.RuleEntry<JsonValueExpected>
+  'banner/banner'?: Linter.RuleEntry<[]>
   /**
    * Enforce emojis are wrapped in `<span>` and provide screenreader access.
    * @see https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/accessible-emoji.md

package/dist/preset.d.ts

@@ -7,12 +7,12 @@ 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
+   * @see https://github.com/nrwl/nx/blob/19.5.3/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
+   * @see https://github.com/nrwl/nx/blob/19.5.3/docs/generated/packages/eslint-plugin/documents/enforce-module-boundaries.md
    */
   '@nx/enforce-module-boundaries'?: Linter.RuleEntry<NxEnforceModuleBoundaries>
   /**
@@ -780,27 +780,7 @@ interface RuleOptions {
    * @see https://typescript-eslint.io/rules/use-unknown-in-catch-callback-variable
    */
   '@typescript-eslint/use-unknown-in-catch-callback-variable'?: Linter.RuleEntry<[]>
-  'json/*'?: Linter.RuleEntry<Json/*>
-  'json/colon-expected'?: Linter.RuleEntry<JsonColonExpected>
-  'json/comma-expected'?: Linter.RuleEntry<JsonCommaExpected>
-  'json/comma-or-close-backet-expected'?: Linter.RuleEntry<JsonCommaOrCloseBacketExpected>
-  'json/comma-or-close-brace-expected'?: Linter.RuleEntry<JsonCommaOrCloseBraceExpected>
-  'json/comment-not-permitted'?: Linter.RuleEntry<JsonCommentNotPermitted>
-  'json/duplicate-key'?: Linter.RuleEntry<JsonDuplicateKey>
-  'json/enum-value-mismatch'?: Linter.RuleEntry<JsonEnumValueMismatch>
-  'json/invalid-character'?: Linter.RuleEntry<JsonInvalidCharacter>
-  'json/invalid-escape-character'?: Linter.RuleEntry<JsonInvalidEscapeCharacter>
-  'json/invalid-unicode'?: Linter.RuleEntry<JsonInvalidUnicode>
-  'json/json'?: Linter.RuleEntry<JsonJson>
-  'json/property-expected'?: Linter.RuleEntry<JsonPropertyExpected>
-  'json/schema-resolve-error'?: Linter.RuleEntry<JsonSchemaResolveError>
-  'json/trailing-comma'?: Linter.RuleEntry<JsonTrailingComma>
-  'json/undefined'?: Linter.RuleEntry<JsonUndefined>
-  'json/unexpected-end-of-comment'?: Linter.RuleEntry<JsonUnexpectedEndOfComment>
-  'json/unexpected-end-of-number'?: Linter.RuleEntry<JsonUnexpectedEndOfNumber>
-  'json/unexpected-end-of-string'?: Linter.RuleEntry<JsonUnexpectedEndOfString>
-  'json/unknown'?: Linter.RuleEntry<JsonUnknown>
-  'json/value-expected'?: Linter.RuleEntry<JsonValueExpected>
+  'banner/banner'?: Linter.RuleEntry<[]>
   /**
    * Enforce emojis are wrapped in `<span>` and provide screenreader access.
    * @see https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/accessible-emoji.md

package/dist/preset.mjs

@@ -1,7 +1,6 @@
 import tsEslint from 'typescript-eslint';
 import eslintPluginUnicorn from 'eslint-plugin-unicorn';
 import nxPlugin from '@nx/eslint-plugin';
-import json from 'eslint-plugin-json';
 import jsxA11y from 'eslint-plugin-jsx-a11y';
 import markdown from 'eslint-plugin-markdown';
 import prettierConfig from 'eslint-plugin-prettier/recommended';
@@ -11,6 +10,7 @@ import tsdoc from 'eslint-plugin-tsdoc';
 import yml from 'eslint-plugin-yml';
 import globals from 'globals';
 import jsoncParser from 'jsonc-eslint-parser';
+import os from 'node:os';
 
 function getDefaultExportFromCjs (x) {
 	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
@@ -1191,7 +1191,337 @@ const config = {
   "tsdoc/syntax": "warn"
 };
 
-const CODE_BLOCK = "**/*.md{,x}/*";
+const getFileBanner = (name, commentStart = "//") => {
+  let padding = "";
+  while (name.length + padding.length < 12) {
+    padding += " ";
+  }
+  let titleName = process.env.STORM_NAMESPACE ?? "";
+  if (titleName) {
+    if (titleName?.startsWith("@")) {
+      titleName = titleName.slice(1);
+    }
+    titleName = (titleName.charAt(0).toUpperCase() + titleName.slice(1)).split("-").filter((word) => word && word.length > 0).map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join(" ");
+  }
+  return `
+
+${commentStart} -------------------------------------------------------------------
+${commentStart}
+${commentStart}                         ${padding}Storm Software
+${commentStart}                 \u26A1 ${titleName ? name ? `${titleName} - ` : titleName : ""}${name && name.length > 0 ? name.charAt(0).toUpperCase() + name.slice(1) : name}
+${commentStart}
+${commentStart} This code was released as part of the ${titleName ? `${titleName} ` : ""}project. ${titleName ? titleName : "This project"}
+${commentStart} is maintained by Storm Software under the ${(process.env.STORM_LICENSE ?? "Apache-2.0")?.toLowerCase()?.includes("license") ? process.env.STORM_LICENSE ?? "Apache-2.0" : `${process.env.STORM_LICENSE ?? "Apache-2.0"} License`}, and is
+${commentStart} free for commercial and private use. For more information, please visit
+${commentStart} our licensing page.
+${commentStart}
+${commentStart}    Website: ${process.env.STORM_HOMEPAGE ?? "https://stormsoftware.com"}
+${commentStart}    Repository: ${process.env.STORM_REPOSITORY ?? "https://github.com/storm-software/storm-stack"}
+${commentStart}    Documentation: https://stormsoftware.com/docs${titleName?.startsWith("@") ? `/${titleName.slice(1)}` : ""}
+${commentStart}    Contact: ${process.env.STORM_HOMEPAGE ? process.env.STORM_HOMEPAGE.endsWith("/") ? process.env.STORM_HOMEPAGE.slice(-1) : process.env.STORM_HOMEPAGE : "https://stormsoftware.com"}/contact
+${commentStart}    Licensing: ${process.env.STORM_HOMEPAGE ? process.env.STORM_HOMEPAGE.endsWith("/") ? process.env.STORM_HOMEPAGE.slice(-1) : process.env.STORM_HOMEPAGE : "https://stormsoftware.com"}/licensing
+${commentStart}
+${commentStart} -------------------------------------------------------------------
+
+
+`;
+};
+
+function isPattern(object) {
+  return typeof object === "object" && Object.prototype.hasOwnProperty.call(object, "pattern");
+}
+function match(actual, expected) {
+  if (expected.test) {
+    return expected.test(actual);
+  } else {
+    return expected === actual;
+  }
+}
+function excludeShebangs(comments) {
+  return comments.filter(function(comment) {
+    return comment.type !== "Shebang";
+  });
+}
+function getLeadingComments(context, node) {
+  var all = excludeShebangs(
+    context.getSourceCode().getAllComments(node.body.length ? node.body[0] : node)
+  );
+  if (all[0].type.toLowerCase() === "block") {
+    return [all[0]];
+  }
+  for (var i = 1; i < all.length; ++i) {
+    var txt = context.getSourceCode().getText().slice(all[i - 1].range[1], all[i].range[0]);
+    if (!txt.match(/^(\r\n|\r|\n)$/)) {
+      break;
+    }
+  }
+  return all.slice(0, i);
+}
+function genCommentBody(commentType, textArray, eol, numNewlines) {
+  var eols = eol.repeat(numNewlines);
+  if (commentType === "block") {
+    return "/*" + textArray.join(eol) + "*/" + eols;
+  } else {
+    return "//" + textArray.join(eol + "//") + eols;
+  }
+}
+function genCommentsRange(context, comments, eol) {
+  var start = comments[0].range[0];
+  var end = comments.slice(-1)[0].range[1];
+  if (context.getSourceCode().text[end] === eol) {
+    end += eol.length;
+  }
+  return [start, end];
+}
+function genPrependFixer(commentType, node, headerLines, eol, numNewlines) {
+  return function(fixer) {
+    return fixer.insertTextBefore(
+      node,
+      genCommentBody(commentType, headerLines, eol, numNewlines)
+    );
+  };
+}
+function genReplaceFixer(commentType, context, leadingComments, headerLines, eol, numNewlines) {
+  return function(fixer) {
+    return fixer.replaceTextRange(
+      genCommentsRange(context, leadingComments, eol),
+      genCommentBody(commentType, headerLines, eol, numNewlines)
+    );
+  };
+}
+function findSettings(options) {
+  var lastOption = options.length > 0 ? options[options.length - 1] : null;
+  if (typeof lastOption === "object" && !Array.isArray(lastOption) && lastOption !== null && !Object.prototype.hasOwnProperty.call(lastOption, "pattern")) {
+    return lastOption;
+  }
+  return null;
+}
+function getEOL(options) {
+  var settings = findSettings(options);
+  if (settings && settings.lineEndings === "unix") {
+    return "\n";
+  }
+  if (settings && settings.lineEndings === "windows") {
+    return "\r\n";
+  }
+  return os.EOL;
+}
+function hasHeader(src) {
+  if (src.substr(0, 2) === "#!") {
+    var m = src.match(/(\r\n|\r|\n)/);
+    if (m) {
+      src = src.slice(m.index + m[0].length);
+    }
+  }
+  return src.substr(0, 2) === "/*" || src.substr(0, 2) === "//";
+}
+function matchesLineEndings(src, num) {
+  for (var j = 0; j < num; ++j) {
+    var m = src.match(/^(\r\n|\r|\n)/);
+    if (m) {
+      src = src.slice(m.index + m[0].length);
+    } else {
+      return false;
+    }
+  }
+  return true;
+}
+const bannerRule = {
+  meta: {
+    type: "layout",
+    fixable: "whitespace"
+  },
+  create: function(context) {
+    var options = context.options;
+    var numNewlines = options.length > 2 ? options[2] : 1;
+    var eol = getEOL(options);
+    var header = options.length <= 1 ? getFileBanner("") : options[1];
+    var commentType = options[0].toLowerCase();
+    var headerLines, fixLines = [];
+    var canFix = false;
+    if (Array.isArray(header)) {
+      canFix = true;
+      headerLines = header.map(function(line2) {
+        var isRegex = isPattern(line2);
+        if (isRegex && !line2.template) {
+          canFix = false;
+        }
+        fixLines.push(line2.template || line2);
+        return isRegex ? new RegExp(line2.pattern) : line2;
+      });
+    } else if (isPattern(header)) {
+      var line = header;
+      headerLines = [new RegExp(line.pattern)];
+      fixLines.push(line.template || line);
+      canFix = !!line.template;
+    } else {
+      canFix = true;
+      headerLines = header.split(/\r?\n/);
+      fixLines = headerLines;
+    }
+    return {
+      Program: function(node) {
+        if (!hasHeader(context.getSourceCode().getText())) {
+          context.report({
+            loc: node.loc,
+            message: "missing header",
+            fix: genPrependFixer(commentType, node, fixLines, eol, numNewlines)
+          });
+        } else {
+          var leadingComments = getLeadingComments(context, node);
+          if (!leadingComments.length) {
+            context.report({
+              loc: node.loc,
+              message: "missing header",
+              fix: canFix ? genPrependFixer(commentType, node, fixLines, eol, numNewlines) : null
+            });
+          } else if (leadingComments[0].type.toLowerCase() !== commentType) {
+            context.report({
+              loc: node.loc,
+              message: "header should be a {{commentType}} comment",
+              data: {
+                commentType
+              },
+              fix: canFix ? genReplaceFixer(
+                commentType,
+                context,
+                leadingComments,
+                fixLines,
+                eol,
+                numNewlines
+              ) : null
+            });
+          } else {
+            if (commentType === "line") {
+              if (leadingComments.length < headerLines.length) {
+                context.report({
+                  loc: node.loc,
+                  message: "incorrect header",
+                  fix: canFix ? genReplaceFixer(
+                    commentType,
+                    context,
+                    leadingComments,
+                    fixLines,
+                    eol,
+                    numNewlines
+                  ) : null
+                });
+                return;
+              }
+              for (var i = 0; i < headerLines.length; i++) {
+                if (!match(leadingComments[i].value, headerLines[i])) {
+                  context.report({
+                    loc: node.loc,
+                    message: "incorrect header",
+                    fix: canFix ? genReplaceFixer(
+                      commentType,
+                      context,
+                      leadingComments,
+                      fixLines,
+                      eol,
+                      numNewlines
+                    ) : null
+                  });
+                  return;
+                }
+              }
+              var postLineHeader = context.getSourceCode().text.substr(
+                leadingComments[headerLines.length - 1].range[1],
+                numNewlines * 2
+              );
+              if (!matchesLineEndings(postLineHeader, numNewlines)) {
+                context.report({
+                  loc: node.loc,
+                  message: "no newline after header",
+                  fix: canFix ? genReplaceFixer(
+                    commentType,
+                    context,
+                    leadingComments,
+                    fixLines,
+                    eol,
+                    numNewlines
+                  ) : null
+                });
+              }
+            } else {
+              var leadingLines = [leadingComments[0].value];
+              if (headerLines.length > 1) {
+                leadingLines = leadingComments[0].value.split(/\r?\n/);
+              }
+              var hasError = false;
+              if (leadingLines.length > headerLines.length) {
+                hasError = true;
+              }
+              for (i = 0; !hasError && i < headerLines.length; i++) {
+                if (!match(leadingLines[i], headerLines[i])) {
+                  hasError = true;
+                }
+              }
+              if (hasError) {
+                if (canFix && headerLines.length > 1) {
+                  fixLines = [fixLines.join(eol)];
+                }
+                context.report({
+                  loc: node.loc,
+                  message: "incorrect header",
+                  fix: canFix ? genReplaceFixer(
+                    commentType,
+                    context,
+                    leadingComments,
+                    fixLines,
+                    eol,
+                    numNewlines
+                  ) : null
+                });
+              } else {
+                var postBlockHeader = context.getSourceCode().text.substr(leadingComments[0].range[1], numNewlines * 2);
+                if (!matchesLineEndings(postBlockHeader, numNewlines)) {
+                  context.report({
+                    loc: node.loc,
+                    message: "no newline after header",
+                    fix: canFix ? genReplaceFixer(
+                      commentType,
+                      context,
+                      leadingComments,
+                      fixLines,
+                      eol,
+                      numNewlines
+                    ) : null
+                  });
+                }
+              }
+            }
+          }
+        }
+      }
+    };
+  }
+};
+const plugin = {
+  meta: {
+    name: "eslint-plugin-banner",
+    version: "0.0.1"
+  },
+  configs: {},
+  rules: {
+    banner: bannerRule
+  },
+  processors: {}
+};
+plugin.configs.recommended = {
+  plugins: { banner: plugin },
+  files: [
+    "**/*.{,c,m}{j,t}s{,x}",
+    "!tools/**/*",
+    "!docs/**/*",
+    "!crates/**/*",
+    "!.*/**/*"
+  ],
+  rules: {
+    "banner/banner": [2, "block", getFileBanner("")]
+  }
+};
+
 const CODE_FILE = "**/*.{,c,m}{j,t}s{,x}";
 const TS_FILE = "**/*.{,c,m}ts{,x}";
 
@@ -1279,7 +1609,7 @@ function stormPreset(options = {
     // https://www.npmjs.com/package/eslint-plugin-markdown
     options.markdown !== false && { plugins: { markdown } },
     options.markdown !== false && {
-      files: [CODE_BLOCK],
+      files: [CODE_FILE],
       processor: "markdown/markdown"
     },
     options.markdown !== false && {
@@ -1316,6 +1646,8 @@ function stormPreset(options = {
     //   files: [CODE_FILE],
     //   rules: importRules
     // },
+    // Banner
+    plugin.configs["recommended"],
     // TSDoc
     // https://www.npmjs.com/package/eslint-plugin-tsdoc
     { plugins: { tsdoc } },
@@ -1331,7 +1663,7 @@ function stormPreset(options = {
         globals: {
           ...globals.node,
           ...globals.browser,
-          "stormGlobal": true
+          "StormProvider": true
         }
       },
       files: [CODE_FILE],
@@ -1371,7 +1703,7 @@ function stormPreset(options = {
     },
     // Json
     // https://www.npmjs.com/package/eslint-plugin-json
-    json.configs["recommended"],
+    // json.configs["recommended-with-comments"],
     {
       files: ["*.json", "*.jsonc"],
       languageOptions: {

package/package.json

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