@storm-software/eslint 0.115.9 → 0.116.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.115.8-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.115.9-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-72MKOVCL.js → chunk-723HQUNP.js}

@@ -1,9 +1,4 @@
-import {
-  init_esm_shims
-} from "./chunk-65NJ2BNV.js";
-
 // src/rules/ts-docs.ts
-init_esm_shims();
 var config = {
   /**
   * Require TSDoc comments conform to the TSDoc specification.

package/dist/{chunk-3UUB46KX.cjs → chunk-ESFBJFNU.cjs}

@@ -1,9 +1,4 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
-
-var _chunkSCFUDB74cjs = require('./chunk-SCFUDB74.cjs');
-
-// src/utils/constants.ts
-_chunkSCFUDB74cjs.init_cjs_shims.call(void 0, );
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/utils/constants.ts
 var RESTRICTED_SYNTAX = [
   {
     // ❌ readFile(…, { encoding: … })

package/dist/{chunk-YXBOINV5.js → chunk-FTXILLLE.js}

@@ -1,10 +1,8 @@
 import {
-  __name,
-  init_esm_shims
-} from "./chunk-65NJ2BNV.js";
+  __name
+} from "./chunk-SHUYVCID.js";
 
 // src/utils/format-config.ts
-init_esm_shims();
 var formatConfig = /* @__PURE__ */ __name((name, config = []) => {
   return config.map((config2, index) => {
     if (!config2 || config2.name) {

package/dist/{chunk-3GC4AORY.cjs → chunk-GMT3V67N.cjs}

@@ -1,11 +1,9 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }
 
-
-var _chunkSCFUDB74cjs = require('./chunk-SCFUDB74.cjs');
+var _chunkUSNT2KNTcjs = require('./chunk-USNT2KNT.cjs');
 
 // src/utils/format-config.ts
-_chunkSCFUDB74cjs.init_cjs_shims.call(void 0, );
-var formatConfig = /* @__PURE__ */ _chunkSCFUDB74cjs.__name.call(void 0, (name, config = []) => {
+var formatConfig = /* @__PURE__ */ _chunkUSNT2KNTcjs.__name.call(void 0, (name, config = []) => {
   return config.map((config2, index) => {
     if (!config2 || config2.name) {
       return _nullishCoalesce(config2, () => ( {}));

package/dist/{chunk-EFMMB4QR.cjs → chunk-HMBBDY5L.cjs}

@@ -1,14 +1,12 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }
 
-var _chunk3UUB46KXcjs = require('./chunk-3UUB46KX.cjs');
+var _chunkESFBJFNUcjs = require('./chunk-ESFBJFNU.cjs');
 
 
-
-var _chunkSCFUDB74cjs = require('./chunk-SCFUDB74.cjs');
+var _chunkUSNT2KNTcjs = require('./chunk-USNT2KNT.cjs');
 
 // src/utils/get-file-banner.ts
-_chunkSCFUDB74cjs.init_cjs_shims.call(void 0, );
-var getFileBanner = /* @__PURE__ */ _chunkSCFUDB74cjs.__name.call(void 0, (name = "") => {
+var getFileBanner = /* @__PURE__ */ _chunkUSNT2KNTcjs.__name.call(void 0, (name = "") => {
   if (!name) {
     name = process.env.STORM_NAMESPACE || "";
   }
@@ -22,7 +20,7 @@ var getFileBanner = /* @__PURE__ */ _chunkSCFUDB74cjs.__name.call(void 0, (name
       titleName = titleName.slice(1);
     }
     titleName = (titleName.charAt(0).toUpperCase() + titleName.slice(1)).split("-").filter((word) => word && word.length > 0).map((word) => {
-      if (_chunk3UUB46KXcjs.ACRONYMS_LIST.includes(word.toUpperCase())) {
+      if (_chunkESFBJFNUcjs.ACRONYMS_LIST.includes(word.toUpperCase())) {
         return word.toUpperCase();
       }
       return word.charAt(0).toUpperCase() + word.slice(1);

package/dist/{chunk-57YNYDOK.cjs → chunk-JS7W7LMD.cjs}

@@ -1,9 +1,4 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
-
-var _chunkSCFUDB74cjs = require('./chunk-SCFUDB74.cjs');
-
-// src/rules/ts-docs.ts
-_chunkSCFUDB74cjs.init_cjs_shims.call(void 0, );
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/rules/ts-docs.ts
 var config = {
   /**
   * Require TSDoc comments conform to the TSDoc specification.

package/dist/{chunk-Q5PXQJ7M.js → chunk-JUT6UB4M.js}

@@ -1,9 +1,4 @@
-import {
-  init_esm_shims
-} from "./chunk-65NJ2BNV.js";
-
 // src/utils/ignores.ts
-init_esm_shims();
 var DEFAULT_IGNORES = [
   "**/.git/**",
   "**/node_modules/**",

package/dist/chunk-LFHG33FO.cjs

@@ -0,0 +1,313 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }
+
+var _chunkHMBBDY5Lcjs = require('./chunk-HMBBDY5L.cjs');
+
+
+var _chunkESFBJFNUcjs = require('./chunk-ESFBJFNU.cjs');
+
+
+var _chunkUSNT2KNTcjs = require('./chunk-USNT2KNT.cjs');
+
+// src/utils/banner-plugin.ts
+var _utils = require('@typescript-eslint/utils');
+var _os = require('os'); var _os2 = _interopRequireDefault(_os);
+function match(actual, expected) {
+  if (expected.test) {
+    return expected.test(actual);
+  } else {
+    return expected === actual;
+  }
+}
+_chunkUSNT2KNTcjs.__name.call(void 0, match, "match");
+function excludeShebangs(comments) {
+  return comments.filter(function(comment) {
+    return comment.type !== "Shebang";
+  });
+}
+_chunkUSNT2KNTcjs.__name.call(void 0, excludeShebangs, "excludeShebangs");
+function getLeadingComments(context, node) {
+  const all = excludeShebangs(context.getSourceCode().getAllComments(node.body.length ? node.body[0] : node));
+  if (all[0].type.toLowerCase() === "block") {
+    return [
+      all[0]
+    ];
+  }
+  let i = 1;
+  for (i = 1; i < all.length; ++i) {
+    const 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);
+}
+_chunkUSNT2KNTcjs.__name.call(void 0, getLeadingComments, "getLeadingComments");
+function genCommentBody(commentType, textArray, eol, numNewlines) {
+  const eols = eol.repeat(numNewlines);
+  if (commentType === "block") {
+    return "/*" + textArray.join(eol) + "*/" + eols;
+  } else {
+    return "//" + textArray.join(eol + "//") + eols;
+  }
+}
+_chunkUSNT2KNTcjs.__name.call(void 0, genCommentBody, "genCommentBody");
+function genCommentsRange(context, comments, eol) {
+  const start = comments[0].range[0];
+  let end = comments.slice(-1)[0].range[1];
+  if (context.getSourceCode().text[end] === eol) {
+    end += eol.length;
+  }
+  return [
+    start,
+    end
+  ];
+}
+_chunkUSNT2KNTcjs.__name.call(void 0, genCommentsRange, "genCommentsRange");
+function genPrependFixer(commentType, node, bannerLines, eol, numNewlines) {
+  return function(fixer) {
+    return fixer.insertTextBefore(node, genCommentBody(commentType, bannerLines, eol, numNewlines));
+  };
+}
+_chunkUSNT2KNTcjs.__name.call(void 0, genPrependFixer, "genPrependFixer");
+function genReplaceFixer(commentType, context, leadingComments, bannerLines, eol, numNewlines) {
+  return function(fixer) {
+    return fixer.replaceTextRange(genCommentsRange(context, leadingComments, eol), genCommentBody(commentType, bannerLines, eol, numNewlines));
+  };
+}
+_chunkUSNT2KNTcjs.__name.call(void 0, genReplaceFixer, "genReplaceFixer");
+function getEOL(options) {
+  if (options.lineEndings === "unix") {
+    return "\n";
+  }
+  if (options.lineEndings === "windows") {
+    return "\r\n";
+  }
+  return _os2.default.EOL;
+}
+_chunkUSNT2KNTcjs.__name.call(void 0, getEOL, "getEOL");
+function hasBanner(commentType, src) {
+  if (src.startsWith("#!")) {
+    const bannerLines = src.split(/\r?\n/);
+    if (bannerLines && bannerLines.length > 1) {
+      bannerLines.shift();
+      while (bannerLines.length && bannerLines[0] && !bannerLines[0].replace(/\s+/, "")) {
+        bannerLines.shift();
+      }
+      if (bannerLines.length) {
+        src = bannerLines.join("\n");
+      } else {
+        return false;
+      }
+    }
+  }
+  return commentType === "block" && src.startsWith("/*") || commentType === "lint" && src.startsWith("//") || commentType !== "block" && commentType !== "lint" && commentType && src.startsWith(commentType);
+}
+_chunkUSNT2KNTcjs.__name.call(void 0, hasBanner, "hasBanner");
+function matchesLineEndings(src, num) {
+  for (let j = 0; j < num; ++j) {
+    const m = src.match(/^(\r\n|\r|\n)/);
+    if (m) {
+      src = src.slice(m.index + m[0].length);
+    } else {
+      return false;
+    }
+  }
+  return true;
+}
+_chunkUSNT2KNTcjs.__name.call(void 0, matchesLineEndings, "matchesLineEndings");
+var bannerRule = _utils.ESLintUtils.RuleCreator(() => `https://docs.stormsoftware.com/eslint/rules/banner`)({
+  name: "banner",
+  meta: {
+    docs: {
+      description: "Ensures the file has a Storm Software banner"
+    },
+    schema: [
+      {
+        type: "object",
+        properties: {
+          banner: {
+            type: "string",
+            description: "The banner to enforce at the top of the file. If not provided, the banner will be read from the file specified in the commentStart option"
+          },
+          repositoryName: {
+            type: "string",
+            description: "The name of the repository to use when reading the banner from a file."
+          },
+          commentType: {
+            type: "string",
+            description: "The comment token to use for the banner. Defaults to block ('/* <banner> */')"
+          },
+          numNewlines: {
+            type: "number",
+            description: "The number of newlines to use after the banner. Defaults to 2"
+          }
+        },
+        additionalProperties: false
+      }
+    ],
+    type: "layout",
+    messages: {
+      missingBanner: "Missing banner",
+      incorrectComment: "Banner should use the {{commentType}} comment type",
+      incorrectBanner: "Incorrect banner",
+      noNewlineAfterBanner: "No newline after banner"
+    },
+    fixable: "whitespace"
+  },
+  defaultOptions: [
+    {
+      repositoryName: "",
+      commentType: "block",
+      numNewlines: 2
+    }
+  ],
+  create(context, [{ banner, repositoryName = "", commentType = "block", numNewlines = 2 }]) {
+    if (!banner) {
+      banner = _chunkHMBBDY5Lcjs.getFileBanner.call(void 0, repositoryName);
+    }
+    const options = context.options;
+    const eol = getEOL(options);
+    const canFix = true;
+    const bannerLines = banner.split(/\r?\n/);
+    let fixLines = bannerLines;
+    return {
+      Program: /* @__PURE__ */ _chunkUSNT2KNTcjs.__name.call(void 0, function(node) {
+        if (!hasBanner(commentType, context.sourceCode.getText())) {
+          context.report({
+            loc: node.loc,
+            messageId: "missingBanner",
+            fix: genPrependFixer(commentType, node, fixLines, eol, numNewlines)
+          });
+        } else {
+          const leadingComments = getLeadingComments(context, node);
+          if (!leadingComments.length) {
+            context.report({
+              loc: node.loc,
+              messageId: "missingBanner",
+              fix: canFix ? genPrependFixer(commentType, node, fixLines, eol, numNewlines) : null
+            });
+          } else if (leadingComments[0].type.toLowerCase() !== commentType) {
+            context.report({
+              loc: node.loc,
+              messageId: "incorrectComment",
+              data: {
+                commentType
+              },
+              fix: canFix ? genReplaceFixer(commentType, context, leadingComments, fixLines, eol, numNewlines) : null
+            });
+          } else {
+            if (commentType === "line") {
+              if (leadingComments.length < bannerLines.length) {
+                context.report({
+                  loc: node.loc,
+                  messageId: "missingBanner",
+                  fix: canFix ? genReplaceFixer(commentType, context, leadingComments, fixLines, eol, numNewlines) : null
+                });
+                return;
+              }
+              for (let i = 0; i < bannerLines.length; i++) {
+                if (!match(leadingComments[i].value, bannerLines[i])) {
+                  context.report({
+                    loc: node.loc,
+                    messageId: "incorrectBanner",
+                    fix: canFix ? genReplaceFixer(commentType, context, leadingComments, fixLines, eol, numNewlines) : null
+                  });
+                  return;
+                }
+              }
+              const postLineBanner = context.getSourceCode().text.substr(leadingComments[bannerLines.length - 1].range[1], (_nullishCoalesce(numNewlines, () => ( 1))) * 2);
+              if (!matchesLineEndings(postLineBanner, numNewlines)) {
+                context.report({
+                  loc: node.loc,
+                  messageId: "noNewlineAfterBanner",
+                  fix: canFix ? genReplaceFixer(commentType, context, leadingComments, fixLines, eol, numNewlines) : null
+                });
+              }
+            } else {
+              let leadingLines = [
+                leadingComments[0].value
+              ];
+              if (bannerLines.length > 1) {
+                leadingLines = leadingComments[0].value.split(/\r?\n/);
+              }
+              let hasError = false;
+              if (leadingLines.length > bannerLines.length) {
+                hasError = true;
+              }
+              for (let i = 0; !hasError && i < bannerLines.length; i++) {
+                if (!match(leadingLines[i], bannerLines[i])) {
+                  hasError = true;
+                }
+              }
+              if (hasError) {
+                if (canFix && bannerLines.length > 1) {
+                  fixLines = [
+                    fixLines.join(eol)
+                  ];
+                }
+                context.report({
+                  loc: node.loc,
+                  messageId: "incorrectBanner",
+                  fix: canFix ? genReplaceFixer(commentType, context, leadingComments, fixLines, eol, numNewlines) : null
+                });
+              } else {
+                const postBlockBanner = context.getSourceCode().text.substr(leadingComments[0].range[1], (_nullishCoalesce(numNewlines, () => ( 1))) * 2);
+                if (!matchesLineEndings(postBlockBanner, numNewlines)) {
+                  context.report({
+                    loc: node.loc,
+                    messageId: "noNewlineAfterBanner",
+                    fix: canFix ? genReplaceFixer(commentType, context, leadingComments, fixLines, eol, numNewlines) : null
+                  });
+                }
+              }
+            }
+          }
+        }
+      }, "Program")
+    };
+  }
+});
+var plugin = {
+  meta: {
+    name: "eslint-plugin-banner",
+    version: "0.0.1"
+  },
+  configs: {},
+  rules: {
+    banner: bannerRule
+  },
+  processors: {}
+};
+plugin.configs && (plugin.configs.recommended = {
+  name: "banner/recommended",
+  plugins: {
+    banner: plugin
+  },
+  files: [
+    _chunkESFBJFNUcjs.CODE_FILE
+  ],
+  ignores: [
+    "!**/docs/**/*",
+    "!**/crates/**/*",
+    "!**/tmp/**/*",
+    "!**/dist/**/*",
+    "!**/coverage/**/*",
+    "!**/node_modules/**/*",
+    "!**/.cache/**/*",
+    "!**/.nx/**/*"
+  ],
+  rules: {
+    "banner/banner": [
+      "error",
+      {
+        commentType: "block",
+        numNewlines: 2
+      }
+    ]
+  }
+});
+var banner_plugin_default = plugin;
+
+
+
+exports.banner_plugin_default = banner_plugin_default;